Code Monkey home page Code Monkey logo

reactquantum's Introduction

Visualize your React application's component performance metrics with a live heat map.


What It Does

React Quantum parses through your React application to create a color-coded tree model of its component hierarchy. On hover, each tree node will display two key component performance metrics—render time and re-render frequency—as well as memoized state and props to indicate what, specifically, initiated the render.

The beauty is in the heat map: Nodes will change color depending on the component's rendering performance, making it easy to pinpoint possible bottlenecks at a glance. 🔥


How To Get It

Quantum is available as a Chrome extension through the Google Chrome Web Store.

If you prefer to install locally, setup instructions are as follows:

  1. $ git clone https://github.com/ReactQuantum/ReactQuantum.git

  2. $ cd ReactQuantum

  3. $ npm install

  4. $ npm run build-dev

  5. Visit chrome://extensions/

  6. Click the Load Unpacked button, then select your './ReactQuantum/build' directory

  7. Open Chrome Developer Tools (Inspect) on any page that uses React, then click on React Quantum at the top of the Developer Tools panel

  8. Click the Start Quantum button, then refresh the page or set state to trigger a re-render

  9. Optimize components!

NOTE: React Quantum works best for React v16+ local projects in development environments.

Definitions

Term Definition
Render When a React component instance or DOM element is processed and checked to see if work needs to be done.
Total render time Total time a component took to render, including its children.
Individual render time Total time an individual component instance or DOM element took to render.
Current State The current state of a component. Only stateful nodes will have a value for this property.
Props The current props object being passed to this node.
Commit Count The number of times a node’s work has started in the commit phase. This could be changes to a component’s state or props, or a DOM element being added or removed.

Contribute

Feel free to fork this repo and submit pull requests. If you'd like to report bugs or send suggestions, please log an issue or contact us at [email protected].

Team

Altai Chiang (https://github.com/alchi126)

Alyson Swerdloff (https://github.com/alyswerdlova)

Eric Choy (https://github.com/Silly-Turtle)

Jae Park (https://github.com/wjp241)

reactquantum's People

Contributors

alchi126 avatar alyswerdlova avatar silly-turtle avatar wjp241 avatar

Watchers

 avatar  avatar  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.