NewReflex Agent Toolkit is launching. Get early access

Api Reference

/

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

Prop	Description
`event_actions: dict[str, bool \| int] = {}`	Whether to `preventDefault` or `stopPropagation` on the event.
Whether to `preventDefault` or `stopPropagation` on the event.
`handler: EventHandler = None`	The event handler.
The event handler.
`client_handler_name: str = ''`	The handler on the client to process event.
The handler on the client to process event.
`args: tuple[tuple[Var, Var], Ellipsis] = ()`	The arguments to pass to the function.
The arguments to pass to the function.

Methods

Signature	Description
`with_args(args: tuple[tuple[Var, Var], Ellipsis]) -> EventSpec`	Copy the event spec, with updated args.
`add_args(*args: Var) -> EventSpec`	Add arguments to the event spec.

Built with Reflex