Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

bpk-component-checkbox

Backpack checkbox component.

Installation

Check the main Readme for a complete installation guide.

Usage

import BpkCheckbox from '@skyscanner/backpack-web/bpk-component-checkbox';

export default () => (
  <BpkCheckbox
    name="prefer-directs"
    onChange={() => console.log('prefer directs changed!')}
    label="Prefer directs"
    checked
  />
);

Props

Check out the full list of props on Skyscanner's design system documentation website.


BpkCheckboxV2 (experimental)

A composable checkbox built on Ark UI. Usage is split across slot components: Root, Control, Indicator, Label, and HiddenInput.

RTL support: BpkCheckboxV2 is built on Ark UI and requires BpkProvider from @skyscanner/backpack-web/bpk-component-layout for correct RTL layout. Wrap your application (or the relevant subtree) with <BpkProvider>.