Skip to main content

Pivotal UI

v19.2.2
Components / Checkbox dropdowns

Checkbox dropdowns

Basic checkbox dropdown
ReferenceError: React is not defined
Checkbox dropdown with onChange
ReferenceError: React is not defined
Checkbox dropdown with customizeTitle
ReferenceError: React is not defined

Props

PropertyRequiredTypeDefaultDescription
buttonAriaLabelnoStringaria-label for the button
buttonClassNamenoStringClassname to add to the button
flatnoBooleanIf true, dropdown toggle has no borders and is transparent
labelAriaLabelnoStringaria-label for the label
labelsyesoneOf([Array, Object])Labels for the checkboxes
onChangenoFunctionCallback that fires after clicking a checkbox
sizenooneOf(['normal', 'large', 'small'])'normal'Sets the size
splitnoBooleanIf true, separates the button text from the toggle
customizeTitlenoFunctionCallback that allows dropdown title customization if ALL are not selected

Imports

Import React components (including CSS):

import {CheckboxDropdown} from 'pivotal-ui/react/checkbox-dropdown';

Import CSS only:

import 'pivotal-ui/css/checkbox-dropdown';