Git Product home page Git Product logo

babel-plugin-react-component-data-attribute's Introduction

babel-plugin-react-component-data-attribute

This plugin adds a data-component attribute to top-level DOM elements rendered by your component. This can be useful for constructing a high-level component hierarchy outside the context of your React application (for instance, for the purposes of click tracking).

Example

In

class ComponentOne extends React.Component {
  render() {
    return <div />;
  }
}

function ComponentTwo() {
  return someCondition
    ? <div><div /></div>
    : <ComponentOne />;
}

const ComponentThree = () => (
  <div />
);

Out

class ComponentOne extends React.Component {
  render() {
    return <div data-component="ComponentOne" />;
  }
}

function ComponentTwo() {
  return someCondition
    ? <div data-component="ComponentTwo"><div /></div>
    : <ComponentOne />;
}

const ComponentThree = () => (
  <div data-component="ComponentThree" />
);

Installation

# yarn
yarn add --dev babel-plugin-react-component-data-attribute

# npm
npm install --save-dev babel-plugin-react-component-data-attribute

Usage

Via .babelrc (Recommended)

.babelrc

{
  "plugins": ["react-component-data-attribute"]
}

Via CLI

babel --plugins react-component-data-attribute script.js

Via Node API

require('babel-core').transform('code', {
  plugins: ['react-component-data-attribute'],
});

Options

This plugin accepts an options object with a single option: onlyRootComponents. When this option is true, only components that appear to be the "main" part of a particular component will get the data attribute. The plugin determines whether a component is "root" or not based on the following criteria:

  • It is a named or default export
  • It is in a file named index, or in a file named the same as the directory (so, for instance, MyComponent/MyComponent.js)

babel-plugin-react-component-data-attribute's People

Contributors

lemonmade avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.