@element-public/react-checkbox

Checkbox

Description

A checkbox allows a single value (true/false) choice for the user.

See live demos on storybook

Storybook Checkbox Demos

Install bundle from npm-e

npm i @element-public/react-components @element-public/themes

Optional: install the component individually

npm i @element-public/react-checkbox @element-public/themes

Please Note: You will need to add @element-public to your .npmrc!

Open ~/.npmrc in an editor and add the following line to enable the @element-public scope:

@element-public:registry=https://npm.platforms.engineering

Troubleshooting

See below if you have never installed a package from Bayer's npm-enterprise or run into the following error:

npm ERR! code E401
npm ERR! Unable to authenticate, your authentication token seems to be invalid.
npm ERR! To correct this please trying logging in again with:
npm ERR!     npm login

Setup an access token

See the devtools npm-e guide to learn how to create an access token if this is the first time you are using a npm-e package at Bayer or you do not have a line that starts with the following in your ~/.npmrc file:

//npm.platforms.engineering/:_authToken=

Notes

Checkboxes are one of several selection controls. A Checkbox takes binary user input, giving the user only two options. Notable props for Checkboxes include alignEnd, which changes the alignment of the label and the Checkbox, indeterminate, which fills the Checkbox with a value that is neither true nor false, and hideLabel, which causes the label not be displayed, although it will still be available to screen readers, as well as other props that alter the initial state (checked, disabled, etc.) of the Checkbox.

Usage

Since many selection inputs exist, Checkbox should be used only when a true/false or yes/no answer is requested of a user. Radio and Switch offer other alternatives for taking user input when more options are available. Examples and demos of this functionality are included under the corresponding Storybook tabs.

Checkbox Props

Name	Type	Default	Required	Description
alignEnd	boolean	false	false	Aligns checkbox to the right of the label.
checked	boolean	null	false	The current state of the checkbox.
className	string	undefined	false	The css class name to be passed through to the component markup.
disabled	boolean	false	false	Prevent the user from interacting with the component.
hideLabel	boolean	false	false	The label not be displayed, but will still be available to screen readers. This should only be used when the context of the checkbox is clear and understandable. An example use-case could be as a column in a table where the column header specifies the action.
id	string	undefined	false	Randomly generated id. May be overwritten.
indeterminate	boolean	false	false	The checkbox will show an indicator if no value (true or false) is set.
label	string	null	false	Display label. The label should always be set even when using hideLabel - it will be used by screen readers.
themeColor	string	'primary'	false	Override the default (primary) color with the secondary color. Most commonly used when the control is placed on a darker surface. Accepted Values: primary, secondary, danger, success
value	string|number|boolean|object	null	false	Any additional value information to be included with the event.

Checkbox Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	undefined	false	Alternative to label, if both label and children are set, label will take priority. Expects a string, but will accept any valid markup.

Checkbox Events

Name	Default	Required	Params	Description
onChange	null	false		Fired when checkbox value is changed