Toggle

v.5.0.0

Installation

yarn

yarn add @mercell/toggle-react

pnpm

pnpm add @mercell/toggle-react

npm

npm install --save @mercell/toggle-react

The Toggle 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 Toggle component is as simple as importing it like this.

import { Toggle } from '@mercell/toggle-react';

Live Editor

// You can play with code, with HTML tags and text as much as you want! const ToggleExample = () => { const [checked, setChecked] = React.useState<boolean>(false); return ( <div className="space-y-4"> <div> <h3>Normal toggle</h3> <Toggle onLabel="On" offLabel="Off" checked={checked} onClick={() => setChecked((prev) => !prev)} /> </div> <div> <h3>Always toggled</h3> <Toggle onLabel="On" offLabel="Off" checked/> </div> </div> ) } render( <ToggleExample /> )

// You can play with code, with HTML tags and text as much as you want!
    const ToggleExample = () => {
    const [checked, setChecked] = React.useState<boolean>(false);
    return (
        <div className="space-y-4">
            <div>
                <h3>Normal toggle</h3>
                <Toggle
                    onLabel="On"
                    offLabel="Off"
                    checked={checked}
                    onClick={() => setChecked((prev) => !prev)}
                />
            </div>
            <div>
                <h3>Always toggled</h3>
                <Toggle onLabel="On" offLabel="Off" checked/>
            </div>
        </div>
    )
}
render(
    <ToggleExample />
)

Result

Types, definitions, etc.

Types

ToggleProps

interface ToggleProps {
    onLabel: string;
    offLabel: string;
    textSide?: 'left' | 'right';
} & JSX.IntrinsicElements['input']

Name	Type	Default	Required	Description
onLabel	string	-	yes	Label for the on-position of the toggle
offLabel	string	-	yes	Label for the off-position of the toggle
textSide	'left' /	'right'	'right	no	Position of label near toggle

Changelog

Change Log - @mercell/toggle-react

This log was last generated on Fri, 11 Nov 2022 09:18:57 GMT and should not be manually modified.

5.0.0

Fri, 11 Nov 2022 09:18:57 GMT

Breaking changes

• New styling approach - use only tailwind classes, add tailwind-merge library

4.0.0

Thu, 15 Sep 2022 06:07:41 GMT

Breaking changes

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

3.0.6

Thu, 30 Jun 2022 10:57:49 GMT

Patches

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

3.0.5

Fri, 03 Jun 2022 13:08:46 GMT

Patches

• Update design to match figma

3.0.4

Fri, 08 Apr 2022 10:19:50 GMT

Patches

• Bump dependencies

3.0.3

Mon, 28 Feb 2022 12:45:49 GMT

Patches

• Dependency update

3.0.2

Mon, 28 Feb 2022 10:55:32 GMT

Patches

• Bump typescript

3.0.1

Wed, 26 Jan 2022 16:19:19 GMT

Patches

• Adding the same peerDependencies to devDependencies

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.8

Mon, 12 Jul 2021 10:50:09 GMT

Patches

• Updating dependencies
• Updating dependencies

1.0.7

Wed, 24 Mar 2021 10:17:01 GMT

Patches

• Enabling eslint

1.0.6

Tue, 23 Mar 2021 13:40:42 GMT

Patches

• Adding esm module export

1.0.5

Mon, 22 Mar 2021 10:05:40 GMT

Patches

• Update toggle-react label colors

1.0.4

Wed, 17 Mar 2021 10:01:28 GMT

Patches

• Adding readme

1.0.3

Fri, 19 Feb 2021 09:41:17 GMT

Patches

• bump

1.0.2

Mon, 15 Feb 2021 14:31:25 GMT

Patches

• Removing styling

1.0.1

Fri, 05 Feb 2021 09:50:54 GMT

Patches

• target es5

1.0.0

Thu, 04 Feb 2021 08:46:45 GMT

Breaking changes

• Adding 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