"""Stub file for reflex/components/chakra/forms/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 from jinja2 import Environment from reflex.components.chakra import ChakraComponent from reflex.components.component import Component from reflex.components.tags import Tag from reflex.constants import Dirs, 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 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 Form(ChakraComponent): @overload @classmethod def create( # type: ignore cls, *children, as_: Optional[Union[Var[str], str]] = None, reset_on_submit: Optional[Union[Var[bool], bool]] = None, handle_submit_unique_name: Optional[Union[Var[str], str]] = 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_submit: Optional[ Union[EventHandler, EventSpec, list, function, BaseVar] ] = None, on_unmount: Optional[ Union[EventHandler, EventSpec, list, function, BaseVar] ] = None, **props ) -> "Form": """Create a form component. Args: *children: The children of the form. as_: What the form renders to. 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 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. """ ... def get_event_triggers(self) -> Dict[str, Any]: ... class FormControl(ChakraComponent): @overload @classmethod def create( # type: ignore cls, *children, label=None, input=None, help_text=None, error_message=None, is_disabled: Optional[Union[Var[bool], bool]] = None, is_invalid: Optional[Union[Var[bool], bool]] = None, is_read_only: Optional[Union[Var[bool], bool]] = None, is_required: 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 a form control component. Args: *children: The children of the form control. label: The label of the form control. input: The input of the form control. help_text: The help text of the form control. error_message: The error message of the form control. is_disabled: If true, the form control will be disabled. is_invalid: If true, the form control will be invalid. is_read_only: If true, the form control will be readonly is_required: If true, the form control will be required. 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 control. Raises: AttributeError: raise an error if missing required kwargs. Returns: The form control component. """ ... class FormHelperText(ChakraComponent): @overload @classmethod def create( # type: ignore cls, *children, 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 ) -> "FormHelperText": """Create the component. Args: *children: The children of the component. 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(ChakraComponent): @overload @classmethod def create( # type: ignore cls, *children, html_for: Optional[Union[Var[str], str]] = 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. html_for: Link 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 FormErrorMessage(ChakraComponent): @overload @classmethod def create( # type: ignore cls, *children, 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 ) -> "FormErrorMessage": """Create the component. Args: *children: The children of the component. 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. """ ...