Input Boolean

io.input.boolean() asks a yes or no question and returns true or false. Provided by the @awaitio/input-boolean package.

The label Send a confirmation email above a checked checkbox with the help text to its right

Install

npm install @awaitio/input-boolean

Setup

app.ts

import { inputBoolean } from '@awaitio/input-boolean';

export const app = new AwaitIO({
  // name, actionsDirectory, theme, secret, users…
  components: { input: { boolean: inputBoolean } },
});

Usage

const sendEmail = await io.input.boolean('Send a confirmation email', {
  defaultValue: true,
  helpText: 'The customer gets a copy of the change',
});

Props

Prop	Type	Required	Description
`helpText`	`string`	Required	Shown to the right of the checkbox: what checking it means.
`defaultValue`	`boolean`	Optional	Whether the box starts checked. Defaults to `false`.
`disabled`	`boolean`	Optional	Shows the starting value without letting it change; the handler gets that value whatever the browser sends.

Returns

boolean: true when the box is checked, false when it is not.

Built-in validation

Nothing is checked: an unchecked box gives false.

Custom validation

Chain .validate() for a check of your own. It runs on the server after the checks above, gets the value the handler would get and returns a message to show under the field, or nothing when the value is fine; see Custom validation.

await io.input.boolean('I have read the refund policy').validate((isChecked) => {
  return isChecked ? undefined : 'Read the refund policy first.';
});

Getting started

SDK

Components

Display components

Layout components

Context

Install

Setup

Usage

Props

Returns

Built-in validation

Custom validation

​Install

​Setup

​Usage

​Props

​Returns

​Built-in validation

​Custom validation

Install

Setup

Usage

Props

Returns

Built-in validation

Custom validation