Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@chakra-xui/checkbox

chakra-xui160MIT1.1.0TypeScript support: included

A React Checkbox component for use in forms

react, checkbox, custom-checkbox, checkbox-hook, react hook, input, chakra-xui, use-checkbox, checkboxGroup, checkbox-group-hook, use-checbox-group

readme

@chakra-xui/checkbox

Checkbox component is used in forms when a user needs to select multiple values from several options.

Installation

yarn add @chakra-xui/checkbox

# or

npm i @chakra-xui/checkbox

Import component

import { Checkbox } from "@chakra-xui/checkbox"

Usage

<Checkbox>This is a checkbox</Checkbox>

CheckboxGroup

CheckboxGroup is used to bind multiple checkboxes into a group, and it indicates whether one or more options are selected.

<CheckboxGroup defaultValue={["one", "two"]}>
  <Checkbox value="one">One</Checkbox>
  <Checkbox value="two">Two</Checkbox>
  <Checkbox value="three">Three</Checkbox>
</CheckboxGroup>

changelog

Change Log

1.1.0

Minor Changes

  • 1e6db1e0 #2876 Thanks @with-heart! - Deprecated the defaultIsChecked prop on Radio and Checkbox in favor of defaultChecked, which mirrors the default React prop name for this functionality. defaultIsChecked will continue to work, but may be removed in future versions.

1.0.2

Patch Changes

1.0.1

Patch Changes

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0 (2020-11-13)

Note: Version bump only for package @chakra-xui/checkbox

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-rc.8 (2020-10-29)

Bug Fixes

  • toast: allow custom render in update (eb8bff9), closes #2362

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-rc.7 (2020-10-25)

Note: Version bump only for package @chakra-xui/checkbox

1.0.0-rc.6 (2020-10-25)

Note: Version bump only for package @chakra-xui/checkbox

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-rc.5 (2020-09-27)

Note: Version bump only for package @chakra-xui/checkbox

1.0.0-rc.4 (2020-09-25)

Note: Version bump only for package @chakra-xui/checkbox

1.0.0-rc.3 (2020-08-30)

Note: Version bump only for package @chakra-xui/checkbox

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-rc.2 (2020-08-09)

Note: Version bump only for package @chakra-xui/checkbox

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-rc.1 (2020-08-06)

Bug Fixes

  • variables: drop unused imports (552b2e9)

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-rc.0 (2020-07-26)

Note: Version bump only for package @chakra-xui/checkbox

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-next.7 (2020-07-26)

Note: Version bump only for package @chakra-xui/checkbox

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-next.6 (2020-07-15)

Note: Version bump only for package @chakra-xui/checkbox

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-next.5 (2020-07-15)

Note: Version bump only for package @chakra-xui/checkbox

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-next.4 (2020-07-01)

Bug Fixes

Features

  • update stories for radio component (3effca4)

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-next.3 (2020-06-28)

Bug Fixes

Features

  • update stories for radio component (3effca4)

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-next.2 (2020-06-21)

Bug Fixes

Features

  • update stories for radio component (3effca4)