Skip to content
Permalink
main
Switch branches/tags
Go to file
5 contributors

Users who have contributed to this file

@bvaughn @gaearon @NE-SmallTown @morgsmccauley @bbolek
523 lines (375 sloc) 41 KB

React DevTools changelog

Changes that have landed in main but are not yet released. Click to see more.

4.14.0 (July 17, 2021)

Features

Display hook names for inspected components

DevTools parsing hook names

Control for manually toggling error boundaries

DevTools error boundary toggle

4.13.5 (May 25, 2021)

Bugfix

  • Handle edge case where a component mounts before its "owner" (in DEV mode) that previously caused a validation error (bvaughn in #21562)

4.13.4 (May 20, 2021)

Bugfix

  • Fix edge-case Fast Refresh bug that caused Fibers with warnings/errors to be untracked prematurely (which broke componentinspection in DevTools) (bvaughn in #21536)
  • Revert force deep re-mount when Fast Refresh detected (was no longer necessary) (bvaughn in #21539)

4.13.3 (May 19, 2021)

Misc

  • Updated react and react-dom API imports in preparation for upcoming stable release (bvaughn in #21488)

Bugfix

  • Reload all roots after Fast Refresh force-remount (to avoid corrupted Store state) (bvaughn in #21516 and #21523)
  • Errors thrown by Store can be dismissed so DevTools remain usable in many cases (bvaughn in #21520)
  • Bugfix for useState() object with hasOwnProperty key (bvaughn in #21524)
  • Fixed string concatenation problem when a Symbol was logged to console.error or console.warn (bvaughn in #21521)
  • DevTools: Fixed version range NPM syntax (bvaughn in 9cf1069)
  • Tweaked DevTools error template title to match issue form template (bvaughn in 1a2d792)

4.13.2 (May 7, 2021)

Misc

4.13.1 (April 28, 2021)

Bugfix

  • Improve display name logic for React.memo components (bvaughn in #21392)
  • Fixed potential runtime error with Suspense in versions <= 17 (bvaughn in #21432)
  • Errors thrown in the Store are no longer silent (bvaughn in #21426)

Misc

4.13.0 (April 28, 2021)

Features

  • Add Bridge protocol version backend/frontend (bvaughn in #21331)

Bugfix

  • DevTools iterates over siblings during mount (rather than recursing) to avoid stack overflow errors (bvaughn in #21377)
  • Multiple error dialogs can be visible at once (bvaughn in #21370)
  • Console patching should handle Symbols without erroring (bvaughn in #21368)
Bridge protocol version backend/frontend

During initialization, DevTools now checks to ensure it's compatible with the "backend" that's embedded within a renderer like React Native. If the two aren't compatible, upgrade instructions will be shown:

Dialog displaying downgrade instructions for the React DevTools frontend to connect to an older backend version

Dialog displaying upgrade instructions for the React DevTools frontend to connect to a newer backend version

Learn more about this change at fb.me/devtools-unsupported-bridge-protocol

4.12.4 (April 19, 2021)

Bugfix

  • Remove @octokit/rest depedency because of a problem with transitive dependencies (bvaughn in #21317)

4.12.3 (April 19, 2021)

Bugfix

  • Wrapped quotation marks around Fiber ids or indices for all DevTools errors to better support GitHub fuzzy error search (bvaughn in #21314)

4.12.2 (April 16, 2021)

Bugfix

  • DevTools reliably suppresses console logs when generating component stacks (bvaughn in #21301)

4.12.1 (April 14, 2021)

Although this release is being made for all NPM packages, only the react-devtools-inline package contains changes.

Bugfix

  • Fixed react-devtools-inline bug in frontend initialize method (bvaughn in #21265)

4.12.0 (April 12, 2021)

Although this release is being made for all NPM packages, only the react-devtools-inline package contains changes.

Features

  • Added createBridge and createStore exports to the react-devtools-inline/frontend entrypoint to support advanced use cases (bvaughn in #21032)

4.11.1 (April 11, 2021)

Bugfix

  • Fixed broken import in react-devtools-inline for feature flags file (bvaughn in #21237)

4.11.0 (April 9, 2021)

Bugfix

  • $r should contain hooks property when it is forwardRef or memo component (meowtec in #20626)
  • Ensure sync-xhr is allowed before reload and profile (ChrisDobby in #20879)
  • Bump electron version from 9.1.0 to 11.1.0 for darwin-arm64 builds (jaiwanth-v in #20496)
  • Fixed primitive hook badge colors for light theme (bvaughn in #21034)
  • Increased minimum Chrome/Firefox versions from 51/54 to 60/55 to reduce polyfill code. (bvaughn in #21185)
  • Fix can't expand prop value in some scenario (iChenLei in #20534)
  • Flush updated passive warning/error info after delay (bvaughn in #20931)
  • Patch console methods even when only show-inline-warnings/errors enabled (bvaughn in #20688)
  • React Native fixes for new inline errors feature (bvaughn in #20502)
  • Fixed invalid work tag constants that affected a certain range of React versions (bvaughn in #20362)

Features

Experimental features

The following features are only enabled when used with (experimental) builds of React:

Improve Profiler commit-selector UX

Video demonstrating tooltip with commit duration and time

Graphic illustrating Profiler bar heights using different scales

Expose DEV-mode warnings in devtools UI

Inline warnings and errors

Shows which fibers scheduled the current update

Shows which fibers scheduled the current update

Add commit and post-commit durations to Profiler UI

Add commit and post-commit durations to Profiler UI

Show which hooks (indices) changed when profiling

Show which hooks (indices) changed when profiling

4.10.4 (May 20, 2021)

Bugfix

  • Ported passive effects sync flushing/bubbling bugfix (bvaughn in #21540)

4.10.3 (April 27, 2021)

Bugfix

  • Replaced Facebook-internal fburl.com link with public fb.me link for Bridge protocol mismatch info page (bvaughn in #21344)

4.10.2 (April 27, 2021)

Features

  • Added Bridge protocol check and warning dialog if embedded DevTools backend is incompatible with DevTools UI (bvaughn in #21344)

4.10.1 (November 12, 2020)

Bugfix

4.10.0 (November 12, 2020)

Features

  • Make DevTools Websocket retry delay configurable (bvaughn in #20107)

Bugfix

  • Fix error loading source maps for devtools extension (sytranvn in #20079)
  • Remove css-sourcemap for react-devtools-inline (sean9keenan in #20170)
  • Decrease NPM update notification/prompt for standalone DevTools (recurx in #20078)

4.9.0 (October 19, 2020)

Features

Bugfix

  • Show proper icon/tooltip for restricted browser pages (sktguha in #20023)
  • Fix emoji character shown in Chrome developer tools panel (bvaughn in #19603)
  • Don't open two tabs in Firefox when clicking on troubleshooting instructions (unbyte in #19632)
  • Support inner component _debugOwner in memo (bvaughn in #19556)
  • Proxied methods should be safely dehydrated for display (@pfongkye in b6e1d08
  • Property list values should show whitespace (sammarks in #19640)
  • Fix crash when inspecting document.all (omarsy in #19619)
  • Don't call generators during inspection since they may be stateful (todortotev in #19831)
  • Fix bad null check in DevTools highlight code (bvaughn in #20010)
  • Handled a missing suspense fiber when suspense is filtered on the profiler (IDrissAitHafid in #ISSUE)
  • Fixed unfound node error when Suspense is filtered (IDrissAitHafid in #20019)
  • Always overrides the dispatcher when shallow rendering (bvaughn in #20011)
  • Frevent phishing attacks (iamwilson in #19934)

Other

Improved DevTools editing interface

Improved parsing Value parsing logic has been relaxed so as to no longer require quotes around strings or double quotes: looser parsing logic

Modifying arrays New values can be added to array props/state/hooks now. Existing values can also be deleted: adding and removing values from an array

Modifying objects New keys can be added to object props/state/hooks now. Existing keys can be renamed or deleted entirely: adding/renaming/removing object properties

4.8.2 (July 15, 2020)

Bugfix

4.8.1 (July 10, 2020)

Bugfix

  • Fix break-on-warning to truly be off by default. (gaearon in #19309)

4.8.0 (July 9, 2020)

Features

Bugfix

  • Updates Electron version for react-devtools to pull in several security fixes (gsimone in #19280)
  • Remove unnecessary tag end from CommitRanked view (finico in #19195)
  • Shutdown DevTools Bridge synchronously when unmounting (bvaughn in #19180)

4.7.0 (May 18, 2020)

Features

  • Improved appended component stacks for third party warnings to be more like native (bvaughn in #18656)
  • Improve inline search results by highlighting match on HOC badge (bl00mber in #18802)
  • Add key badge to inspected element in right hand pane ([karlhorky]](https://github.com/karlhorky) in #18737)
  • Improve Profiler snapshot selector drag-and-drop UX (bl00mber in #18852)
  • Profiler tooltip now includes self duration to make it easier to scan times without requiring selection (bvaughn in #18510)
  • Rendered by list also now highlights native elements on hover (hristo-kanchev in #18479)
  • Add in-page highlighting for mouse-over interactions in Profiler (bl00mber in #18745)

Bugfix

  • Fix Profiler bug "Could not find commit data for root" by resetting selected node on root change (bl00mber in #18880)
  • Add imported flag to Profiling data to more reliably differentiate between imported and session data (bl00mber in #18913)
  • Disable Profiler filtering to avoid edge case runtime error "Cannot read property 'duration' of undefined" (bvaughn in #18862)
  • Fix Profiler bug "cannot read property 'memoizedState' of null" (bvaughn in #18522)
  • Whitespace search results highlighting bug fix (bvaughn in #18527)
  • Improved confusing Profiler tooltip text for components that did not render (bvaughn in #18523)
  • Fix edge case performance issue when highlight elements enabled (Faelivrinx in #18498)
  • Disabled Webpack auto polyfill for setImmediate (bvaughn in #18860)
  • Fix mouse interactions for standalone DevTools on Linux (bl00mber in #18772)

4.6.0 (March 26, 2020)

Features

Bugfix

  • Improve display of complex values for useDebugValue (eps1lon in #18070)
  • Fix minor CSS layout issue that broke Profiler commit selector UI (bvaughn in #18286)
  • Inlined DevTools event emitter implementation to fix a source of Profiler bugs (bvaughn in #18378)

Cleanup

  • Remove "es6-symbol" dependency from "react-devtools-inline" package (bvaughn in #18397)

4.5.0 (March 3, 2020)

Features

Bugfix

  • Improve how empty commits are filtered (nutboltu in #17931)
  • BigInt serialize issue in devtools copy to clipboard (bvaughn in #17771)
  • Renamed "backend.js" to "react_devtools_backend.js" to reduce potential confusion from profiling (bvaughn in #17790)
  • Update root styles to prevent box-sizing style from leaking outside of inline target (GasimGasimzada in #17775)
  • Fix "Cannot read property 'sub' of undefined" error when navigating to plain-text pages (wfnuser in #17848)
  • Fix potential error with composite hooks during shallow re-rendering (bvaughn in #18130)
  • Scope dev tools wildcard styles within DevTools CSS class (@GasimGasimzada in 9cc094a)
Info summary tooltips

Profiler tooltips in Flamegraph chart

Profiler tooltips in Ranked chart

Components panel resize

Horizontal Components panel resizing

Vertical Components panel resizing

4.4.0 (January 3, 2020)

Features

  • Re-enabled "copy" prop/state/hooks context menu option for Firefox (bvaughn,rpl in #17740)
  • Shift+Enter focuses previous search result in Components tree (Bo-Duke in #17005)
  • Properly display formatted RegExp values in props/state panel(bvaughn in #17690)
  • Profiler commit selector wraps around for easier navigation of large profiles (bvaughn in #17760)

Bugfix

  • Check document.contentType before injecting hook to avoid breaking XML file syntax highlighting in Firefox (bvaughn in #17739)
  • Fix standalone UI not responding to mouse interactions due to webkit-app-region style (cwatson88 in #17584)
  • Support inspecting object values with null protos (bvaughn in #17757)
  • Support inspecting values that have overridden hasOwnProperty attribute (bvaughn in #17768)
  • Fixed regression that made Profiler "Could not find node…" error happen more frequently (bvaughn in #17759)

4.3.0 (December 20, 2019)

Features

  • Show component location for selected element in bottom/right panel (bvaughn in #17567)
  • Improved inspected element values with inline previews (bvaughn in #17579)
  • Improved selection and toggling for inspected element panel (bvaughn in #17588)
  • Copy context menu for inspecting and copying props/state/hooks/context values (bvaughn in #17608)

Bug fixes

  • Fix serialization for BigInt type so that it does not break inspection panel. (nutboltu in #17233)
  • Fix display name logic for forwardRefs that use displayName property (zthxxx in #17613)

4.2.1 (November 27, 2019)

Bug fixes

  • Profiler automatically filters certain types of empty (no work) commits. (bvaughn in #17253)
  • Fix memoized components showing as "Anonymous" in Components tab. (wsmd in #17274)
  • Edge-case bugfix for non-string element keys. (bvaughn in #17164)

4.2.0 (October 3, 2019)

Features

  • "Highlight updates" feature added for browser extensions and react-devtools-inline NPM package. (bvaughn in #16989)

4.1.3 (September 30, 2019)

Bug fixes

  • Fixed regression where DevTools wouldn't properly connect with apps when using the file:// protocol. (linshunghuang in #16953)

4.1.2 (September 27, 2019)

Bug fixes

  • Fixed an infinite loop that occurred in some cases with prop values of NaN. (bvaughn in #16934)

4.1.1 (September 26, 2019)

Bug fixes

  • Fixed bug where Components panel was always empty for certain users. (linshunghuang in #16900)
  • Fixed regression in DevTools editable hooks interface that caused primitive values to be shown as undefined. (bvaughn in #16867)
  • Fixed bug where DevTools showed stale values in props/state/hooks editing interface. (bvaughn in #16878)
  • Show unsupported version dialog with downgrade instructions. (bvaughn in #16897)

4.1.0 (September 19, 2019)

Features

  • Props/state editor supports adding new values and changing value types. (hristo-kanchev in #16700)

Bug fixes

  • Profiler correctly saves/exports profiling data in Firefox now. (hristo-kanchev in #16612)
  • Class components now show "legacy context" header (rather than "context") for legacy API. (hristo-kanchev in #16617)
  • Show component source button ("<>") now highlights the render method for class components. (theKashey in #16759)
  • Bugfix for components with non-standard object values for function.name. (LetItRock in #16798)

4.0.6 (August 26, 2019)

Bug fixes

  • Remove ⚛️ emoji prefix from Firefox extension tab labels
  • Standalone polyfills Symbol usage

4.0.5 (August 19, 2019)

Bug fixes

  • Props, state, and context values are alpha sorted.
  • Standalone DevTools properly serves backend script over localhost:8097

4.0.4 (August 18, 2019)

Bug fixes

  • Bugfix for potential error if a min-duration commit filter is applied after selecting a fiber in the Profiler UI.

4.0.3 (August 17, 2019)

Bug fixes

  • ES6 Map and Set, typed arrays, and other unserializable types (e.g. Immutable JS) can now be inspected.
  • Empty objects and arrays now display an "(empty)" label to the right to reduce confusion.
  • Components that use only the useContext hook now properly display hooks values in side panel.
  • Style editor now supports single quotes around string values (e.g. both "red" and 'red').
  • Fixed edge case bug that prevented profiling when both React v16 and v15 were present on a page.

4.0.2 (August 15, 2019)

Permissions cleanup

  • Removed unnecessary webNavigation permission from Chrome and Firefox extensions.

4.0.1 (August 15, 2019)

Permissions cleanup

  • Removed unnecessary <all_urls>, background, and tabs permissions from Chrome and Firefox extensions.

4.0.0 (August 15, 2019)

General changes

Improved performance

The legacy DevTools extension used to add significant performance overhead, making it unusable for some larger React applications. That overhead has been effectively eliminated in version 4.

Learn more about the performance optimizations that made this possible.

Component stacks

React component authors have often requested a way to log warnings that include the React "component stack". DevTools now provides an option to automatically append this information to warnings (console.warn) and errors (console.error).

Example console warning with component stack added

It can be disabled in the general settings panel:

Settings panel showing "component stacks" option

Components tree changes

Component filters

Large component trees can sometimes be hard to navigate. DevTools now provides a way to filter components so that you can hide ones you're not interested in seeing.

Component filter demo video

Host nodes (e.g. HTML <div>, React Native View) are now hidden by default, but you can see them by disabling that filter.

Filter preferences are remembered between sessions.

No more inline props

Components in the tree no longer show inline props. This was done to make DevTools faster and to make it easier to browse larger component trees.

You can view a component's props, state, and hooks by selecting it:

Inspecting props

"Rendered by" list

In React, an element's "owner" refers to the thing that rendered it. Sometimes an element's parent is also its owner, but usually they're different. This distinction is important because props come from owners.

Example code

When you are debugging an unexpected prop value, you can save time if you skip over the parents.

DevTools v4 adds a new "rendered by" list in the right hand pane that allows you to quickly step through the list of owners to speed up your debugging.

Example video showing the "rendered by" list

Owners tree

The inverse of the "rendered by" list is called the "owners tree". It is the list of things rendered by a particular component- (the things it "owns"). This view is kind of like looking at the source of the component's render method, and can be a helpful way to explore large, unfamiliar React applications.

Double click a component to view the owners tree and click the "x" button to return to the full component tree:

Demo showing "owners tree" feature

No more horizontal scrolling

Deeply nested components used to require both vertical and horizontal scrolling to see, making it easy to "get lost" within large component trees. DevTools now dynamically adjusts nesting indentation to eliminate horizontal scrolling.

Video demonstration dynamic indentation to eliminate horizontal scrolling

Improved hooks support

Hooks now have the same level of support as props and state: values can be edited, arrays and objects can be drilled into, etc.

Video demonstrating hooks support

Improved search UX

Legacy DevTools search filtered the components tree to show matching nodes as roots. This made the overall structure of the application harder to reason about, because it displayed ancestors as siblings.

Search results are now shown inline similar to the browser's find-in-page search.

Video demonstrating the search UX

Higher order components

Higher order components (or HOCs) often provide a custom displayName following a convention of withHOC(InnerComponentName) in order to make it easier to identify components in React warnings and in DevTools.

The new Components tree formats these HOC names (along with several built-in utilities like React.memo and React.forwardRef) as a special badge to the right of the decorated component name.

Screenshot showing HOC badges

Components decorated with multiple HOCs show the topmost badge and a count. Selecting the component shows all of the HOCs badges in the properties panel.

Screenshot showing a component with multiple HOC badges

Restoring selection between reloads

DevTools now attempts to restore the previously selected element when you reload the page.

Video demonstrating selection persistence

Suspense toggle

React's experimental Suspense API lets components "wait" for something before rendering. <Suspense> components can be used to specify loading states when components deeper in the tree are waiting to render.

DevTools lets you test these loading states with a new toggle:

Video demonstrating suspense toggle UI

Profiler changes

Reload and profile

The profiler is a powerful tool for performance tuning React components. Legacy DevTools supported profiling, but only after it detected a profiling-capable version of React. Because of this there was no way to profile the initial mount (one of the most performance sensitive parts) of an application.

This feature is now supported with a "reload and profile" action:

Video demonstrating the reload-and-profile feature

Import/export

Profiler data can now be exported and shared with other developers to enable easier collaboration.

Video demonstrating exporting and importing profiler data

Exports include all commits, timings, interactions, etc.

"Why did this render?"

"Why did this render?" is a common question when profiling. The profiler now helps answer this question by recording which props and state change between renders.

Video demonstrating profiler "why did this render?" feature

Because this feature adds a small amount of overhead, it can be disabled in the profiler settings panel.

Component renders list

The profiler now displays a list of each time the selected component rendered during a profiling session, along with the duration of each render. This list can be used to quickly jump between commits when analyzing the performance of a specific component.

Video demonstrating profiler's component renders list