Checkbox

The Checkbox is part of the chayns-components package. It can be installed via npm:

npm install -S chayns-components@latest

Usage of the Checkbox

The checkbox has to be imported:

import { Checkbox } from 'chayns-components';

You can use the checkbox like this:

<Checkbox onChange={ (value) => { console.log(value); }} />

The following properties can be set on the Checkbox-Component

Property	Description	Type	Default Value
style	Additional styles that should be set to the checkbox	Object
className	Additional CSS-Classes that should be add to the checkbox	String
label	Label that will be shown next to the checkbox	String
dangerouslySetLabel	Label that will be shown next to the checkbox (not ToggleButton)	String (HTML)
children	Label that will be shown next to the checkbox	String
onChange	onChange-event. Returns true or false	function
toggleButton	Renders checkbox as toggleButton (see chayns-css wiki)	bool	false
defaultChecked	Set the default value of the checkbox	bool	false
checked	Set the value of the checkbox	bool	false
disabled	Disables the checkbox	bool	false
tooltip	Tooltip that will be shown behind the label	String

<Checkbox
    label="This is a toggle button"
    toggleButton={true}
    onChange={ (value) => { console.log(value); }}
/>

<Checkbox
    onChange={ (value) => { console.log(value); }}
    disabled={true}
>
    This is a normal checkbox
</Checkbox>