For AI agents: the complete documentation index is at llms.txt. Markdown versions are available by appending .md or sending Accept: text/markdown.
Square Banner
NewReflex Build On-Prem: A Secure Builder Running in Your Environment. Learn more
Square Banner
Reflex Logo
Docs Logo
Api Reference

/

State

State

reflex.state.State

The app Base State.

Fields

PropDescription
parent_state: reflex.state.BaseState | None = None
substates: dict[str, reflex.state.BaseState] = <class 'dict'>
dirty_vars: set[str] = <class 'set'>
dirty_substates: set[str] = <class 'set'>
router_data: dict[str, typing.Any] = <class 'dict'>
router: reflex_base.vars.base.Field[reflex.istate.data.RouterData] = <class 'reflex.istate.data.RouterData'>
is_hydrated: bool = False

Methods

SignatureDescription
hydrate(*args: Any, **kwargs: Any) -> 'EventSpec'An event handler responds to an event to update the state. Attributes: fn: The function to call in response to the event. state: The state this EventHandler is directly attached to, if any.
set_is_hydrated(*args: Any, **kwargs: Any) -> 'EventSpec'An event handler responds to an event to update the state. Attributes: fn: The function to call in response to the event. state: The state this EventHandler is directly attached to, if any.
setvar(*args: 'Any') -> 'EventSpec'A special event handler to wrap setvar functionality.
Built with Reflex