# @slup/slider

> Slider element built upon Inferno with the Slup framework

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

## Install

```sh
npm install @slup/slider
pnpm add @slup/slider
yarn add @slup/slider
bun add @slup/slider
```

## 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.5.1 |
| Published | 2018-02-05 |
| First published | 2017-08-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Luca |
| Maintainers | gejsi, lucat1 |

## Links

- npm: https://www.npmjs.com/package/@slup/slider
- Repository: https://github.com/slupjs/slup/tree/master/packages/Slider
- npm.io page: https://npm.io/package/@slup/slider

## Dependencies (2)

- [@slup/common](https://npm.io/package/@slup/common.md) ^0.5.1
- [@slup/theming](https://npm.io/package/@slup/theming.md) ^0.5.1

## Recent versions

- 0.5.1 (latest) — 2018-02-05
- 0.5.0 — 2018-01-02
- 0.0.2 — 2017-08-13

## README

<demo gif>

<h1 align='center'>Slup - Slider</h1>

This package contains the Slider, a Material Design Component which is part of a bigger ecosystem called [Slup](https://github.com/gejsi/material)

## Description
From Google's [Material Design guidelines](https://material.io/guidelines):
<blockquote>
  Sliders are ideal components for adjusting settings that reflect intensity levels, such as volume, brightness, or color saturation.
</blockquote>

## Installation
This package can be installed with [NPM](http://npmjs.com/)
```
npm install --save @slup/slider
```

## Usage
```js
import { Slider } from '@slup/slider'

export class Test extends Component {
  state = { value: 0 }

  handleChange(value) {
    this.setState({ value })
  }

  render() {
    return (
      <Slider
        onChange={this.handleChange.bind(this)}
        value={this.state.value}
        max={100}
      />
    )
  }
}
```

## Available properties
| Props       |    Type       |    Default       | Documentation          |
|-------------|:-------------:|:-------------:|------:                    |
| onChange    |  function     |  none       | [Link](#usage)              |
| value       |  number       |  0          | [Link](#usage)              |
| max         |  number       |  0          | [Link](#usage)              |
| disabled    |  boolean      |  false      | [Link](#property-disabled)  |
| discrete    |  boolean      |  false      | [Link](#property-discrete)  |

#### Property: 'disabled'
This property will disable the slider
```js
<Slider
  onChange={this.handleChange.bind(this)}
  value={this.state.value}
  max={this.state.total}
  disabled
/>
```

#### Property: 'discrete'
This property will make a discrete slider which shows the value inside a thumb
```js
<Slider
  onChange={this.handleChange.bind(this)}
  value={this.state.value}
  max={this.state.total}
  discrete
/>
```

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