InputStepper

To implement InputStepper component into your project you'll need to add the import:

import InputStepper from "@kiwicom/orbit-components/lib/InputStepper";

After adding import into your project you can use it simply like:

<InputStepper />

Props

Table below contains all types of the props available in InputStepper component.

Name Type Default Description
defaultValue number 0 Specifies the value of the InputStepper. See Functional specs
disabled boolean false If true, the InputStepper will be disabled.
error React.Node The error to display beneath the InputStepper. See Functional specs
help React.Node The help to display beneath the InputStepper.
label string The label for the InputStepper. See Functional specs
maxValue number Specifies the maximum value for the InputStepper.
minValue number -∞ Specifies the minimum value for the InputStepper.
name string The name for the InputStepper.
required boolean false If true, the label is displayed as required.
onBlur func Function for handling onBlur event.
onChange func Function for handling onClick event.
onFocus func Function for handling onFocus event.
ref func Prop for forwarded ref of the InputStepper. See Functional specs
size enum "normal" The size of the InputStepper.
step number 1 Specifies the value of step to increment and decrement.

enum

size
"small"
"normal"

Functional specs

  • The error prop overwrites the help prop, due to higher priority.

  • The color of the label will turn into cloud shade when the InputStepper has some filled value.

  • The prop defaultValue sets up the default value when component mounts. If you need to get the current and validated value of InputStepper, use arrow function for it, e.g.:

    <InputStepper onChange={(value) => doSomething(value)} />
  • ref can be used for example auto-focus the elements immediately after render.

    class Component extends React.PureComponent<Props> {
    
    constructor() {
      super()
      this.ref = React.createRef();
    }
    
    componentDidMount() {
      this.ref.current && this.ref.current.focus();
    }
    
    ref: { current: React$ElementRef<*> | null };
    
    render() {
      return (
        <InputStepper ref={this.ref} />
      )
    }
    }