Events
/
Events-overview
Events are composed of two parts: Event Triggers and Event Handlers.
Lets take a look at an example below. Try mousing over the heading to change the word.
class WordCycleState(rx.State):
# The words to cycle through.
text: list[str] = ["Welcome", "to", "Reflex", "!"]
# The index of the current word.
index: int = 0
def next_word(self):
self.index = (self.index + 1) % len(self.text)
@rx.var
def get_text(self) -> str:
return self.text[self.index]
def event_triggers_example():
return rx.heading(
WordCycleState.get_text,
on_mouse_over=WordCycleState.next_word,
color="green",
)
In this example, the heading component has the event trigger, on_mouse_over
.
Whenever the user hovers over the heading, the next_word
event handler will be called to cycle the word. Once the handler returns, the UI will be updated to reflect the new state.
In the event section of the documentation, you will explore the different types of events supported by Reflex, along with the different ways to call them.
Did you find this useful?