1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081 |
- """Stub file for reflex/components/radix/primitives/form.py"""
- # ------------------- DO NOT EDIT ----------------------
- # This file was generated by `reflex/utils/pyi_generator.py`!
- # ------------------------------------------------------
- from typing import Any, Callable, Dict, Literal, Optional, Union, overload
- from reflex.components.component import ComponentNamespace
- from reflex.components.el.elements.forms import Form as HTMLForm
- from reflex.event import EventHandler, EventSpec
- from reflex.ivars.base import ImmutableVar
- from reflex.style import Style
- from reflex.vars import Var
- from .base import RadixPrimitiveComponentWithClassName
- class FormComponent(RadixPrimitiveComponentWithClassName):
- @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[ImmutableVar, str]]] = None,
- on_blur: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_context_menu: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_double_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_focus: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_down: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_enter: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_leave: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_move: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_out: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_over: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_up: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_scroll: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_unmount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = 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.
- """
- ...
- class FormRoot(FormComponent, HTMLForm):
- def add_style(self) -> dict[str, Any] | None: ...
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- as_child: Optional[Union[Var[bool], bool]] = None,
- accept: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- accept_charset: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- action: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- auto_complete: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- enc_type: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- method: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- name: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- no_validate: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- target: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- reset_on_submit: Optional[Union[Var[bool], bool]] = None,
- handle_submit_unique_name: Optional[Union[Var[str], str]] = None,
- access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- auto_capitalize: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- content_editable: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- context_menu: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- enter_key_hint: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- title: Optional[Union[Var[Union[bool, int, str]], str, int, 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[ImmutableVar, str]]] = None,
- on_blur: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_clear_server_errors: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_context_menu: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_double_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_focus: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_down: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_enter: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_leave: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_move: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_out: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_over: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_up: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_scroll: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_submit: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_unmount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- **props,
- ) -> "FormRoot":
- """Create a form component.
- Args:
- *children: The children of the form.
- as_child: Change the default rendered element for the one passed as a child.
- accept: MIME types the server accepts for file upload
- accept_charset: Character encodings to be used for form submission
- action: URL where the form's data should be submitted
- auto_complete: Whether the form should have autocomplete enabled
- enc_type: Encoding type for the form data when submitted
- method: HTTP method to use for form submission
- name: Name of the form
- no_validate: Indicates that the form should not be validated on submit
- target: Where to display the response after submitting 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.
- access_key: Provides a hint for generating a keyboard shortcut for the current element.
- auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
- content_editable: Indicates whether the element's content is editable.
- context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
- dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
- draggable: Defines whether the element can be dragged.
- enter_key_hint: Hints what media types the media element is able to play.
- hidden: Defines whether the element is hidden.
- input_mode: Defines the type of the element.
- item_prop: Defines the name of the element for metadata purposes.
- lang: Defines the language used in the element.
- role: Defines the role of the element.
- slot: Assigns a slot in a shadow DOM shadow tree to an element.
- spell_check: Defines whether the element may be checked for spelling errors.
- tab_index: Defines the position of the current element in the tabbing order.
- title: Defines a tooltip for the element.
- 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):
- def add_style(self) -> dict[str, Any] | None: ...
- @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[ImmutableVar, str]]] = None,
- on_blur: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_context_menu: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_double_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_focus: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_down: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_enter: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_leave: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_move: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_out: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_over: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_up: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_scroll: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_unmount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- **props,
- ) -> "FormField":
- """Create the component.
- Args:
- *children: The children of the component.
- name: The name of the form field, that is passed down to the control and used to match with validation messages.
- server_invalid: Flag to mark the form field as invalid, for 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.
- """
- ...
- class FormLabel(FormComponent):
- def add_style(self) -> dict[str, Any] | None: ...
- @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[ImmutableVar, str]]] = None,
- on_blur: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_context_menu: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_double_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_focus: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_down: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_enter: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_leave: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_move: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_out: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_over: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_up: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_scroll: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_unmount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = 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.
- """
- ...
- 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[ImmutableVar, str]]] = None,
- on_blur: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_context_menu: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_double_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_focus: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_down: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_enter: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_leave: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_move: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_out: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_over: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_up: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_scroll: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_unmount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- **props,
- ) -> "FormControl":
- """Create a Form Control component.
- Args:
- *children: The children of the form.
- 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.
- Raises:
- ValueError: If the number of children is greater than 1.
- TypeError: If a child exists but it is not a TextFieldInput.
- Returns:
- The form control component.
- """
- ...
- LiteralMatcher = Literal[
- "badInput",
- "patternMismatch",
- "rangeOverflow",
- "rangeUnderflow",
- "stepMismatch",
- "tooLong",
- "tooShort",
- "typeMismatch",
- "valid",
- "valueMissing",
- ]
- class FormMessage(FormComponent):
- def add_style(self) -> dict[str, Any] | None: ...
- @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,
- force_match: 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[ImmutableVar, str]]] = None,
- on_blur: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_context_menu: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_double_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_focus: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_down: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_enter: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_leave: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_move: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_out: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_over: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_up: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_scroll: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_unmount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = 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.
- force_match: 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.
- """
- ...
- 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[ImmutableVar, str]]] = None,
- on_blur: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_context_menu: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_double_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_focus: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_down: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_enter: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_leave: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_move: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_out: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_over: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_up: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_scroll: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_unmount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = 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.
- """
- ...
- 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[ImmutableVar, str]]] = None,
- on_blur: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_context_menu: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_double_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_focus: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_down: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_enter: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_leave: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_move: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_out: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_over: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_up: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_scroll: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_unmount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = 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.
- """
- ...
- class Form(FormRoot):
- pass
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- as_child: Optional[Union[Var[bool], bool]] = None,
- accept: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- accept_charset: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- action: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- auto_complete: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- enc_type: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- method: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- name: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- no_validate: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- target: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- reset_on_submit: Optional[Union[Var[bool], bool]] = None,
- handle_submit_unique_name: Optional[Union[Var[str], str]] = None,
- access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- auto_capitalize: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- content_editable: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- context_menu: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- enter_key_hint: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- title: Optional[Union[Var[Union[bool, int, str]], str, int, 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[ImmutableVar, str]]] = None,
- on_blur: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_clear_server_errors: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_context_menu: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_double_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_focus: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_down: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_enter: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_leave: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_move: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_out: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_over: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_up: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_scroll: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_submit: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_unmount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- **props,
- ) -> "Form":
- """Create a form component.
- Args:
- *children: The children of the form.
- as_child: Change the default rendered element for the one passed as a child.
- accept: MIME types the server accepts for file upload
- accept_charset: Character encodings to be used for form submission
- action: URL where the form's data should be submitted
- auto_complete: Whether the form should have autocomplete enabled
- enc_type: Encoding type for the form data when submitted
- method: HTTP method to use for form submission
- name: Name of the form
- no_validate: Indicates that the form should not be validated on submit
- target: Where to display the response after submitting 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.
- access_key: Provides a hint for generating a keyboard shortcut for the current element.
- auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
- content_editable: Indicates whether the element's content is editable.
- context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
- dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
- draggable: Defines whether the element can be dragged.
- enter_key_hint: Hints what media types the media element is able to play.
- hidden: Defines whether the element is hidden.
- input_mode: Defines the type of the element.
- item_prop: Defines the name of the element for metadata purposes.
- lang: Defines the language used in the element.
- role: Defines the role of the element.
- slot: Assigns a slot in a shadow DOM shadow tree to an element.
- spell_check: Defines whether the element may be checked for spelling errors.
- tab_index: Defines the position of the current element in the tabbing order.
- title: Defines a tooltip for the element.
- 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 FormNamespace(ComponentNamespace):
- root = staticmethod(FormRoot.create)
- control = staticmethod(FormControl.create)
- field = staticmethod(FormField.create)
- label = staticmethod(FormLabel.create)
- message = staticmethod(FormMessage.create)
- submit = staticmethod(FormSubmit.create)
- validity_state = staticmethod(FormValidityState.create)
- @staticmethod
- def __call__(
- *children,
- as_child: Optional[Union[Var[bool], bool]] = None,
- accept: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- accept_charset: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- action: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- auto_complete: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- enc_type: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- method: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- name: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- no_validate: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- target: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- reset_on_submit: Optional[Union[Var[bool], bool]] = None,
- handle_submit_unique_name: Optional[Union[Var[str], str]] = None,
- access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- auto_capitalize: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- content_editable: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- context_menu: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- enter_key_hint: Optional[
- Union[Var[Union[bool, int, str]], str, int, bool]
- ] = None,
- hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
- title: Optional[Union[Var[Union[bool, int, str]], str, int, 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[ImmutableVar, str]]] = None,
- on_blur: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_clear_server_errors: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_context_menu: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_double_click: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_focus: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_down: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_enter: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_leave: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_move: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_out: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_over: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_mouse_up: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_scroll: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_submit: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- on_unmount: Optional[
- Union[EventHandler, EventSpec, list, Callable, ImmutableVar]
- ] = None,
- **props,
- ) -> "Form":
- """Create a form component.
- Args:
- *children: The children of the form.
- as_child: Change the default rendered element for the one passed as a child.
- accept: MIME types the server accepts for file upload
- accept_charset: Character encodings to be used for form submission
- action: URL where the form's data should be submitted
- auto_complete: Whether the form should have autocomplete enabled
- enc_type: Encoding type for the form data when submitted
- method: HTTP method to use for form submission
- name: Name of the form
- no_validate: Indicates that the form should not be validated on submit
- target: Where to display the response after submitting 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.
- access_key: Provides a hint for generating a keyboard shortcut for the current element.
- auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
- content_editable: Indicates whether the element's content is editable.
- context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
- dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
- draggable: Defines whether the element can be dragged.
- enter_key_hint: Hints what media types the media element is able to play.
- hidden: Defines whether the element is hidden.
- input_mode: Defines the type of the element.
- item_prop: Defines the name of the element for metadata purposes.
- lang: Defines the language used in the element.
- role: Defines the role of the element.
- slot: Assigns a slot in a shadow DOM shadow tree to an element.
- spell_check: Defines whether the element may be checked for spelling errors.
- tab_index: Defines the position of the current element in the tabbing order.
- title: Defines a tooltip for the element.
- 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.
- """
- ...
- form = FormNamespace()
|