DocSpace-client/packages/components/checkbox
2023-08-14 15:24:49 +02:00
..
checkbox.stories.js Web: Components: Fixed stories 2023-04-25 15:30:01 +03:00
checkbox.test.js
index.js Web: Components: Checkbox, CodeInput - added description 2023-04-17 18:26:38 +05:00
README.md
styled-checkbox.js Web: Login: Add RTL to Login 2023-08-14 15:24:49 +02: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