1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507 |
- """Stub file for reflex/components/el/elements/forms.py"""
- # ------------------- DO NOT EDIT ----------------------
- # This file was generated by `reflex/utils/pyi_generator.py`!
- # ------------------------------------------------------
- from typing import Any, Dict, Optional, Tuple, Union, overload
- from jinja2 import Environment
- from reflex.components.el.element import Element
- from reflex.event import BASE_STATE, EventType, KeyInputInfo
- from reflex.style import Style
- from reflex.utils.imports import ImportDict
- from reflex.vars.base import Var
- from .base import BaseHTML
- FORM_DATA = Var(_js_expr="form_data")
- HANDLE_SUBMIT_JS_JINJA2 = Environment().from_string(
- "\n const handleSubmit_{{ handle_submit_unique_name }} = useCallback((ev) => {\n const $form = ev.target\n ev.preventDefault()\n const {{ form_data }} = {...Object.fromEntries(new FormData($form).entries()), ...{{ field_ref_mapping }}};\n\n ({{ on_submit_event_chain }}());\n\n if ({{ reset_on_submit }}) {\n $form.reset()\n }\n })\n "
- )
- class Button(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- auto_focus: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- disabled: Optional[Union[Var[bool], bool]] = None,
- form: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- form_action: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- form_enc_type: Optional[
- Union[Var[Union[bool, int, str]], bool, int, str]
- ] = None,
- form_method: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- form_no_validate: Optional[
- Union[Var[Union[bool, int, str]], bool, int, str]
- ] = None,
- form_target: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- name: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- type: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- value: Optional[Union[Var[Union[bool, int, str]], bool, int, 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_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,
- ) -> "Button":
- """Create the component.
- Args:
- *children: The children of the component.
- auto_focus: Automatically focuses the button when the page loads
- disabled: Disables the button
- form: Associates the button with a form (by id)
- form_action: URL to send the form data to (for type="submit" buttons)
- form_enc_type: How the form data should be encoded when submitting to the server (for type="submit" buttons)
- form_method: HTTP method to use for sending form data (for type="submit" buttons)
- form_no_validate: Bypasses form validation when submitting (for type="submit" buttons)
- form_target: Specifies where to display the response after submitting the form (for type="submit" buttons)
- name: Name of the button, used when sending form data
- type: Type of the button (submit, reset, or button)
- value: Value of the button, used when sending form data
- 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 props of the component.
- Returns:
- The component.
- """
- ...
- class Datalist(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- 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_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,
- ) -> "Datalist":
- """Create the component.
- Args:
- *children: The children of the component.
- 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 props of the component.
- Returns:
- The component.
- """
- ...
- class Fieldset(Element):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- disabled: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- form: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- name: 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_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,
- ) -> "Fieldset":
- """Create the component.
- Args:
- *children: The children of the component.
- disabled: Disables all the form control descendants of the fieldset
- form: Associates the fieldset with a form (by id)
- name: Name of the fieldset, used for scripting
- 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.
- """
- ...
- def on_submit_event_spec() -> Tuple[Var[dict[str, Any]]]: ...
- def on_submit_string_event_spec() -> Tuple[Var[dict[str, str]]]: ...
- class Form(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- 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_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.
- 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.
- """
- ...
- def add_imports(self) -> ImportDict: ...
- def add_hooks(self) -> list[str]: ...
- class Input(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- accept: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- alt: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- auto_complete: Optional[
- Union[Var[Union[bool, int, str]], bool, int, str]
- ] = None,
- auto_focus: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- capture: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- checked: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- default_checked: Optional[Union[Var[bool], bool]] = None,
- default_value: Optional[Union[Var[str], str]] = None,
- dirname: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- disabled: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- form: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- form_action: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- form_enc_type: Optional[
- Union[Var[Union[bool, int, str]], bool, int, str]
- ] = None,
- form_method: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- form_no_validate: Optional[
- Union[Var[Union[bool, int, str]], bool, int, str]
- ] = None,
- form_target: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- list: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- max: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- max_length: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- min_length: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- min: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- multiple: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- name: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- pattern: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- placeholder: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- read_only: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- required: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- size: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- src: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- step: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- type: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- use_map: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- value: Optional[Union[Var[Union[float, int, str]], float, int, 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[
- Union[EventType[[], BASE_STATE], EventType[[str], BASE_STATE]]
- ] = None,
- on_change: Optional[
- Union[EventType[[], BASE_STATE], EventType[[str], 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[
- Union[EventType[[], BASE_STATE], EventType[[str], BASE_STATE]]
- ] = None,
- on_key_down: Optional[
- Union[
- EventType[[], BASE_STATE],
- EventType[[str], BASE_STATE],
- EventType[[str, KeyInputInfo], BASE_STATE],
- ]
- ] = None,
- on_key_up: Optional[
- Union[
- EventType[[], BASE_STATE],
- EventType[[str], BASE_STATE],
- EventType[[str, KeyInputInfo], 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,
- ) -> "Input":
- """Create an Input component.
- Args:
- *children: The children of the component.
- accept: Accepted types of files when the input is file type
- alt: Alternate text for input type="image"
- auto_complete: Whether the input should have autocomplete enabled
- auto_focus: Automatically focuses the input when the page loads
- capture: Captures media from the user (camera or microphone)
- checked: Indicates whether the input is checked (for checkboxes and radio buttons)
- default_checked: The initial value (for checkboxes and radio buttons)
- default_value: The initial value for a text field
- dirname: Name part of the input to submit in 'dir' and 'name' pair when form is submitted
- disabled: Disables the input
- form: Associates the input with a form (by id)
- form_action: URL to send the form data to (for type="submit" buttons)
- form_enc_type: How the form data should be encoded when submitting to the server (for type="submit" buttons)
- form_method: HTTP method to use for sending form data (for type="submit" buttons)
- form_no_validate: Bypasses form validation when submitting (for type="submit" buttons)
- form_target: Specifies where to display the response after submitting the form (for type="submit" buttons)
- list: References a datalist for suggested options
- max: Specifies the maximum value for the input
- max_length: Specifies the maximum number of characters allowed in the input
- min_length: Specifies the minimum number of characters required in the input
- min: Specifies the minimum value for the input
- multiple: Indicates whether multiple values can be entered in an input of the type email or file
- name: Name of the input, used when sending form data
- pattern: Regex pattern the input's value must match to be valid
- placeholder: Placeholder text in the input
- read_only: Indicates whether the input is read-only
- required: Indicates that the input is required
- size: Specifies the visible width of a text control
- src: URL for image inputs
- step: Specifies the legal number intervals for an input
- type: Specifies the type of input
- use_map: Name of the image map used with the input
- value: Value of the input
- on_change: Fired when the input value changes
- on_focus: Fired when the input gains focus
- on_blur: Fired when the input loses focus
- on_key_down: Fired when a key is pressed down
- on_key_up: Fired when a key is released
- 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 component.
- Returns:
- The component.
- """
- ...
- class Label(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- html_for: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- form: Optional[Union[Var[Union[bool, int, str]], bool, int, 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_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,
- ) -> "Label":
- """Create the component.
- Args:
- *children: The children of the component.
- html_for: ID of a form control with which the label is associated
- form: Associates the label with a form (by id)
- 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 props of the component.
- Returns:
- The component.
- """
- ...
- class Legend(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- 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_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,
- ) -> "Legend":
- """Create the component.
- Args:
- *children: The children of the component.
- 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 props of the component.
- Returns:
- The component.
- """
- ...
- class Meter(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- form: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- high: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- low: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- max: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- min: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- optimum: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- value: Optional[Union[Var[Union[bool, int, str]], bool, int, 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_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,
- ) -> "Meter":
- """Create the component.
- Args:
- *children: The children of the component.
- form: Associates the meter with a form (by id)
- high: High limit of range (above this is considered high value)
- low: Low limit of range (below this is considered low value)
- max: Maximum value of the range
- min: Minimum value of the range
- optimum: Optimum value in the range
- value: Current value of the meter
- 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 props of the component.
- Returns:
- The component.
- """
- ...
- class Optgroup(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- disabled: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- label: Optional[Union[Var[Union[bool, int, str]], bool, int, 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_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,
- ) -> "Optgroup":
- """Create the component.
- Args:
- *children: The children of the component.
- disabled: Disables the optgroup
- label: Label for the optgroup
- 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 props of the component.
- Returns:
- The component.
- """
- ...
- class Option(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- disabled: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- label: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- selected: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- value: Optional[Union[Var[Union[bool, int, str]], bool, int, 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_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,
- ) -> "Option":
- """Create the component.
- Args:
- *children: The children of the component.
- disabled: Disables the option
- label: Label for the option, if the text is not the label
- selected: Indicates that the option is initially selected
- value: Value to be sent as form data
- 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 props of the component.
- Returns:
- The component.
- """
- ...
- class Output(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- html_for: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- form: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- name: Optional[Union[Var[Union[bool, int, str]], bool, int, 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_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,
- ) -> "Output":
- """Create the component.
- Args:
- *children: The children of the component.
- html_for: Associates the output with one or more elements (by their IDs)
- form: Associates the output with a form (by id)
- name: Name of the output element for form submission
- 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 props of the component.
- Returns:
- The component.
- """
- ...
- class Progress(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- form: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- max: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- value: Optional[Union[Var[Union[bool, int, str]], bool, int, 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_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,
- ) -> "Progress":
- """Create the component.
- Args:
- *children: The children of the component.
- form: Associates the progress element with a form (by id)
- max: Maximum value of the progress indicator
- value: Current value of the progress indicator
- 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 props of the component.
- Returns:
- The component.
- """
- ...
- class Select(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- auto_complete: Optional[
- Union[Var[Union[bool, int, str]], bool, int, str]
- ] = None,
- auto_focus: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- disabled: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- form: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- multiple: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- name: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- required: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- size: Optional[Union[Var[Union[bool, int, str]], bool, int, 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_change: Optional[
- Union[EventType[[], BASE_STATE], EventType[[str], 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,
- ) -> "Select":
- """Create the component.
- Args:
- *children: The children of the component.
- auto_complete: Whether the form control should have autocomplete enabled
- auto_focus: Automatically focuses the select when the page loads
- disabled: Disables the select control
- form: Associates the select with a form (by id)
- multiple: Indicates that multiple options can be selected
- name: Name of the select, used when submitting the form
- required: Indicates that the select control must have a selected option
- size: Number of visible options in a drop-down list
- on_change: Fired when the select value changes
- 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 props of the component.
- Returns:
- The component.
- """
- ...
- AUTO_HEIGHT_JS = '\nconst autoHeightOnInput = (e, is_enabled) => {\n if (is_enabled) {\n const el = e.target;\n el.style.overflowY = "scroll";\n el.style.height = "auto";\n el.style.height = (e.target.scrollHeight) + "px";\n if (el.form && !el.form.data_resize_on_reset) {\n el.form.addEventListener("reset", () => window.setTimeout(() => autoHeightOnInput(e, is_enabled), 0))\n el.form.data_resize_on_reset = true;\n }\n }\n}\n'
- ENTER_KEY_SUBMIT_JS = "\nconst enterKeySubmitOnKeyDown = (e, is_enabled) => {\n if (is_enabled && e.which === 13 && !e.shiftKey) {\n e.preventDefault();\n if (!e.repeat) {\n if (e.target.form) {\n e.target.form.requestSubmit();\n }\n }\n }\n}\n"
- class Textarea(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- auto_complete: Optional[
- Union[Var[Union[bool, int, str]], bool, int, str]
- ] = None,
- auto_focus: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- auto_height: Optional[Union[Var[bool], bool]] = None,
- cols: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- default_value: Optional[Union[Var[str], str]] = None,
- dirname: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- disabled: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- enter_key_submit: Optional[Union[Var[bool], bool]] = None,
- form: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- max_length: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- min_length: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- name: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- placeholder: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- read_only: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- required: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- rows: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- value: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
- wrap: Optional[Union[Var[Union[bool, int, str]], bool, int, 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[
- Union[EventType[[], BASE_STATE], EventType[[str], BASE_STATE]]
- ] = None,
- on_change: Optional[
- Union[EventType[[], BASE_STATE], EventType[[str], 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[
- Union[EventType[[], BASE_STATE], EventType[[str], BASE_STATE]]
- ] = None,
- on_key_down: Optional[
- Union[
- EventType[[], BASE_STATE],
- EventType[[str], BASE_STATE],
- EventType[[str, KeyInputInfo], BASE_STATE],
- ]
- ] = None,
- on_key_up: Optional[
- Union[
- EventType[[], BASE_STATE],
- EventType[[str], BASE_STATE],
- EventType[[str, KeyInputInfo], 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,
- ) -> "Textarea":
- """Create a textarea component.
- Args:
- *children: The children of the textarea.
- auto_complete: Whether the form control should have autocomplete enabled
- auto_focus: Automatically focuses the textarea when the page loads
- auto_height: Automatically fit the content height to the text (use min-height with this prop)
- cols: Visible width of the text control, in average character widths
- default_value: The default value of the textarea when initially rendered
- dirname: Name part of the textarea to submit in 'dir' and 'name' pair when form is submitted
- disabled: Disables the textarea
- enter_key_submit: Enter key submits form (shift-enter adds new line)
- form: Associates the textarea with a form (by id)
- max_length: Maximum number of characters allowed in the textarea
- min_length: Minimum number of characters required in the textarea
- name: Name of the textarea, used when submitting the form
- placeholder: Placeholder text in the textarea
- read_only: Indicates whether the textarea is read-only
- required: Indicates that the textarea is required
- rows: Visible number of lines in the text control
- value: The controlled value of the textarea, read only unless used with on_change
- wrap: How the text in the textarea is to be wrapped when submitting the form
- on_change: Fired when the input value changes
- on_focus: Fired when the input gains focus
- on_blur: Fired when the input loses focus
- on_key_down: Fired when a key is pressed down
- on_key_up: Fired when a key is released
- 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 textarea.
- Returns:
- The textarea component.
- Raises:
- ValueError: when `enter_key_submit` is combined with `on_key_down`.
- """
- ...
- button = Button.create
- datalist = Datalist.create
- fieldset = Fieldset.create
- form = Form.create
- input = Input.create
- label = Label.create
- legend = Legend.create
- meter = Meter.create
- optgroup = Optgroup.create
- option = Option.create
- output = Output.create
- progress = Progress.create
- select = Select.create
- textarea = Textarea.create
|