# @freshworks/toggle

> Toggle component in Nucleus

Latest version **0.16.1** (published 2023-09-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @freshworks/toggle
pnpm add @freshworks/toggle
yarn add @freshworks/toggle
bun add @freshworks/toggle
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: insecure dependencies; abandoned.

## Facts

| | |
|---|---|
| Version | 0.16.1 |
| Published | 2023-09-20 |
| First published | 2020-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 8.* \|\| >= 10.* |
| Dependencies | 9 |
| Unpacked size | 2.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Maintainers | vinodhmanick, mdibrahim, arvindan.aswathanarayanan, freshworks-dev, muthufd, prasannanfd, sankar-ganesh, hrishikesh, parsuram-npm, rajasegar-c, asifahmed, ravirajsubramanian, adithya_nat, freshanand, harishkumr |
| Keywords | ember-addon |

## Links

- npm: https://www.npmjs.com/package/@freshworks/toggle
- Repository: https://github.com/freshdesk/nucleus
- Homepage: https://freshdesk.github.io/nucleus
- Issues: https://github.com/freshdesk/nucleus/issues
- npm.io page: https://npm.io/package/@freshworks/toggle

## Dependencies (9)

- [ember-svg-jar](https://npm.io/package/ember-svg-jar.md) ^2.1.0
- [ember-cli-sass](https://npm.io/package/ember-cli-sass.md) ^10.0.0
- [ember-cli-babel](https://npm.io/package/ember-cli-babel.md) ^7.11.1
- [@freshworks/core](https://npm.io/package/@freshworks/core.md) ^0.15.1
- [@freshworks/icon](https://npm.io/package/@freshworks/icon.md) ^0.21.1
- [ember-decorators](https://npm.io/package/ember-decorators.md) ^6.1.1
- [ember-cli-htmlbars](https://npm.io/package/ember-cli-htmlbars.md) ^4.0.0
- [ember-css-transitions](https://npm.io/package/ember-css-transitions.md) ^0.1.16
- [ember-decorators-polyfill](https://npm.io/package/ember-decorators-polyfill.md) github:freshdesk/ember-decorators-polyfill#v.1.0.0

## Recent versions

- 0.16.1 (latest) — 2023-09-20
- 0.15.0 — 2021-03-05
- 0.13.0 — 2020-11-19
- 0.12.0 — 2020-10-09
- 0.11.0 — 2020-08-21
- 0.8.1 — 2020-08-07
- 0.7.0 — 2020-07-14
- 0.6.0 — 2020-07-07
- 0.5.0 — 2020-06-16
- 0.4.0 — 2020-05-06
- 0.3.0 — 2020-05-05
- 0.2.1 — 2020-04-13
- 0.2.0 — 2020-03-30

## README

@freshworks/toggle
==============================================================================
[![npm version](https://badge.fury.io/js/%40freshworks%2Ftoggle.svg)](https://www.npmjs.com/package/@freshworks/toggle)
![npm](https://img.shields.io/npm/dm/@freshworks/toggle)

```
yarn add @freshworks/toggle
```

Toggles in Freshdesk
------------------------------------------------------------------------------
Interactive component that allows to toggle between two choices, checked and unchecked. They are mostly used to represent active/inactive state.

Accessibility
------------------------------------------------------------------------------
When the toggle has focus, pressing the Space key changes the state of the toggle.

Variants
------------------------------------------------------------------------------
Disabled - Prevent hover states from activating

Guidelines
------------------------------------------------------------------------------
**DO’s**

1. Use toggles with labels unless the title is straightforward so the user knows exactly what action he is doing.
2. In case of multiple toggles, align them well so that it is easier to find them on the page.

**DONT’s**

1. Do not redirect the user to a different page on change of the toggle state. 
2. Avoid using multiple toggles on the same page, as much as possible.
3. Toggle actions work immediately. Do not enable them only after a clicking confirm button.

---
_Source: https://npm.io/package/@freshworks/toggle · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._