Checkbox | Components | Neighborhood Design System

Styled Version

Loading

Code

import { NbhdCheckbox } from '@fbin-web/neighborhood-core';

<nbhd-checkbox> checkbox </nbhd-checkbox>

import { NbhdCheckbox } from '@fbin-web/neighborhood-react';

const App = () => (
  <>
    <NbhdCheckbox>checkbox</NbhdCheckbox>
  </>
);

Property	Attribute	Type	Default	Description
`value`	`value`	`string`		The value of the checkbox.
`title`	`title`	`string`		The title of the checkbox.
`name`	`name`	`string`		The name of the checkbox.
`form`	`form`	`string`		The form the checkbox is associated with.
`id`	`id`	`string`		The id of the checkbox.
`cssClass`	`css-class`	`string`		Additional CSS classes to apply to the checkbox.
`ariaLabel`	`aria-label`	`string`		Descriptive text for additional context.
`disabled`	`disabled`	`boolean`	`false`	Disables the checkbox from being selected.
`checked`	`checked`	`boolean`	`false`	Whether the checkbox is checked initially.
`required`	`required`	`boolean`	`false`	Whether the checkbox is required.
`labelData`	`labelData`	`object`		Data for making the label for the checkbox.

This component contains the following components as dependencies.