Reflex Logo
Docs Logo
Api Reference

/

Eventspec

Eventspec

reflex_core.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.

Attributes: handler: The event handler. client_handler_name: The handler on the client to process event. args: The arguments to pass to the function.

Fields

PropDescription
event_actions: dict[str, bool | int] = <class 'dict'>
handler: EventHandler = None

The event handler.

client_handler_name: str = ''

The handler on the client to process event.

args: tuple[tuple[reflex_core.vars.base.Var, reflex_core.vars.base.Var], ...] = <class 'tuple'>

The arguments to pass to the function.

Methods

SignatureDescription
with_args(self, args: tuple[tuple[reflex_core.vars.base.Var, reflex_core.vars.base.Var], ...]) -> 'EventSpec'Copy the event spec, with updated args.
add_args(self, *args: reflex_core.vars.base.Var) -> 'EventSpec'Add arguments to the event spec.
Built with Reflex