# @talixo/switcher

> UI component for Yes/No switcher

Latest version **0.1.0** (published 2018-05-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @talixo/switcher
pnpm add @talixo/switcher
yarn add @talixo/switcher
bun add @talixo/switcher
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-05-02 |
| First published | 2018-05-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Public in Motion GmbH |
| Maintainers | michalochman, rangoo |

## Links

- npm: https://www.npmjs.com/package/@talixo/switcher
- Repository: https://github.com/PublicInMotionGmbH/ui-kit
- Homepage: https://github.com/PublicInMotionGmbH/ui-kit#readme
- Issues: https://github.com/PublicInMotionGmbH/ui-kit/issues
- npm.io page: https://npm.io/package/@talixo/switcher

## Recent versions

- 0.1.0 (latest) — 2018-05-02
- 1.0.0-alpha.39 (alpha) — 2023-05-18
- 1.0.0-alpha.38 — 2019-01-21
- 1.0.0-alpha.37 — 2019-01-21
- 1.0.0-alpha.36 — 2019-01-21
- 1.0.0-alpha.35 — 2018-12-09
- 1.0.0-alpha.31 — 2018-10-19
- 1.0.0-alpha.30 — 2018-10-02
- 1.0.0-alpha.27 — 2018-08-20
- 1.0.0-alpha.24 — 2018-08-13
- 1.0.0-alpha.20 — 2018-07-26
- 1.0.0-alpha.19 — 2018-07-26
- 1.0.0-alpha.16 — 2018-07-24
- 1.0.0-alpha.12 — 2018-07-13
- 1.0.0-alpha.7 — 2018-07-10
- … 4 more at https://npm.io/package/@talixo/switcher/versions

## README

# Talixo Switcher

It's just simple wrapper for checkbox, which behaves more like switcher with Yes/No options.

## How to install

Package is available as `@talixo/switcher` in NPM registry, so you can use it in your project
using `npm install @talixo/switcher --save` or `yarn add @talixo/switcher`.

## Requirements

Your package should additionally have some extra dependencies:

- `prop-types: ^15.6.1`
- `react: ^16.2.0`
- `react-dom: ^16.2.0`
- `@talixo/shared: ^0.1.0`

These packages are required by `@talixo/switcher`, but you have to install them manually,
to avoid having different versions of these in your application.

## Supported props

It allows any props which are allowed for `input[type=checkbox]`. Additionally, it handles some differently:

Property name | Type      | Default | Description                    
--------------|-----------|:-------:|--------------------------------
className     | string    | n/a     | additional class name passed to wrapper
noLabel       | string    | `"No"`  | label for unchecked switcher
yesLabel      | string    | `"Yes"` | label for checked switcher

## Changelog

- **0.1.0** - initial version

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