DocSpace-client/packages/components/checkbox
2022-10-19 14:49:26 +03:00
..
svg Web: Moved all clients app to packages directory 2022-07-22 22:01:25 +03:00
checkbox.stories.js Web: Moved all clients app to packages directory 2022-07-22 22:01:25 +03:00
checkbox.test.js Web: Moved all clients app to packages directory 2022-07-22 22:01:25 +03:00
index.js Web:Client:Add tabIndex in Checkbox. 2022-10-19 14:49:26 +03:00
README.md Web: Moved all clients app to packages directory 2022-07-22 22:01:25 +03:00
styled-checkbox.js Web:Client:Add styles focus in checkbox. 2022-10-19 14:45:20 +03:00

Checkbox

Custom checkbox input

Usage

import Checkbox from "@docspace/components/checkbox";
<Checkbox
  id="id"
  name="name"
  value="value"
  label="label"
  isChecked={false}
  isIndeterminate={false}
  isDisabled={false}
  onChange={() => {}}
/>

Properties

Props Type Required Values Default Description
className string - - - Accepts class
id string - - - Used as HTML id property
isChecked bool - - false The checked property sets the checked state of a checkbox
isDisabled bool - - - Disables the Checkbox input
isIndeterminate bool - - - If true, this state is shown as a rectangle in the checkbox
label string - - - Label of the input
name string - - - Used as HTML name property
onChange func - - Will be triggered whenever an CheckboxInput is clicked
style obj, array - - - Accepts css style
value string - - - Value of the input
title bool - - - Title
truncate bool - - false Disables word wrapping
color string - - #FFFF Makes the checkbox a different color