event.preventDefault in click handler does not prevent onChange from being called
  • 30-Apr-2023
Lightrun Team
Author Lightrun Team
Share
event.preventDefault in click handler does not prevent onChange from being called

event.preventDefault in click handler does not prevent onChange from being called

Lightrun Team
Lightrun Team
30-Apr-2023

Explanation of the problem

This is a bug report for a React application where an input element of type checkbox with both an onClick and onChange handler is not behaving as expected. Specifically, when the onClick handler calls event.preventDefault(), the onChange handler is still being called.

To reproduce the issue, one can create an input element of type checkbox with both an onClick and onChange handler, and call event.preventDefault() in the onClick handler. When the checkbox is clicked, the onChange handler should not be called, but in the current behavior, it is still invoked. A minimal demo of the issue can be found at http://jsfiddle.net/rf3w7apc/.

The expected behavior is that calling event.preventDefault() in the onClick handler should prevent the default action of updating the value of the input element, thus stopping any change event listener from being invoked. A demo of the expected behavior can be found at https://jsfiddle.net/L1eskzsq/.

This bug has been tested in various versions of Chrome, Firefox, and Safari on macOS 10.12.2 using a build from master. It is unclear whether this issue existed in previous versions of React.

 

Troubleshooting with the Lightrun Developer Observability Platform

Getting a sense of what’s actually happening inside a live application is a frustrating experience, one that relies mostly on querying and observing whatever logs were written during development.
Lightrun is a Developer Observability Platform, allowing developers to add telemetry to live applications in real-time, on-demand, and right from the IDE.

  • Instantly add logs to, set metrics in, and take snapshots of live applications
  • Insights delivered straight to your IDE or CLI
  • Works where you do: dev, QA, staging, CI/CD, and production

Start for free today

Problem solution for event.preventDefault in click handler does not prevent onChange from being called

The issue reported in the question concerns the behavior of React when rendering an input element of type checkbox with both an onClick and an onChange handler. The problem is that, even though event.preventDefault() is called in the onClick handler, the onChange handler is still triggered. This happens because, unlike the onClick event, which is fired before the default action occurs, the onChange event is triggered after the element’s value has been updated. As a result, calling preventDefault() in the onClick handler is ineffective in stopping the change event listener from being invoked.

The suggested workarounds propose two different solutions to this problem. One approach is to handle everything in the onClick handler and prevent the default action from occurring based on some condition. If the condition is met, the preventDefault() function is called to stop the event from propagating further. Otherwise, the value of the input element is updated, and the onChange handler is called normally. Another solution is to simply leave the value of the input element unchanged when the condition is met, thus avoiding the need to call preventDefault() altogether. However, this solution may not work for controlled components, which require the value to be updated in the state regardless of whether the condition is met or not.

In summary, the issue with the onChange event being called even after preventDefault() is called in the onClick handler is a known problem in React, and it is still present in version 16.8.6. The suggested workarounds provide possible solutions to this problem, depending on the specific use case and type of input element. Both approaches involve preventing the default action from occurring when a certain condition is met, but they differ in how the value of the input element is handled. By understanding the underlying cause of the issue and the proposed solutions, developers can choose the workaround that best fits their needs and ensure the proper behavior of their React applications.

 

Other popular problems with React

Problem: Virtual DOM performance issues

One of the most common problems with React is related to performance issues with the virtual DOM. The virtual DOM is a mechanism that React uses to update the view in response to changes in the underlying data. When the state of a component changes, React will first update the virtual DOM, and then update the actual DOM. This process can be slow, particularly if the component has a large number of child elements.

Solution:

To solve this problem, developers can use techniques such as shouldComponentUpdate, which allows components to control when they should re-render, or use the React.memo higher-order component, which only re-renders a component when its props change. Additionally, developers can use the React DevTools extension to identify and optimize components that are causing performance bottlenecks.

Problem: Managing state and props

Another common problem with React is related to managing state and props. React components can have both state and props, which are used to store and pass data between components. However, when a large number of components need to share and update data, it can become difficult to manage and maintain the flow of data.

Solution:

To solve this problem, developers can use a centralized state management library such as Redux or MobX. These libraries allow developers to store all of the application’s state in a single place, and provide a mechanism for updating and sharing that state across all components. Additionally, developers can use the useContext and useReducer hooks to manage state within a component tree.

Problem: Handling Forms

React forms can also be a source of pain for developers, as they require a lot of boilerplate code to handle changes and validation. Forms can be tricky to handle because they often involve multiple inputs, which need to be controlled and updated correctly.

Solution:

To solve this problem, developers can use libraries such as Formik and react-hook-form to handle forms in React. These libraries provide simple APIs for controlling form inputs and handling validation. Additionally, developers can use the useState and useEffect hooks to handle form input changes and validation manually.

A brief introduction to React

React is a JavaScript library for building user interfaces. It was developed by Facebook and is now maintained by a community of developers. React allows developers to build reusable UI components, which can be composed to create complex user interfaces. React uses a virtual DOM (Document Object Model) to improve performance by limiting the amount of changes that need to be made to the actual DOM. The virtual DOM is a lightweight representation of the actual DOM and it allows React to compare the current state of the virtual DOM with the previous state, and make only the necessary changes to the actual DOM.

React follows a component-based architecture, where the user interface is broken down into small, self-contained components that can be easily reused and composed to create more complex UI. React components can have both state and props, which are used to store and pass data between components. React also provides a mechanism for handling events, such as user clicks, through the use of event handlers. React also provides a set of lifecycle methods that developers can use to control when a component is created, updated, and destroyed. This allows developers to control the behavior of their components and optimize performance.

Most popular use cases for React

  1. Building reusable UI components React allows developers to build reusable UI components that can be composed to create complex user interfaces. Each component is self-contained and can manage its own state and props. This allows developers to easily reuse and maintain their code.
  2. Dynamic User Interfaces React uses a virtual DOM to improve performance by limiting the amount of changes that need to be made to the actual DOM. This allows developers to build dynamic user interfaces that can efficiently update in response to changes in the underlying data.
  3. Building complex web applications React can be used to build complex web applications that require efficient updating of dynamic data. React also provides a set of lifecycle methods that developers can use to control when a component is created, updated, and destroyed. This allows developers to control the behavior of their components and optimize performance.
class Counter extends React.Component {
  constructor(props) {
    super(props);
    this.state = { count: 0 };
  }

  handleClick = () => {
    this.setState({ count: this.state.count + 1 });
  }

  render() {
    return (
      <div>
        <p>Count: {this.state.count}</p>
        <button onClick={this.handleClick}>
          Increment
        </button>
      </div>
    );
  }
}
Share

It’s Really not that Complicated.

You can actually understand what’s going on inside your live applications.

Try Lightrun’s Playground

Lets Talk!

Looking for more information about Lightrun and debugging?
We’d love to hear from you!
Drop us a line and we’ll get back to you shortly.

By submitting this form, I agree to Lightrun’s Privacy Policy and Terms of Use.