Toggle Package

Toggle switch gives control over a feature or option that can be turned on or off.

Toggle Usage

import { ChangeEvent, useState } from 'react';
import { Toggle } from '@dt-dds/react';

export const App = () => {
  const [checked, setChecked] = React.useState(true);

  const handleClick = () => {
    setIsChecked((prev) => !prev);
  };

  return <Toggle isChecked={checked} onClick={handleClick} />;
};

Properties

| Property | Type | Default | Description | | ------------ | ------------------------------------------------- | ------- | ----------------------------------------------------------------------------- | | label | string | - | A label to help users understand the scope of the toggle. | | onClick | (evt: React.MouseEvent<HTMLDivElement>) => void | - | The triggered function when the input whole toggle is clicked. | | dataTestId | string | toggle | Toggle test identifier | | isDisabled | boolean | false | Specifies if the element should be disabled. | | isChecked | boolean | false | Specifies if the element should be pre-selected (checked) when the page loads |

Stack

• TypeScript for static type checking
• React — JavaScript library for user interfaces
• Emotion — for writing css styles with JavaScript
• Storybook — UI component environment powered by Vite
• Jest - JavaScript Testing Framework
• React Testing Library - to test UI components in a user-centric way
• ESLint for code linting
• Prettier for code formatting
• Tsup — TypeScript bundler powered by esbuild
• Yarn from managing packages

Commands

• yarn build - Build the package
• yarn dev - Run the package locally
• yarn lint - Lint all files within this package
• yarn test - Run all unit tests
• yarn test:report - Open the test coverage report
• yarn test:update:snapshot - Run all unit tests and update the snapshot

Compilation

Running yarn build from the root of the package will use tsup to compile the raw TypeScript and React code to plain JavaScript.

The /dist folder contains the compiled output.

toggle
└── dist
    ├── index.d.ts  <-- Types
    ├── index.js    <-- CommonJS version
    └── index.mjs   <-- ES Modules version
    ...

Versioning

Follows semantic versioning

© License

Licensed under MIT License