4c2b2ed1c6
* remove deprecated features and support for py3.9 * remove other deprecated stuff * update lock file * fix units tests * relock poetry * fix _replace for computed_var * fix some merge typo * fix typing of deploy args * fix benchmarks.yml versions * console.error instead of raising Exception * fix tests * ignore lambdas when resolving annotations * simplify redirect logic in event.py * more fixes * fix unit tests again * give back default annotations for lambdas * fix signature check for on_submit * remove useless stuff * update pyi * readd the getattr * raise if log_level is wrong type * silly goose, loglevel is a subclass of str * i don't believe this code * add guard --------- Co-authored-by: Khaleel Al-Adhami <khaleel.aladhami@gmail.com>
802 lines
39 KiB
Python
802 lines
39 KiB
Python
"""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, 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 BASE_STATE, 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: 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, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = 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]], bool, int, str]] = None,
|
|
accept_charset: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
action: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
auto_complete: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
enc_type: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
method: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
name: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
no_validate: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
target: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = 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]], bool, int, str]] = None,
|
|
auto_capitalize: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
content_editable: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
context_menu: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
enter_key_hint: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
title: Optional[Union[Var[Union[bool, int, str]], bool, int, 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, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_clear_server_errors: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_submit: Optional[
|
|
Union[
|
|
Union[
|
|
EventType[[], BASE_STATE], EventType[[dict[str, Any]], BASE_STATE]
|
|
],
|
|
Union[
|
|
EventType[[], BASE_STATE], EventType[[dict[str, str]], BASE_STATE]
|
|
],
|
|
]
|
|
] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = 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: Optional[Union[Var[str], str]] = None,
|
|
server_invalid: Optional[Union[Var[bool], bool]] = None,
|
|
as_child: Optional[Union[Var[bool], bool]] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = 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[Var, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = 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[Var, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = 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[
|
|
Literal[
|
|
"badInput",
|
|
"patternMismatch",
|
|
"rangeOverflow",
|
|
"rangeUnderflow",
|
|
"stepMismatch",
|
|
"tooLong",
|
|
"tooShort",
|
|
"typeMismatch",
|
|
"valid",
|
|
"valueMissing",
|
|
],
|
|
Var[
|
|
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[Var, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = 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[Var, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = 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[Var, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = 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]], bool, int, str]] = None,
|
|
accept_charset: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
action: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
auto_complete: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
enc_type: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
method: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
name: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
no_validate: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
target: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = 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]], bool, int, str]] = None,
|
|
auto_capitalize: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
content_editable: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
context_menu: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
enter_key_hint: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
title: Optional[Union[Var[Union[bool, int, str]], bool, int, 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, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_clear_server_errors: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_submit: Optional[
|
|
Union[
|
|
Union[
|
|
EventType[[], BASE_STATE], EventType[[dict[str, Any]], BASE_STATE]
|
|
],
|
|
Union[
|
|
EventType[[], BASE_STATE], EventType[[dict[str, str]], BASE_STATE]
|
|
],
|
|
]
|
|
] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = 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: Optional[Union[Var[bool], bool]] = None,
|
|
accept: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
accept_charset: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
action: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
auto_complete: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
enc_type: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
method: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
name: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
no_validate: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
target: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = 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]], bool, int, str]] = None,
|
|
auto_capitalize: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
content_editable: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
context_menu: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
enter_key_hint: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
title: Optional[Union[Var[Union[bool, int, str]], bool, int, 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, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_clear_server_errors: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_submit: Optional[
|
|
Union[
|
|
Union[
|
|
EventType[[], BASE_STATE], EventType[[dict[str, Any]], BASE_STATE]
|
|
],
|
|
Union[
|
|
EventType[[], BASE_STATE], EventType[[dict[str, str]], BASE_STATE]
|
|
],
|
|
]
|
|
] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = 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()
|