For AI agents: the complete documentation index is at llms.txt. Remove the trailing slash from a page URL and append .md to read its Markdown version. For the docs home, use index.md.
Announcing our $14M Series ARead more
Reflex LogoDocs Logo

State

reflex.state.State

The app Base State.

Fields

router_data

dict[str, Any]

Default: {}

rx_router_session

Field[SessionData]

Default: SessionData(client_token='', client_ip='', session_id='')

rx_router_headers

Field[HeaderData]

Default: HeaderData(host='', origin='', upgrade='', connection='', cookie='', pragma='', cache_control='', user_agent='', sec_websocket_version='', sec_websocket_key='', sec_websocket_extensions='', accept_encoding='', accept_language='', raw_headers=_FrozenDictStrStr(_data=mappingproxy({})))

rx_router_page

Field[PageData]

Default: PageData

rx_router_url

Field[URLData]

Default: URLData(scheme='', netloc='', origin='://', path='', query='', query_parameters=_FrozenDictStrStr(_data=mappingproxy({})), fragment='', href='')

rx_router_route_id

Field[str]

Default: ''

is_hydrated

bool

Default: False

Methods

hydrate

hydrate() -> None

An event handler responds to an event to update the state.

set_is_hydrated

set_is_hydrated(value: bool) -> None

An event handler responds to an event to update the state.

hydrate_and_load

hydrate_and_load(
    vars: Optional[dict[str, Any]] = None,
    hashes: Optional[list[str]] = None,
) -> Optional[list[Event | EventSpec | EventCallback]]

An event handler responds to an event to update the state.

setvar

setvar(var_name: str, value: Any)

A special event handler to wrap setvar functionality.