@babel/plugin-transform-react-display-name

What is @babel/plugin-transform-react-display-name?

The @babel/plugin-transform-react-display-name npm package is a Babel plugin that adds the displayName property to React components for use in debugging messages and dev tools. It helps to identify components in the React DevTools by providing a readable name, which is particularly useful for anonymous components.

What are @babel/plugin-transform-react-display-name's main functionalities?

Automatic displayName assignment for React components

This feature automatically assigns a displayName to React components based on their name. This is useful for debugging purposes, as it allows you to see the component's name in the React DevTools.

class MyComponent extends React.Component {}
// Transformed code with displayName:
// MyComponent.displayName = 'MyComponent';

displayName assignment for functional components

Similar to class components, this feature assigns a displayName to functional components, making them easier to identify in the React DevTools.

const MyComponent = () => <div />;
// Transformed code with displayName:
// MyComponent.displayName = 'MyComponent';

displayName assignment for components created with React.createClass

For components created using React.createClass, this plugin also adds a displayName property, which is useful for projects that have not yet migrated to ES6 classes or functional components.

const MyComponent = React.createClass({
  render: function() { return <div />; }
});
// Transformed code with displayName:
// MyComponent.displayName = 'MyComponent';

Other packages similar to @babel/plugin-transform-react-display-name

babel-plugin-add-react-displayname

This package is similar to @babel/plugin-transform-react-display-name as it also adds a displayName to React components. However, it is a standalone Babel plugin that might not be as actively maintained or integrated into the Babel ecosystem as the official Babel plugin.

react-display-name

This package provides a utility function to help manually assign a displayName to a React component. It is not a Babel plugin and requires manual usage within the code, unlike the automatic transformation provided by @babel/plugin-transform-react-display-name.

README

@babel/plugin-transform-react-display-name

Add displayName to createReactClass (and React.createClass) calls

Example

In

var foo = React.createClass({}); // React <= 15
var bar = createReactClass({});  // React 16+

Out

var foo = React.createClass({
  displayName: "foo"
}); // React <= 15
var bar = createReactClass({
  displayName: "bar"
}); // React 16+

Installation

npm install --save-dev @babel/plugin-transform-react-display-name

Usage

Via .babelrc (Recommended)

.babelrc

{
  "plugins": ["@babel/plugin-transform-react-display-name"]
}

Via CLI

babel --plugins @babel/plugin-transform-react-display-name script.js

Via Node API

require("@babel/core").transform("code", {
  plugins: ["@babel/plugin-transform-react-display-name"]
});