react-mm-jsr
TypeScript icon, indicating that this package has built-in type declarations

2.0.4 • Public • Published

react-mm-jsr

Official adapter for mm-jsr. Visit link for more information about library.


mm-jsr provides You with excellent solution for creating so-called range-inputs.

Range input is form's field where one can choose a value from min-max range. Although HTML 5 comes with input[type="range"] its functionality lacks a lot of features. mm-jsr gives You anything You may need.

Installation

  1. Install packages
npm install --save mm-jsr react-mm-jsr

or

yarn add mm-jsr react-mm-jsr

(it is also available in unpkg with variable name ReactJSR. Remember to include mm-jsr (JSR) as well)

  1. Add CSS (you can use basic styles from here)

  2. Instantiate (see docs for more information about configuration and modules)

import JSR from 'mm-jsr';
import { useJSR } from 'react-mm-jsr';

function MyComponent () {
  const { ref: jsrRef, instance: jsrInstance } = useJSR({
    modules: [
      new JSR.Rail(),
      new JSR.Slider(),
      new JSR.Bar(),
      new JSR.Label(),
    ],
    config: {
      min: 0,
      max: 100,
      step: 1,
      initialValues: [25, 75],
    },
  });

  return (<div ref={jsrRef} />);
}

Important notes

instance returned from useJSR is not available immediately, because JSR mounts itself after component. Underhood it uses useState for storing instance.

Therefore each usage must check for instance existence, and usage in hooks have to use instance as dependency.

Handling onValueChange

To handle onValueChange you may use this code

useEffect(() => {
  if (jsrInstance) {
    return jsrInstance.onValueChange(console.log);
  }
}, [jsrInstance]);

As onValueChange returns function, that will unsubscribe the handler, it can be used naturally with React's useEffect.

Styling

Because you mount JSR by using ref, you have full control over JSR parent element.

So by applying class to that element, and then wrapping default styles with applied class, you can have styled and scoped JSR.

The same works for styled-components:

const JsrContainer = styled.div`
    display: block;
    position: relative;
    padding-top: 10px;
    width: 100%;
    ...

    .jsr_rail {
      height: 5px;
      background: #444;
    }

    ...
`;

NOTE: .jsr class is the container element itself.

NOTE: .jsr_lockscreen is applied to body, so it should be global. See docs on locking screen on touchevent for more info.

Readme

Keywords

none

Package Sidebar

Install

npm i react-mm-jsr

Weekly Downloads

1

Version

2.0.4

License

LGPLv3

Unpacked Size

6.13 kB

Total Files

6

Last publish

Collaborators

  • soanvig