|
@@ -0,0 +1,740 @@
|
|
|
|
+"""Stub file for reflex/components/radix/primitives/form.py"""
|
|
|
|
+# ------------------- DO NOT EDIT ----------------------
|
|
|
|
+# This file was generated by `scripts/pyi_generator.py`!
|
|
|
|
+# ------------------------------------------------------
|
|
|
|
+
|
|
|
|
+from typing import Any, Dict, Literal, Optional, Union, overload
|
|
|
|
+from reflex.vars import Var, BaseVar, ComputedVar
|
|
|
|
+from reflex.event import EventChain, EventHandler, EventSpec
|
|
|
|
+from reflex.style import Style
|
|
|
|
+from hashlib import md5
|
|
|
|
+from typing import Any, Dict, Iterator, Literal
|
|
|
|
+from jinja2 import Environment
|
|
|
|
+from reflex.components.component import Component
|
|
|
|
+from reflex.components.tags.tag import Tag
|
|
|
|
+from reflex.constants.base import Dirs
|
|
|
|
+from reflex.constants.event import EventTriggers
|
|
|
|
+from reflex.event import EventChain
|
|
|
|
+from reflex.utils import imports
|
|
|
|
+from reflex.utils.format import format_event_chain, to_camel_case
|
|
|
|
+from reflex.vars import BaseVar, Var
|
|
|
|
+from .base import RadixPrimitiveComponent
|
|
|
|
+
|
|
|
|
+FORM_DATA = Var.create("form_data")
|
|
|
|
+HANDLE_SUBMIT_JS_JINJA2 = Environment().from_string(
|
|
|
|
+ "\n const handleSubmit_{{ handle_submit_unique_name }} = useCallback((ev) => {\n const $form = ev.target\n ev.preventDefault()\n const {{ form_data }} = {...Object.fromEntries(new FormData($form).entries()), ...{{ field_ref_mapping }}}\n\n {{ on_submit_event_chain }}\n\n if ({{ reset_on_submit }}) {\n $form.reset()\n }\n })\n "
|
|
|
|
+)
|
|
|
|
+
|
|
|
|
+class FormComponent(RadixPrimitiveComponent):
|
|
|
|
+ @overload
|
|
|
|
+ @classmethod
|
|
|
|
+ def create( # type: ignore
|
|
|
|
+ cls,
|
|
|
|
+ *children,
|
|
|
|
+ as_child: Optional[Union[Var[bool], bool]] = None,
|
|
|
|
+ style: Optional[Style] = None,
|
|
|
|
+ key: Optional[Any] = None,
|
|
|
|
+ id: Optional[Any] = None,
|
|
|
|
+ class_name: Optional[Any] = None,
|
|
|
|
+ autofocus: Optional[bool] = None,
|
|
|
|
+ custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
|
|
+ on_blur: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_context_menu: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_double_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_focus: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_down: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_enter: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_leave: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_move: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_out: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_over: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_up: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_scroll: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_unmount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ **props
|
|
|
|
+ ) -> "FormComponent":
|
|
|
|
+ """Create the component.
|
|
|
|
+
|
|
|
|
+ Args:
|
|
|
|
+ *children: The children of the component.
|
|
|
|
+ as_child: Change the default rendered element for the one passed as a child.
|
|
|
|
+ style: The style of the component.
|
|
|
|
+ key: A unique key for the component.
|
|
|
|
+ id: The id for the component.
|
|
|
|
+ class_name: The class name for the component.
|
|
|
|
+ autofocus: Whether the component should take the focus once the page is loaded
|
|
|
|
+ custom_attrs: custom attribute
|
|
|
|
+ **props: The props of the component.
|
|
|
|
+
|
|
|
|
+ Returns:
|
|
|
|
+ The component.
|
|
|
|
+
|
|
|
|
+ Raises:
|
|
|
|
+ TypeError: If an invalid child is passed.
|
|
|
|
+ """
|
|
|
|
+ ...
|
|
|
|
+
|
|
|
|
+class FormRoot(FormComponent):
|
|
|
|
+ def get_event_triggers(self) -> Dict[str, Any]: ...
|
|
|
|
+ @overload
|
|
|
|
+ @classmethod
|
|
|
|
+ def create( # type: ignore
|
|
|
|
+ cls,
|
|
|
|
+ *children,
|
|
|
|
+ reset_on_submit: Optional[Union[Var[bool], bool]] = None,
|
|
|
|
+ handle_submit_unique_name: Optional[Union[Var[str], str]] = None,
|
|
|
|
+ as_child: Optional[Union[Var[bool], bool]] = None,
|
|
|
|
+ style: Optional[Style] = None,
|
|
|
|
+ key: Optional[Any] = None,
|
|
|
|
+ id: Optional[Any] = None,
|
|
|
|
+ class_name: Optional[Any] = None,
|
|
|
|
+ autofocus: Optional[bool] = None,
|
|
|
|
+ custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
|
|
+ on_blur: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_clear_server_errors: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_context_menu: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_double_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_focus: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_down: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_enter: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_leave: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_move: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_out: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_over: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_up: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_scroll: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_submit: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_unmount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ **props
|
|
|
|
+ ) -> "FormRoot":
|
|
|
|
+ """Create a form component.
|
|
|
|
+
|
|
|
|
+ Args:
|
|
|
|
+ *children: The children of the form.
|
|
|
|
+ reset_on_submit: If true, the form will be cleared after submit.
|
|
|
|
+ handle_submit_unique_name: The name used to make this form's submit handler function unique
|
|
|
|
+ as_child: Change the default rendered element for the one passed as a child.
|
|
|
|
+ style: The style of the component.
|
|
|
|
+ key: A unique key for the component.
|
|
|
|
+ id: The id for the component.
|
|
|
|
+ class_name: The class name for the component.
|
|
|
|
+ autofocus: Whether the component should take the focus once the page is loaded
|
|
|
|
+ custom_attrs: custom attribute
|
|
|
|
+ **props: The properties of the form.
|
|
|
|
+
|
|
|
|
+ Returns:
|
|
|
|
+ The form component.
|
|
|
|
+ """
|
|
|
|
+ ...
|
|
|
|
+
|
|
|
|
+class FormField(FormComponent):
|
|
|
|
+ @overload
|
|
|
|
+ @classmethod
|
|
|
|
+ def create( # type: ignore
|
|
|
|
+ cls,
|
|
|
|
+ *children,
|
|
|
|
+ name: Optional[Union[Var[str], str]] = None,
|
|
|
|
+ server_invalid: Optional[Union[Var[bool], bool]] = None,
|
|
|
|
+ as_child: Optional[Union[Var[bool], bool]] = None,
|
|
|
|
+ style: Optional[Style] = None,
|
|
|
|
+ key: Optional[Any] = None,
|
|
|
|
+ id: Optional[Any] = None,
|
|
|
|
+ class_name: Optional[Any] = None,
|
|
|
|
+ autofocus: Optional[bool] = None,
|
|
|
|
+ custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
|
|
+ on_blur: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_context_menu: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_double_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_focus: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_down: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_enter: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_leave: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_move: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_out: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_over: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_up: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_scroll: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_unmount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ **props
|
|
|
|
+ ) -> "FormField":
|
|
|
|
+ """Create the component.
|
|
|
|
+
|
|
|
|
+ Args:
|
|
|
|
+ *children: The children of the component.
|
|
|
|
+ as_child: Change the default rendered element for the one passed as a child.
|
|
|
|
+ style: The style of the component.
|
|
|
|
+ key: A unique key for the component.
|
|
|
|
+ id: The id for the component.
|
|
|
|
+ class_name: The class name for the component.
|
|
|
|
+ autofocus: Whether the component should take the focus once the page is loaded
|
|
|
|
+ custom_attrs: custom attribute
|
|
|
|
+ **props: The props of the component.
|
|
|
|
+
|
|
|
|
+ Returns:
|
|
|
|
+ The component.
|
|
|
|
+
|
|
|
|
+ Raises:
|
|
|
|
+ TypeError: If an invalid child is passed.
|
|
|
|
+ """
|
|
|
|
+ ...
|
|
|
|
+
|
|
|
|
+class FormLabel(FormComponent):
|
|
|
|
+ @overload
|
|
|
|
+ @classmethod
|
|
|
|
+ def create( # type: ignore
|
|
|
|
+ cls,
|
|
|
|
+ *children,
|
|
|
|
+ as_child: Optional[Union[Var[bool], bool]] = None,
|
|
|
|
+ style: Optional[Style] = None,
|
|
|
|
+ key: Optional[Any] = None,
|
|
|
|
+ id: Optional[Any] = None,
|
|
|
|
+ class_name: Optional[Any] = None,
|
|
|
|
+ autofocus: Optional[bool] = None,
|
|
|
|
+ custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
|
|
+ on_blur: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_context_menu: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_double_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_focus: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_down: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_enter: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_leave: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_move: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_out: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_over: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_up: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_scroll: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_unmount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ **props
|
|
|
|
+ ) -> "FormLabel":
|
|
|
|
+ """Create the component.
|
|
|
|
+
|
|
|
|
+ Args:
|
|
|
|
+ *children: The children of the component.
|
|
|
|
+ as_child: Change the default rendered element for the one passed as a child.
|
|
|
|
+ style: The style of the component.
|
|
|
|
+ key: A unique key for the component.
|
|
|
|
+ id: The id for the component.
|
|
|
|
+ class_name: The class name for the component.
|
|
|
|
+ autofocus: Whether the component should take the focus once the page is loaded
|
|
|
|
+ custom_attrs: custom attribute
|
|
|
|
+ **props: The props of the component.
|
|
|
|
+
|
|
|
|
+ Returns:
|
|
|
|
+ The component.
|
|
|
|
+
|
|
|
|
+ Raises:
|
|
|
|
+ TypeError: If an invalid child is passed.
|
|
|
|
+ """
|
|
|
|
+ ...
|
|
|
|
+
|
|
|
|
+class FormControl(FormComponent):
|
|
|
|
+ @overload
|
|
|
|
+ @classmethod
|
|
|
|
+ def create( # type: ignore
|
|
|
|
+ cls,
|
|
|
|
+ *children,
|
|
|
|
+ as_child: Optional[Union[Var[bool], bool]] = None,
|
|
|
|
+ style: Optional[Style] = None,
|
|
|
|
+ key: Optional[Any] = None,
|
|
|
|
+ id: Optional[Any] = None,
|
|
|
|
+ class_name: Optional[Any] = None,
|
|
|
|
+ autofocus: Optional[bool] = None,
|
|
|
|
+ custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
|
|
+ on_blur: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_context_menu: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_double_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_focus: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_down: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_enter: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_leave: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_move: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_out: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_over: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_up: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_scroll: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_unmount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ **props
|
|
|
|
+ ) -> "FormControl":
|
|
|
|
+ """Create the component.
|
|
|
|
+
|
|
|
|
+ Args:
|
|
|
|
+ *children: The children of the component.
|
|
|
|
+ as_child: Change the default rendered element for the one passed as a child.
|
|
|
|
+ style: The style of the component.
|
|
|
|
+ key: A unique key for the component.
|
|
|
|
+ id: The id for the component.
|
|
|
|
+ class_name: The class name for the component.
|
|
|
|
+ autofocus: Whether the component should take the focus once the page is loaded
|
|
|
|
+ custom_attrs: custom attribute
|
|
|
|
+ **props: The props of the component.
|
|
|
|
+
|
|
|
|
+ Returns:
|
|
|
|
+ The component.
|
|
|
|
+
|
|
|
|
+ Raises:
|
|
|
|
+ TypeError: If an invalid child is passed.
|
|
|
|
+ """
|
|
|
|
+ ...
|
|
|
|
+
|
|
|
|
+LiteralMatcher = Literal[
|
|
|
|
+ "badInput",
|
|
|
|
+ "patternMismatch",
|
|
|
|
+ "rangeOverflow",
|
|
|
|
+ "rangeUnderflow",
|
|
|
|
+ "stepMismatch",
|
|
|
|
+ "tooLong",
|
|
|
|
+ "tooShort",
|
|
|
|
+ "typeMismatch",
|
|
|
|
+ "valid",
|
|
|
|
+ "valueMissing",
|
|
|
|
+]
|
|
|
|
+
|
|
|
|
+class FormMessage(FormComponent):
|
|
|
|
+ @overload
|
|
|
|
+ @classmethod
|
|
|
|
+ def create( # type: ignore
|
|
|
|
+ cls,
|
|
|
|
+ *children,
|
|
|
|
+ name: Optional[Union[Var[str], str]] = None,
|
|
|
|
+ match: Optional[
|
|
|
|
+ Union[
|
|
|
|
+ Var[
|
|
|
|
+ Literal[
|
|
|
|
+ "badInput",
|
|
|
|
+ "patternMismatch",
|
|
|
|
+ "rangeOverflow",
|
|
|
|
+ "rangeUnderflow",
|
|
|
|
+ "stepMismatch",
|
|
|
|
+ "tooLong",
|
|
|
|
+ "tooShort",
|
|
|
|
+ "typeMismatch",
|
|
|
|
+ "valid",
|
|
|
|
+ "valueMissing",
|
|
|
|
+ ]
|
|
|
|
+ ],
|
|
|
|
+ Literal[
|
|
|
|
+ "badInput",
|
|
|
|
+ "patternMismatch",
|
|
|
|
+ "rangeOverflow",
|
|
|
|
+ "rangeUnderflow",
|
|
|
|
+ "stepMismatch",
|
|
|
|
+ "tooLong",
|
|
|
|
+ "tooShort",
|
|
|
|
+ "typeMismatch",
|
|
|
|
+ "valid",
|
|
|
|
+ "valueMissing",
|
|
|
|
+ ],
|
|
|
|
+ ]
|
|
|
|
+ ] = None,
|
|
|
|
+ forceMatch: Optional[Union[Var[bool], bool]] = None,
|
|
|
|
+ as_child: Optional[Union[Var[bool], bool]] = None,
|
|
|
|
+ style: Optional[Style] = None,
|
|
|
|
+ key: Optional[Any] = None,
|
|
|
|
+ id: Optional[Any] = None,
|
|
|
|
+ class_name: Optional[Any] = None,
|
|
|
|
+ autofocus: Optional[bool] = None,
|
|
|
|
+ custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
|
|
+ on_blur: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_context_menu: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_double_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_focus: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_down: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_enter: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_leave: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_move: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_out: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_over: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_up: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_scroll: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_unmount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ **props
|
|
|
|
+ ) -> "FormMessage":
|
|
|
|
+ """Create the component.
|
|
|
|
+
|
|
|
|
+ Args:
|
|
|
|
+ *children: The children of the component.
|
|
|
|
+ name: Used to target a specific field by name when rendering outside of a Field part.
|
|
|
|
+ match: Used to indicate on which condition the message should be visible.
|
|
|
|
+ forceMatch: Forces the message to be shown. This is useful when using server-side validation.
|
|
|
|
+ as_child: Change the default rendered element for the one passed as a child.
|
|
|
|
+ style: The style of the component.
|
|
|
|
+ key: A unique key for the component.
|
|
|
|
+ id: The id for the component.
|
|
|
|
+ class_name: The class name for the component.
|
|
|
|
+ autofocus: Whether the component should take the focus once the page is loaded
|
|
|
|
+ custom_attrs: custom attribute
|
|
|
|
+ **props: The props of the component.
|
|
|
|
+
|
|
|
|
+ Returns:
|
|
|
|
+ The component.
|
|
|
|
+
|
|
|
|
+ Raises:
|
|
|
|
+ TypeError: If an invalid child is passed.
|
|
|
|
+ """
|
|
|
|
+ ...
|
|
|
|
+
|
|
|
|
+class FormValidityState(FormComponent):
|
|
|
|
+ @overload
|
|
|
|
+ @classmethod
|
|
|
|
+ def create( # type: ignore
|
|
|
|
+ cls,
|
|
|
|
+ *children,
|
|
|
|
+ as_child: Optional[Union[Var[bool], bool]] = None,
|
|
|
|
+ style: Optional[Style] = None,
|
|
|
|
+ key: Optional[Any] = None,
|
|
|
|
+ id: Optional[Any] = None,
|
|
|
|
+ class_name: Optional[Any] = None,
|
|
|
|
+ autofocus: Optional[bool] = None,
|
|
|
|
+ custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
|
|
+ on_blur: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_context_menu: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_double_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_focus: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_down: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_enter: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_leave: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_move: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_out: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_over: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_up: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_scroll: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_unmount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ **props
|
|
|
|
+ ) -> "FormValidityState":
|
|
|
|
+ """Create the component.
|
|
|
|
+
|
|
|
|
+ Args:
|
|
|
|
+ *children: The children of the component.
|
|
|
|
+ as_child: Change the default rendered element for the one passed as a child.
|
|
|
|
+ style: The style of the component.
|
|
|
|
+ key: A unique key for the component.
|
|
|
|
+ id: The id for the component.
|
|
|
|
+ class_name: The class name for the component.
|
|
|
|
+ autofocus: Whether the component should take the focus once the page is loaded
|
|
|
|
+ custom_attrs: custom attribute
|
|
|
|
+ **props: The props of the component.
|
|
|
|
+
|
|
|
|
+ Returns:
|
|
|
|
+ The component.
|
|
|
|
+
|
|
|
|
+ Raises:
|
|
|
|
+ TypeError: If an invalid child is passed.
|
|
|
|
+ """
|
|
|
|
+ ...
|
|
|
|
+
|
|
|
|
+class FormSubmit(FormComponent):
|
|
|
|
+ @overload
|
|
|
|
+ @classmethod
|
|
|
|
+ def create( # type: ignore
|
|
|
|
+ cls,
|
|
|
|
+ *children,
|
|
|
|
+ as_child: Optional[Union[Var[bool], bool]] = None,
|
|
|
|
+ style: Optional[Style] = None,
|
|
|
|
+ key: Optional[Any] = None,
|
|
|
|
+ id: Optional[Any] = None,
|
|
|
|
+ class_name: Optional[Any] = None,
|
|
|
|
+ autofocus: Optional[bool] = None,
|
|
|
|
+ custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
|
|
+ on_blur: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_context_menu: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_double_click: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_focus: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_down: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_enter: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_leave: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_move: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_out: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_over: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_mouse_up: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_scroll: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ on_unmount: Optional[
|
|
|
|
+ Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
|
|
+ ] = None,
|
|
|
|
+ **props
|
|
|
|
+ ) -> "FormSubmit":
|
|
|
|
+ """Create the component.
|
|
|
|
+
|
|
|
|
+ Args:
|
|
|
|
+ *children: The children of the component.
|
|
|
|
+ as_child: Change the default rendered element for the one passed as a child.
|
|
|
|
+ style: The style of the component.
|
|
|
|
+ key: A unique key for the component.
|
|
|
|
+ id: The id for the component.
|
|
|
|
+ class_name: The class name for the component.
|
|
|
|
+ autofocus: Whether the component should take the focus once the page is loaded
|
|
|
|
+ custom_attrs: custom attribute
|
|
|
|
+ **props: The props of the component.
|
|
|
|
+
|
|
|
|
+ Returns:
|
|
|
|
+ The component.
|
|
|
|
+
|
|
|
|
+ Raises:
|
|
|
|
+ TypeError: If an invalid child is passed.
|
|
|
|
+ """
|
|
|
|
+ ...
|
|
|
|
+
|
|
|
|
+form_root = FormRoot.create
|
|
|
|
+form_field = FormField.create
|
|
|
|
+form_label = FormLabel.create
|
|
|
|
+form_control = FormControl.create
|
|
|
|
+form_message = FormMessage.create
|
|
|
|
+form_validity_state = FormValidityState.create
|
|
|
|
+form_submit = FormSubmit.create
|