@lendi-ui/checkbox
TypeScript icon, indicating that this package has built-in type declarations

5.0.0 • Public • Published

@lendi-ui/checkbox

This module contains two components: Checkbox and CheckboxGroup. When using CheckboxGroup, users should use CheckboxGroup.Checkbox as children.

Installation

yarn add @lendi-ui/checkbox

Usage

import { Checkbox, CheckboxGroup } from '@lendi-ui/checkbox';
## Properties

<PropTable>
  <PropTable.Entry name="className" defaultValue=""type="string" description="External classname to override style of the component"/>
  <PropTable.Entry name="isBoxed" type="boolean" defaultValue={false} description="Whether Checkbox is wrapped by box"/>
  <PropTable.Entry name="isChecked" type="boolean" defaultValue={false} description="Whether Checkbox is selected"/>
  <PropTable.Entry name="isDisabled" type="boolean" defaultValue={false} description="Whether Checkbox is unclickable"/>
  <PropTable.Entry name="label" type="string" description="Checkbox display label"/>
  <PropTable.Entry name="onChange" type="(event: React.ChangeEvent<HTMLInputElement>) => void" description="Checkbox onChange function"/>
  <PropTable.Entry name="value" type="string" description="Checkbox value"/>
</PropTable>

Readme

Keywords

none

Package Sidebar

Install

npm i @lendi-ui/checkbox

Weekly Downloads

138

Version

5.0.0

License

ISC

Unpacked Size

44.6 kB

Total Files

12

Last publish

Collaborators

  • joshua-derbe-lendi
  • michaelhuttonlendi
  • simon_lau_lendi
  • benjamintan
  • oliverfrance
  • kjartan.johansen
  • dapovey
  • nooshines
  • fernandogontijo_
  • sean-elliott-lendi
  • nghiato
  • sunny.niu
  • mfarshadmehr
  • jannes.mingram.lendi
  • antoine_lendi
  • bchiong
  • lendi-owner
  • andrealin
  • malkyfaith
  • brianduan
  • yihan_lu_lendi
  • nodemacross
  • samnevers
  • boris.gordon
  • leo.wei
  • bharadwajsampath
  • luissilvalendi
  • thomaslendi
  • dimitrioslendi
  • le-kang-lendi
  • yupeili