Skip to main content

Checkbox Input

A checkbox input component. Can be used as part of an ISLE dashboard or standalone. In the latter case, you want to handle changes via the onChange attribute or bind the value to a global variable via the bind attribute.

Options#

  • bind | string: name of global variable for the checkbox value to be assigned to. Default: ''.
  • defaultValue | boolean: boolean value indicating the default value of the checkbox. Default: false.
  • value | boolean: checkbox value (for controlled component). Default: none.
  • disabled | boolean: indicates whether the input is active or not. Default: false.
  • inline | boolean: indicates whether the checkbox is displayed inline. Default: false.
  • onChange | function: callback function to be invoked when checkbox is clicked. The function is called with the current checkbox value. Default: onChange() {}.
  • legend | (string|node): text displayed next to the checkbox. Default: ''.
  • tooltip | string: text displayed when hovering over checkbox. Default: ''.
  • tooltipPlacement | string: position of button tooltip. Default: 'right'.
  • style | object: CSS inline styles. Default: {}.

Examples#

Live Editor
Result
ReferenceError: Provider is not defined