2.0.8 • Published 7 months ago

@brighthr/component-checkbox

Licence

MIT

Version

2.0.8

Deps

Size

32 kB

Vulns

Weekly

To install, type the following into the command line at the root of your project:

npm i @brighthr/component-checkbox

To implement the Checkbox component into your project you’ll need to add the import:

import Checkbox from '@brighthr/component-checkbox';

After adding import into your project you can use it simply like:

<Checkbox />

Name	Type	Default	Description
checkboxButton	`boolean`	`false`	If `true`, gives the checkbox a button appearance.
checkboxButtonSize	`'sm'` `'base'`	`'base'`	Sets the size of the button appearance if `checkboxButton` is `true`.
checkboxPosition	`'left'` `'right'`	`'left'`	Sets the position of the checkbox.
checked	`boolean`	`false`	If `true`, the checkbox will show as selected.
circularCheckbox	`boolean`	`false`	If `true`, the checkbox will be circular.
description	`string`		Sets a description to show.
disabled	`boolean`	`false`	If `true`, disables the checkbox with a gray overlay.
iconName	`string`		Sets the icon to display, no icon is displayed if left empty.
label	`string`		Sets the label.