For AI agents: the complete documentation index is at llms.txt. Markdown versions are available by appending .md or sending Accept: text/markdown.
Reflex Logo
Docs Logo
Api Reference

/

Eventspec

Eventspec

reflex_base.event.EventSpec

An event specification.

Whereas an Event object is passed during runtime, a spec is used during compile time to outline the structure of an event.

Fields

PropDescription
event_actions: dict[str, bool | int] = {}
handler: EventHandler = None

The event handler.

client_handler_name: str = ''

The handler on the client to process event.

args: tuple[tuple[Var, Var], Ellipsis] = ()

The arguments to pass to the function.

Methods

SignatureDescription
with_args(args: tuple[tuple[Var, Var], Ellipsis]) -> EventSpecCopy the event spec, with updated args.
add_args(*args: Var) -> EventSpecAdd arguments to the event spec.
Built with Reflex