UNPKG

@blueprintjs/core

Version:
47 lines (32 loc) 1.71 kB
@# Checkboxes Blueprint's custom checkboxes use an extra `.pt-control-indicator` element after the `<input>` to achieve their custom styling. You should then wrap the whole thing in a `<label>` with the classes `.pt-control.pt-checkbox`. Note that attribute modifiers (`:checked`, `:disabled`) are applied on the internal `<input>` element. Further note that `:indeterminate` can only be set via JavaScript (the `Checkbox` React component supports it handily with a prop). @## CSS API @css pt-checkbox @## JavaScript API The `Checkbox` component is available in the __@blueprintjs/core__ package. Make sure to review the [general usage docs for JS components](#blueprint.usage). ```tsx // simple usage for string labels <Checkbox checked={this.state.isEnabled} label="Enabled" onChange={this.handleEnabledChange} /> // advanced usage for JSX content <Checkbox checked={this.state.isEnabled} onChange={this.handleEnabledChange}> <span className="pt-icon-standard pt-icon-user" /> Gilad Gray </Checkbox> ``` Note that this component supports the full range of props available on HTML `input` elements. Use `checked` instead of `value` in controlled mode to avoid typings issues. The most common options are detailed below. @interface ICheckboxProps @## Inline controls Checkboxes, radios, and switches all support the `.pt-inline` modifier to make them `display: inline-block`. Note that this modifier functions slightly differently on these elements than it does on `.pt-label`. On `.pt-label`, it only adjusts the layout of text _within_ the label and not the display of the label itself. Here's an example of how you might group together some controls and label them. @css pt-checkbox.pt-inline