# input-switch

> Simple CSS for display checkbox and radio inputs as switch buttons.

Latest version **1.1.0** (published 2019-03-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install input-switch
pnpm add input-switch
yarn add input-switch
bun add input-switch
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-03-10 |
| First published | 2018-08-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 17.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Oliver Findl |
| Maintainers | oliverfindl |
| Keywords | css, scss, checkbox, radio, input, switch, input-switch |

## Links

- npm: https://www.npmjs.com/package/input-switch
- Repository: https://github.com/oliverfindl/input-switch
- Homepage: https://github.com/oliverfindl/input-switch#readme
- Issues: https://github.com/oliverfindl/input-switch/issues
- npm.io page: https://npm.io/package/input-switch

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2019-03-10
- 1.0.2 — 2018-08-30
- 1.0.1 — 2018-08-30
- 1.0.0 — 2018-08-30

## README

# input-switch

[![npm](https://img.shields.io/npm/v/input-switch.svg?style=flat)](https://www.npmjs.com/package/input-switch)
[![npm](https://img.shields.io/npm/dt/input-switch.svg?style=flat)](https://www.npmjs.com/package/input-switch)
[![npm](https://img.shields.io/npm/l/input-switch.svg?style=flat)](https://www.npmjs.com/package/input-switch)
[![paypal](https://img.shields.io/badge/donate-paypal-blue.svg?colorB=0070ba&style=flat)](https://paypal.me/oliverfindl)

Simple CSS for display checkbox and radio inputs as switch buttons.

> Inspired by [W3Schools](https://www.w3schools.com/) [example](https://www.w3schools.com/howto/howto_css_switch.asp).

---

## Example

![example](assets/all-without-text.png)

## Install

Via [npm](https://npmjs.com/) [[package](https://www.npmjs.com/package/input-switch)]:
```bash
$ npm install input-switch
```

Via [yarn](https://yarnpkg.com/en/) [[package](https://yarnpkg.com/en/package/input-switch)]:
```bash
$ yarn add input-switch
```

From [unpkg](https://unpkg.com/):
```html
<link rel="stylesheet" href="//unpkg.com/input-switch" />
```

From [jsDelivr](https://jsdelivr.com/) [[package](https://www.jsdelivr.com/package/npm/input-switch)]:
```html
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/input-switch" />
```

### Notice

If you installed via package manager, don't forget to import CSS into your project.

## Usage

```html
<label class="has-switch">
	<input type="checkbox" />
	<span class="switch is-round"></span>
	Example text
</label>
```

![example](assets/one-with-text.png)

## Modifiers

- `.has-switch`**`.has-half-space-after`** - space after switch is half sized

- `.has-switch`**`.has-no-space-after`** - space after switch is omitted

- `.switch`**`.is-square`** - switch is square shaped

- `.switch`**`.is-round`** - switch is round shaped

- `.switch`**`.is-outline`** - switch is outlined, can be combined with `.is-square` or `.is-round`


## Customization

It's possible to customize some variables, for example colors:
```scss
@charset "utf-8";

$switch-primary-color: #5ac65a;
$switch-secondary-color: #ff7157;

@import "../node_modules/input-switch/src/input-switch.scss";
```

Default values for all customizable variables:
```scss
/* sizes */
$switch-height: 1em; // default height of switch
$switch-width: $switch-height * 1.75; // default width of switch
$switch-space-after-width: $switch-height * .5; // default space after switch

/* colors */
$switch-primary-color: #2196f3; // default primary color of switch
$switch-secondary-color: grey; // default secondary color of switch
$switch-pointer-color: white; // default pointer color of switch
$switch-transparent-color: transparent; // default transparent color of switch

/* transitions */
$switch-transition-duration: .5s; // default transition duration of switch
$switch-transition-timing-function: ease; // default transition timing function of switch
```

---

## License

[MIT](http://opensource.org/licenses/MIT)

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