reflex/reflex/components/chakra/forms/editable.py

67 lines
1.8 KiB
Python

"""An editable component."""
from __future__ import annotations
from reflex.components.chakra import ChakraComponent
from reflex.event import EventHandler
from reflex.vars import Var
class Editable(ChakraComponent):
"""The wrapper component that provides context value."""
tag = "Editable"
# If true, the Editable will be disabled.
is_disabled: Var[bool]
# If true, the read only view, has a tabIndex set to 0 so it can receive focus via the keyboard or click.
is_preview_focusable: Var[bool]
# The placeholder text when the value is empty.
placeholder: Var[str]
# If true, the input's text will be highlighted on focus.
select_all_on_focus: Var[bool]
# If true, the Editable will start with edit mode by default.
start_with_edit_view: Var[bool]
# If true, it'll update the value onBlur and turn off the edit mode.
submit_on_blur: Var[bool]
# The value of the Editable in both edit & preview mode
value: Var[str]
# The initial value of the Editable in both edit and preview mode.
default_value: Var[str]
# Fired when the Editable is changed.
on_change: EventHandler[lambda e0: [e0]]
# Fired when the Editable is in edit mode.
on_edit: EventHandler[lambda e0: [e0]]
# Fired when the Editable is submitted.
on_submit: EventHandler[lambda e0: [e0]]
# Fired when the Editable is canceled.
on_cancel: EventHandler[lambda e0: [e0]]
class EditableInput(ChakraComponent):
"""The edit view of the component. It shows when you click or focus on the text."""
tag = "EditableInput"
class EditableTextarea(ChakraComponent):
"""Use the textarea element to handle multi line text input in an editable context."""
tag = "EditableTextarea"
class EditablePreview(ChakraComponent):
"""The read-only view of the component."""
tag = "EditablePreview"