useRevalidator

https://api.reactrouter.com/v7/functions/react-router.useRevalidator.html

Usage

useRevalidator(
  into = NULL,
  as = "children",
  selector = "state",
  render = NULL,
  ...
)

Arguments

into

A component (HTML tag or shiny.react-based element) that will receive the hook data as the specified prop.

as

Character. The name of the component's prop to inject the hook data into (by default "children" for text display, "rows" for a data grid, "value" for an input).

selector

Character. Optional key to extract from the hook data object. If NULL (the default), the entire data is passed. Dotted paths like "summary.title" navigate nested objects.

render

Optional JS function (value) => ReactNode used in place of into/as. Mirrors the native React Router pattern for cases where a single prop is not expressive enough (e.g. JS("v => `${v.first} ${v.last}`")).

...

Additional props to pass to the component.

Details

Calls the useRevalidator() hook and injects the result (or a selector from it) as a prop of the into component. Returns the revalidation state ("idle" or "loading"). Useful for showing loading feedback during manual or polling revalidation.