59 lines
2.0 KiB
Python
59 lines
2.0 KiB
Python
"""A switch component."""
|
|
from __future__ import annotations
|
|
|
|
from typing import Any, Optional, Union
|
|
|
|
from reflex.components.chakra import ChakraComponent, LiteralColorScheme
|
|
from reflex.constants import EventTriggers
|
|
from reflex.vars import Var
|
|
|
|
|
|
class Switch(ChakraComponent):
|
|
"""Toggleable switch component."""
|
|
|
|
tag: str = "Switch"
|
|
|
|
# If true, the switch will be checked. You'll need to set an on_change event handler to update its value (since it is now controlled)
|
|
is_checked: Optional[Var[bool]] = None
|
|
|
|
# If true, the switch will be disabled
|
|
is_disabled: Optional[Var[bool]] = None
|
|
|
|
# If true and is_disabled prop is set, the switch will remain tabbable but not interactive.
|
|
is_focusable: Optional[Var[bool]] = None
|
|
|
|
# If true, the switch is marked as invalid. Changes style of unchecked state.
|
|
is_invalid: Optional[Var[bool]] = None
|
|
|
|
# If true, the switch will be readonly
|
|
is_read_only: Optional[Var[bool]] = None
|
|
|
|
# If true, the switch will be required
|
|
is_required: Optional[Var[bool]] = None
|
|
|
|
# The name of the input field in a switch (Useful for form submission).
|
|
name: Optional[Var[str]] = None
|
|
|
|
# The value of the input field when checked (use is_checked prop for a bool)
|
|
value: Var[str] = Var.create(True) # type: ignore
|
|
|
|
# The spacing between the switch and its label text (0.5rem)
|
|
spacing: Optional[Var[str]] = None
|
|
|
|
# The placeholder text.
|
|
placeholder: Optional[Var[str]] = None
|
|
|
|
# The color scheme of the switch (e.g. "blue", "green", "red", etc.)
|
|
color_scheme: Optional[Var[LiteralColorScheme]] = None
|
|
|
|
def get_event_triggers(self) -> dict[str, Union[Var, Any]]:
|
|
"""Get the event triggers that pass the component's value to the handler.
|
|
|
|
Returns:
|
|
A dict mapping the event trigger to the var that is passed to the handler.
|
|
"""
|
|
return {
|
|
**super().get_event_triggers(),
|
|
EventTriggers.ON_CHANGE: lambda e0: [e0.target.checked],
|
|
}
|