1.0.0 • Published 5 years ago

react-component-range v1.0.0

Weekly downloads
2
License
ISC
Repository
github
Last release
5 years ago

react-component-range

npm version Build Status

React Component Range is a simple and minimal React input range component

Install

npm install react-component-range

Usage

import React, { Component } from "react";
import ReactRange from "react-component-range";

class App extends Component {
  onChange = value => {
    console.debug("Value: ", value);
  };

  render() {
    return (
      <ReactRange
        min={0}
        max={100}
        defaultValue={50}
        ariaLabel="Slider to adjust the volume"
        onChange={this.onChange}
      />
    );
  }
}

export default App;

Props

NameTypeDefaultDescription
idstringThe id of the input (range)
namestringThe input's name, to identify the input in the data submitted with the form's data
minnumber0The minimum permitted value
maxnumber100The maximum permitted value
stepnumber1The stepping interval, used both for user interface and validation purposes
onChangefunction() => {}The callback action to be performed when the value changes. It returns the current value.
valuenumberThe input's current value
defaultValuenumber0The input's initial value
ariaLabelstringThe accesibility aria-label property of the input
ariaLabelledbystringThe accesibility aria-labelledby property of the input
disabledbooleanfalseA Boolean attribute which is present if the input should be disabled
requiredbolleanfalseA Boolean which, if true, indicates that the input must have a value before the form can be submitted
tabIndexnumberA numeric value providing guidance to the user agent as to the order in which controls receive focus when the user presses the Tab key

Contributing

Feel free to submit issues and enhancement requests.

Please refer to each project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Future actions

  • Typescript component
  • Write tests for the component
  • Personalization (color and size)