re:re:actable
Урок 112 минуты чтения

flushSync: синхронно получить обновлённый DOM

На этой странице
Кратко

flushSync из react-dom заставляет React синхронно обработать нужные обновления, чтобы к возврату вызова DOM соответствовал новому состоянию. Это редкий инструмент интеграции.

Вопрос

Когда нужен flushSync и почему он не меняет переменную state в текущем обработчике?

Основная идея

Обычно setter ставит обновление в очередь, а React объединяет работу. Если сразу после setter прочитать DOM, там ещё может быть прежний текст. Для интеграции с API, которому немедленно нужен обновлённый узел, иногда требуется принудительная синхронная фиксация.

FlushSync получает callback с обновлениями состояния. К моменту возврата нужный DOM уже обновлён. При этом переменная state внутри текущего обработчика остаётся снимком прежнего рендера: flushSync не переписывает JavaScript-замыкание. Он меняет обработку очереди и DOM, а не смысл локальной переменной.

API имеет цену: может обработать также ожидающие обновления или эффекты, снизить пользу batching и даже заставить Suspense показать fallback. Вызов внутри render или lifecycle/effect некорректен, поскольку React уже выполняет работу. Чаще фокус после открытия можно организовать ref-callback или layout-эффектом; flushSync нужен, когда внешнему коду действительно требуется актуальный DOM прямо в этом синхронном вызове.

Пример

import { useRef, useState } from 'react';
import { flushSync } from 'react-dom';
 
export default function QuickEditor() {
  const [open, setOpen] = useState(false);
  const inputRef = useRef<HTMLInputElement>(null);
 
  function openAndFocus() {
    flushSync(() => setOpen(true));
    inputRef.current?.focus(); // узел уже вставлен и ref присоединён
    console.log(open); // прежний снимок: при первом нажатии false
  }
 
  return <>
    <button onClick={openAndFocus}>Открыть редактор и поставить фокус</button>
    {open && <input ref={inputRef} aria-label="Черновик" />}
  </>;
}

Без flushSync немедленное чтение ref после первого setOpen может вернуть null: input ещё не создан. Здесь синхронная фиксация завершает вставку перед focus. В простом приложении ту же пользовательскую задачу обычно лучше решить эффектом или callback ref; пример показывает контракт API.

Что важно помнить

  • Импорт идёт из react-dom, а не react.
  • Не ставьте flushSync вокруг каждого setter: это может ухудшить отзывчивость.
  • Если действительно нужно синхронно обновить несколько связанных полей, объедините их в один callback.
  • FlushSync не переносит работу в другой поток и не гарантирует браузерный paint до следующей строки.
  • Не используйте его для исправления мутаций state или пропущенных зависимостей.

Мини-шпаргалка

Setter → очередь. FlushSync → синхронная фиксация для интеграции. DOM актуален, локальный state-снимок прежний. Применяйте редко и измеряйте стоимость.

Документация

flushSync.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам