React Component - debounce

Question

Trying to create a delay on react component that has input field that updates on change

Here is my onChange method

handleOrderQtyKeyPress (e) {
    var regex = /[^0-9]/
    if (e.key.match(regex)) {
        e.preventDefault();
    }
    if (this.state.orderQtyValue.toString().length == 3) {
        e.preventDefault();
    }
}

and the react-bootstrap component:

 <FormControl
   type='number'
   min='0'
   value={this.state.orderQtyValue}
   onChange={this.handleOrderQtyChange}
   onKeyPress={this.handleOrderQtyKeyPress}
   style={styles.orderQtyValue}
  />

so I tried importing lodash _.debounce and applying at the constructor

import debounce from 'lodash/debounce';


this.handleOrderQtyKeyPress = _.debounce(this.handleOrderQtyKeyPress.bind(this),1000);

I am not getting a debounce. What am I missing here?

What do you want to achieve? Why do you want to debounce change event at all? — Andreyco, Jan 30 '17 at 22:00
debounce to prevent onChange from firing every time a digit is entered into the input field. — RBdevelop, Feb 01 '17 at 01:53
The input should probably be updated without any delay, but the *server* request should be the one which is debounced, assuming a request is sent on every `change` event, or else why would you bother asking? — vsync, Aug 29 '22 at 14:34

score 1 · Answer 1 · answered Jan 30 '17 at 22:23

I see that you use this, so I assume that FormControl is inside of a render function of your stateful component. In this case make sure that your binding and debouncing is happening in constructor of this stateful component.

```

const Component extends React.Component {
   constructor(props) {
     super(props);
     this.handleOrderQtyKeyPress = _.debounce(this.handleOrderQtyKeyPress.bind(this), 1000);
   }
}

```

score 0 · Answer 2 · answered Feb 01 '17 at 07:44

Please, read comment which explains how this works

class Input extends Component {
    static propTypes = {
        onChange: PropTypes.func.isRequired,
        value: React.PropTypes.oneOfType([
            React.PropTypes.string,
            React.PropTypes.number,
        ]),
    }

    state = {
        value: '',
    }

    // When component receives updated `value` from outside, update internal `value` state.
    componentWillReceiveProps(nextProps) {
        this.setState({ value: nextProps.value });
    }

    // Store updated value localy.
    onChange = (event) => {
        this.setState({ value: event.target.value });
    }

    onBlur = (event) => {
        // Trigger change to external env.
        this.props.onChange(this.state.value);
        // Also, don't forget to call `onBlur` if received from parent.
        if (this.props.onBlur) {
            this.props.onBlur(event);
        }
    }

    render() {
        return <input {...this.props} value={this.state.value} onChange={this.onChange} onBlur={this.onBlur} />
    }
}

score 0 · Answer 3 · answered Aug 29 '22 at 14:40

If you want to automatically debounce (or throttle) a component easily, when the props change often (as opposed to internal state changed),

I've authored a tiny wrapper (1kb minified) for that, called React-Bouncer:

import bouncer from '@yaireo/react-bouncer'

// uses 300ms `debounce` by default
const DebouncedYourComponent = bouncer(YourComponent)

This is useful when you do not have much of a control on the rate which the props sent to the component are updated, or the root cause of the often updates is unknown.

(Obviously, using debounce on the root-cause is the first thing to try)

React Component - debounce

3 Answers3