Skip to content

[18] Add docs for flushSync #4474

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

Merged
merged 3 commits into from
Mar 20, 2022
Merged

[18] Add docs for flushSync #4474

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2f065ad
[18] Add flushSync to ReactDOM docs
rickhanlonii Mar 19, 2022
22cdcb1
Seb feedback
rickhanlonii Mar 19, 2022
85a9607
More Seb feedback
rickhanlonii Mar 20, 2022
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
19 changes: 18 additions & 1 deletion content/docs/reference-react-dom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The `react-dom` package also provides modules specific to client and server apps

The `react-dom` package exports these methods:
- [`createPortal()`](#createportal)

- [`flushSync()`](#flushsync)

These `react-dom` methods are also exported, but are considered legacy:
- [`render()`](#render)
Expand Down Expand Up @@ -55,6 +55,23 @@ createPortal(child, container)
```

Creates a portal. Portals provide a way to [render children into a DOM node that exists outside the hierarchy of the DOM component](/docs/portals.html).

### `flushSync()` {#flushsync}

```javascript
flushSync(callback)
```

Force React to flush any updates inside the provided callback synchronously. This method is useful for being able to read the result of those updates immediately.

> Note:
>
> `flushSync` can have a significant impact on performance. Use sparingly.
>
> `flushSync` will force Suspense boundaries to show their `fallback` state.
Copy link
Contributor

@sebmarkbage sebmarkbage Mar 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*can ... if they're still loading.

>
> `flushSync` may also run pending effects and synchronously apply any updates they contain before returning.

## Legacy Reference
### `render()` {#render}
```javascript
Expand Down