Skip to main content

usePageState

@lowcode/runtime-core


Function: usePageState()

usePageState<T>(path, pageId?): T | undefined

Defined in: react/runtimeHooks.tsx:144

React-хук для чтения значения из состояния страницы.

Правила выбора страницы:

  • если pageId передан, используется он;
  • если не передан — используется snapshot.activePageId;
  • если активная страница отсутствует, возвращается undefined.

Пример:

const search = usePageState<string>("search.query");
const pageSize = usePageState<number>(["table", "pageSize"], "page-home");

Type Parameters

T

T = unknown

Ожидаемый тип значения.

Parameters

path

Путь до свойства (строка с точками или массив ключей).

string | string[]

pageId?

string

Необязательный идентификатор страницы.

Returns

T | undefined

Значение или undefined.