123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236 |
- """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, Literal, Optional, Union, overload
- from reflex.components.component import ComponentNamespace
- from reflex.components.el.elements.forms import Form as HTMLForm
- from reflex.event import EventType
- from reflex.style import Style
- from reflex.vars.base import Var
- from .base import RadixPrimitiveComponentWithClassName
- class FormComponent(RadixPrimitiveComponentWithClassName):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- as_child: Var[bool] | bool | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = 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: Var[bool] | bool | None = None,
- accept: Var[str] | str | None = None,
- accept_charset: Var[str] | str | None = None,
- action: Var[str] | str | None = None,
- auto_complete: Var[str] | str | None = None,
- enc_type: Var[str] | str | None = None,
- method: Var[str] | str | None = None,
- name: Var[str] | str | None = None,
- no_validate: Var[bool] | bool | None = None,
- target: Var[str] | str | None = None,
- reset_on_submit: Var[bool] | bool | None = None,
- handle_submit_unique_name: Var[str] | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_clear_server_errors: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_submit: Optional[
- Union[
- EventType[()] | EventType[dict[str, Any]],
- EventType[()] | EventType[dict[str, str]],
- ]
- ] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "FormRoot":
- """Create a form component.
- Args:
- *children: The children of the form.
- on_clear_server_errors: Fired when the errors are cleared.
- 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.
- on_submit: Fired when the form is submitted
- 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: Var[str] | str | None = None,
- server_invalid: Var[bool] | bool | None = None,
- as_child: Var[bool] | bool | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = 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: Var[bool] | bool | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = 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: Var[bool] | bool | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = 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: Var[str] | str | None = None,
- match: Literal[
- "badInput",
- "patternMismatch",
- "rangeOverflow",
- "rangeUnderflow",
- "stepMismatch",
- "tooLong",
- "tooShort",
- "typeMismatch",
- "valid",
- "valueMissing",
- ]
- | Var[
- Literal[
- "badInput",
- "patternMismatch",
- "rangeOverflow",
- "rangeUnderflow",
- "stepMismatch",
- "tooLong",
- "tooShort",
- "typeMismatch",
- "valid",
- "valueMissing",
- ]
- ]
- | None = None,
- force_match: Var[bool] | bool | None = None,
- as_child: Var[bool] | bool | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = 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: Var[bool] | bool | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = 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: Var[bool] | bool | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = 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: Var[bool] | bool | None = None,
- accept: Var[str] | str | None = None,
- accept_charset: Var[str] | str | None = None,
- action: Var[str] | str | None = None,
- auto_complete: Var[str] | str | None = None,
- enc_type: Var[str] | str | None = None,
- method: Var[str] | str | None = None,
- name: Var[str] | str | None = None,
- no_validate: Var[bool] | bool | None = None,
- target: Var[str] | str | None = None,
- reset_on_submit: Var[bool] | bool | None = None,
- handle_submit_unique_name: Var[str] | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_clear_server_errors: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_submit: Optional[
- Union[
- EventType[()] | EventType[dict[str, Any]],
- EventType[()] | EventType[dict[str, str]],
- ]
- ] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "Form":
- """Create a form component.
- Args:
- *children: The children of the form.
- on_clear_server_errors: Fired when the errors are cleared.
- 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.
- on_submit: Fired when the form is submitted
- 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: Var[bool] | bool | None = None,
- accept: Var[str] | str | None = None,
- accept_charset: Var[str] | str | None = None,
- action: Var[str] | str | None = None,
- auto_complete: Var[str] | str | None = None,
- enc_type: Var[str] | str | None = None,
- method: Var[str] | str | None = None,
- name: Var[str] | str | None = None,
- no_validate: Var[bool] | bool | None = None,
- target: Var[str] | str | None = None,
- reset_on_submit: Var[bool] | bool | None = None,
- handle_submit_unique_name: Var[str] | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_clear_server_errors: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_submit: Optional[
- Union[
- EventType[()] | EventType[dict[str, Any]],
- EventType[()] | EventType[dict[str, str]],
- ]
- ] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "Form":
- """Create a form component.
- Args:
- *children: The children of the form.
- on_clear_server_errors: Fired when the errors are cleared.
- 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.
- on_submit: Fired when the form is submitted
- 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()
|