Skip to content

docs: clarify that update() syncs the tree, not force re-render #2616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Hashim1999164 wants to merge 1 commit into
base: master
Choose a base branch
from
+6 −2
Open

docs: clarify that update() syncs the tree, not force re-render #2616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/enzyme/src/ReactWrapper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,10 +263,12 @@ class ReactWrapper {
}

/**
* Forces a re-render. Useful to run before checking the render output if something external
* Syncs the enzyme component tree snapshot with the react component tree.
* Useful to run before checking the render output if something external
* may be updating the state of the component somewhere.
*
* NOTE: no matter what instance this is called on, it will always update the root.
* NOTE: this does not force a re-render. Use `wrapper.setProps({})` to force a re-render.
*
* @returns {ReactWrapper}
*/
Expand Down
4 changes: 3 additions & 1 deletion packages/enzyme/src/ShallowWrapper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,10 +544,12 @@ class ShallowWrapper {
}

/**
* Forces a re-render. Useful to run before checking the render output if something external
* Syncs the enzyme component tree snapshot with the react component tree.
* Useful to run before checking the render output if something external
* may be updating the state of the component somewhere.
*
* NOTE: can only be called on a wrapper instance that is also the root instance.
* NOTE: this does not force a re-render. Use `wrapper.setProps({})` to force a re-render.
*
* @returns {ShallowWrapper}
*/
Expand Down
Loading