Code Monkey home page Code Monkey logo

accessible-ui / slider Goto Github PK

View Code? Open in Web Editor NEW
4.0 2.0 0.0 1.82 MB

๐Ÿ…ฐ An accessible and versatile slider component for React that uses a native <input type=range> for focus management

Home Page: https://codesandbox.io/s/accessibleslider-example-vi94o

License: MIT License

JavaScript 7.91% TypeScript 92.09%
a11y accessible accessibility a11y-slider accessible-slider react-accessibility accessible-react slider slider-component focus-management

slider's Introduction


<Slider>

Bundlephobia Types Code coverage Build status NPM Version MIT License

npm i @accessible/slider

An accessible and versatile slider component for React. These components are touchable and keyboard navigable.

This library contains components for single-thumb sliders out of the box, though you could feasibly fashion a dual-thumb slider from what's here.

Quick Start

Check out the example on CodeSandbox

import {Slider, Track, Thumb} from '@accessible/slider'

const Component = () => (
  <Slider orientation="vertical">
    <div className="slider">
      <Track>
        <div className="track">
          <Thumb>
            <div className="thumb" />
          </Thumb>
        </div>
      </Track>
    </div>
  </Slider>
)

API

<Slider>

Creates the context for your slider and configures it. This also creates the underlying <input type='range'> component. Any props not listed below are provided to the <input>.

Props

Prop Type Default Required? Description
min number 0 Yes The minimum value of the slider
max number 100 Yes The maximum value of the slider
step number 1 Yes The amount the slider increases or decreases each time it is ticked
value number undefined No Makes this component controlled. This is always the value of the slider. incr, decr, set and keyboard steps have no effect.
defaultValue number 50 No Sets the default value of the slider
orientation "horizontal" | "vertical" "horizontal" Yes Sets the orientation of the slider. When horizontal the minimum value is on the left, max on the right. When vertical, the minimum value is on the bottom and the max is on the top.
disabled boolean false No Disables the slider incr, decr, set, and keyboard controls. You can still update the slider's value using the value prop.
onChange (value?: number) => any undefined No Called each time the value changes.

<Track>

This component attaches event handlers to its child that make it act like a native <input type="range"> track. It is your responsibility to style it.

Props

Prop Type Default Required? Description
children React.ReactElement undefined Yes Provides events to its child component that control the state of the slider's value depending on the current drag/click position.

<Thumb>

This component adds styles to its child that update the child's position within a track based upon the progress of the slider i.e. (value - min) / (max - min).

Props

Prop Type Default Required? Description
children React.ReactElement undefined Yes The child component you want to add progress styles to.

useSlider()

A hook that provides the slider's SliderContext

SliderContextValue

interface SliderContextValue {
  incr: (by?: number) => void
  decr: (by?: number) => void
  set: (value: number) => void
  value: number
  min: number
  max: number
  step: number
  focused: boolean
  disabled: boolean
  orientation: 'horizontal' | 'vertical'
  inputRef: React.MutableRefObject<HTMLInputElement | null>
}

useValue()

A hook that returns the slider's current value

useProgress()

A hook that returns the value of (value - min) / (max - min)

useOrientation()

A hook that returns the slider's current orientation

useFocused()

A hook that returns true if the slider is focused

useDisabled()

A hook that returns true if the slider is disabled

useControls()

A hook that provide's the slider's incr, decr, and set functions

LICENSE

MIT

slider's People

Contributors

jaredlunde avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.