History

Tatiana Lopaeva 8ba2f0c694 Merge branch 'develop' into feature/backup # Conflicts: # packages/asc-web-common/api/settings/index.js # web/ASC.Web.Api/Models/SettingsWrapper.cs		2021-10-25 11:02:42 +03:00
..
svg	Web: Icons: Fixed old checkbox icons, change header plus icon	2021-10-14 13:09:54 +03:00
checkbox.stories.js	Web: Components: refactoring stories, add public/images to components for storybook	2021-03-07 14:57:26 +03:00
checkbox.test.js	Web: Components: changed component hierarchy	2021-02-24 17:42:09 +03:00
index.js	Merge branch 'develop' into feature/backup	2021-09-20 16:26:34 +03:00
README.md	Web: Components/Common: fix imports	2021-02-26 00:19:45 +03:00
styled-checkbox.js	Web: Components: fixed checkbox icons style	2021-04-27 14:31:05 +03:00

README.md

Checkbox

Custom checkbox input

Usage

import Checkbox from "@appserver/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