Checkbox

v.5.0.1

Installation

yarn

yarn add @mercell/checkbox-react

pnpm

pnpm add @mercell/checkbox-react

npm

npm install --save @mercell/checkbox-react

The Checkbox has necessary peerDependencies, please make sure that you have them in your project

"@mercell/tailwind": "^6.0.1",
"classnames": "^2.3.1",
"react": "^17.0.2" 

Usage

Using the Checkbox component is as simple as importing it like this.

import { Checkbox } from '@mercell/checkbox-react';

Live Editor

// You can play with code, with HTML tags and text as much as you want! render ( <> <div> <Checkbox id="option1"> Option 1 - Normal </Checkbox> </div> <div> <Checkbox id="option2" checked> Option 2 - Checked </Checkbox> </div> <div> <Checkbox id="option3" disabled> Option 3 - Disabled </Checkbox> </div> <div> <Checkbox id="option4" disabled checked> Option 4 - Disabled & Checked </Checkbox> </div> </> )

// You can play with code, with HTML tags and text as much as you want!
    render (
        <>
            <div>
                <Checkbox id="option1">
                    Option 1 - Normal
                </Checkbox>
            </div>
            <div>
                <Checkbox id="option2" checked>
                    Option 2 - Checked
                </Checkbox>
            </div>
            <div>
                <Checkbox id="option3" disabled>
                    Option 3 - Disabled
                </Checkbox>
            </div>
            <div>
                <Checkbox id="option4" disabled checked>
                    Option 4 - Disabled & Checked
                </Checkbox>
            </div>
        </>
    )

Result

Types, definitions, etc.

Types

CheckboxProps

interface Props {
    labelProps?: JSX.IntrinsicElements['label'];
    children: ReactNode;
    invalid?: boolean;
} & MutableRefObject<HTMLInput> & JSX.IntrinsicElements['input']

Name	Type	Default	Required	Description
labelProps	JSX.IntrinsicElements['label']	-	no	Custom props for the label
children	ReactNode	-	yes	The label content
invalid	boolean	false	no	If the label is invalid or not

Changelog

Change Log - @mercell/checkbox-react

This log was last generated on Thu, 17 Nov 2022 13:18:13 GMT and should not be manually modified.

5.0.1

Thu, 17 Nov 2022 13:18:13 GMT

Patches

• Change children to not be obligatory

5.0.0

Fri, 11 Nov 2022 09:18:57 GMT

Breaking changes

• New styling approach - use only tailwind classes, add tailwind-merge library, instead of label after and before pseudo classes we use normal input wrapping of label and styling from now on

4.0.0

Thu, 15 Sep 2022 06:07:41 GMT

Breaking changes

• Migration to Tailwind3, React 18 and ViteJS from webpack.

3.0.10

Thu, 14 Jul 2022 13:28:46 GMT

Patches

• Updated hover state to remove sticky hover on mobile

3.0.9

Thu, 30 Jun 2022 10:57:49 GMT

Patches

• Package.json refactor, add test suite, more tests soon

3.0.8

Tue, 14 Jun 2022 07:19:42 GMT

Patches

• white background for the unchecked status

3.0.7

Fri, 08 Apr 2022 10:19:50 GMT

Patches

• Bump dependencies

3.0.6

Fri, 01 Apr 2022 12:18:25 GMT

Patches

• Fix from UX feedback

3.0.5

Wed, 09 Mar 2022 10:29:16 GMT

Patches

• Adjust hover state color and position, fix focus ring

3.0.4

Mon, 28 Feb 2022 12:45:49 GMT

Patches

• Dependency update

3.0.3

Mon, 28 Feb 2022 10:55:32 GMT

Patches

• Bump typescript

3.0.2

Wed, 26 Jan 2022 16:19:19 GMT

Patches

• Adding the same peerDependencies to devDependencies

3.0.1

Tue, 18 Jan 2022 14:33:13 GMT

Patches

• Breakpoints adjustment

3.0.0

Wed, 15 Dec 2021 22:20:34 GMT

Breaking changes

• Update to match figma design

2.0.5

Fri, 12 Nov 2021 13:08:30 GMT

Patches

• Add @mercell/tailwind to devDeps to be always up to date

2.0.4

Fri, 05 Nov 2021 11:10:13 GMT

Patches

• Bump peerDependency

2.0.3

Thu, 04 Nov 2021 10:10:16 GMT

Patches

• Tailwind type fix
• Revert tailwind version

2.0.2

Wed, 03 Nov 2021 15:28:42 GMT

Patches

• react types >=17

2.0.1

Wed, 27 Oct 2021 12:53:13 GMT

Patches

• Gitignore fix

2.0.0

Mon, 18 Oct 2021 07:16:21 GMT

Breaking changes

• New local build process with webpack without storybook, add npmignore and update dependencies

1.0.7

Thu, 02 Sep 2021 08:03:42 GMT

Patches

• Adjust component to strict mode in typescript

1.0.6

Mon, 12 Jul 2021 10:50:09 GMT

Patches

• Updating dependencies
• Updating dependencies

1.0.5

Wed, 24 Mar 2021 10:17:01 GMT

Patches

• Enabling eslint

1.0.4

Tue, 23 Mar 2021 13:40:42 GMT

Patches

• Adding esm module export

1.0.3

Wed, 17 Mar 2021 10:01:28 GMT

Patches

• Adding readme

1.0.2

Fri, 19 Feb 2021 09:41:17 GMT

Patches

• bump

1.0.1

Tue, 16 Feb 2021 14:23:47 GMT

Patches

• Removing stylesheet

1.0.0

Fri, 05 Feb 2021 13:40:11 GMT

Breaking changes

• Added component

Figma

Sometimes it can take some time until Figma will render component inside embed iframe. Try to click plus icon to 'reset' initial loader. (Works only in Chrome)

Click me to open figma in the new card