Registry / testing / react-deep-force-update

react-deep-force-update

library2.1.3jsnpmunverified

react-deep-force-update is a specialized utility library designed to recursively force-update a React component tree, bypassing standard `shouldComponentUpdate` checks. It is explicitly *not* intended for use in production application code, but rather for React development tools, such as hot module reloading or debugging utilities, where a deep update is necessary regardless of component lifecycle optimizations. The current stable version is 2.1.3. It has a very slow release cadence, typically updating only when core React features or deprecations necessitate changes, such as the shift to React 0.14. Its key differentiator is its ability to bypass standard React update mechanisms for development-time introspection and manipulation, providing a granular control not available through standard React APIs. This package serves a niche purpose within the React ecosystem.

testing

npm install react-deep-force-update

github ↗package ↗

INSTALL

IMPORT

SIG · REACT-DEEP-FORCE-U

react-deep-force-update

testingjavascriptv2.1.3

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

deepForceUpdate

✓ import deepForceUpdate from 'react-deep-force-update';

✗ const deepForceUpdate = require('react-deep-force-update');

The library primarily uses a default export. While CommonJS require might technically work in some environments, ESM import is the recommended and modern approach.

Demonstrates how to import and use `deepForceUpdate` on a rendered React component instance to force a recursive update, bypassing `shouldComponentUpdate`.

import React from 'react'; import { render } from 'react-dom'; import deepForceUpdate from 'react-deep-force-update'; // A simple React component for demonstration class MyComponent extends React.Component { render() { return <div>Hello, {this.props.name}</div>; } } // Render the component into the DOM const container = document.createElement('div'); document.body.appendChild(container); const instance = render(<MyComponent name="World" />, container); // Simulate an update scenario (e.g., from a dev tool) setTimeout(() => { console.log('Forcing deep update...'); deepForceUpdate(instance); console.log('Deep update complete. Check the console for any React warnings if applicable.'); }, 1000);

Debug

Known issues

breakingVersion 2.0.0 and later require React 0.14 or newer. Using it with older React versions (e.g., 0.13) will lead to runtime errors or unexpected behavior.

fix

Upgrade your project's React dependency to version 0.14 or later, or stick to react-deep-force-update v1.x if you must use React 0.13.

affects: >=2.0.0

breakingAs of v2.0.0, only ES6 class components that explicitly inherit `React.Component` will be properly updated when traversing the component tree. Components defined via `createClass()` or other deprecated patterns are no longer fully supported for deep updates.

fix

Ensure all components intended for deep updates are defined as ES6 classes extending `React.Component`. This aligns with React 0.14's deprecation of non-extending ES6 classes for components.

affects: >=2.0.0

gotchaThis library is strictly for React development tools and should *never* be used in production application code. Its purpose is to override standard React update mechanisms, which can lead to unpredictable behavior and performance issues if used inappropriately in a live application.

fix

Do not include this package in your production bundle or use its functionality within your application's logic. It is a development-time-only utility.

affects: >=1.0.0

gotchaFor React Native applications, versions of `react-deep-force-update` prior to a fix for facebook/react-native#2985 may not work correctly. Users were advised to stick to 1.x for React Native until the issue was resolved.

fix

For React Native, ensure you are using a version of `react-deep-force-update` that is compatible with your `react-native` version, ideally v2.x once the underlying React Native issue was addressed. If encountering issues, check the `react-native` compatibility notes.

affects: <2.0.0

Errors

Common errors & fixes

Uncaught TypeError: Cannot read property 'getPublicInstance' of undefined

Attempting to use `deepForceUpdate` with an invalid React instance or a null/undefined value.

fix

Ensure the argument passed to `deepForceUpdate` is a valid, mounted React component instance, typically obtained from `ReactDOM.render()` or `ReactDOM.createRoot().render()`.

Warning: Only ES6 classes that inherit React.Component will be properly updated when walking the tree.

Using `react-deep-force-update` v2.0.0+ with components that do not extend `React.Component` (e.g., using `createClass` or older ES6 class patterns).

fix

Refactor your components to be ES6 classes that explicitly `extend React.Component` to ensure they are fully compatible with deep force updates in newer versions of the library.

Upgrade

Version history

2.1.3latest on npm

Audit

Dependencies

reactrequiredRuntime dependency for React component tree manipulation.

react-domrequiredNeeded for rendering the root instance to pass to deepForceUpdate.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/gaearon/react-deep-force-update ↗

packagehttps://www.npmjs.com/package/react-deep-force-update ↗