12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533 |
- """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, Literal, Optional, Union, overload
- from jinja2 import Environment
- from reflex.components.el.element import Element
- from reflex.event import 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 }}(ev));\n\n if ({{ reset_on_submit }}) {\n $form.reset()\n }\n })\n "
- )
- ButtonType = Literal["submit", "reset", "button"]
- class Button(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- auto_focus: Var[bool] | bool | None = None,
- disabled: Var[bool] | bool | None = None,
- form: Var[str] | str | None = None,
- form_action: Var[str] | str | None = None,
- form_enc_type: Var[str] | str | None = None,
- form_method: Var[str] | str | None = None,
- form_no_validate: Var[bool] | bool | None = None,
- form_target: Var[str] | str | None = None,
- name: Var[str] | str | None = None,
- type: Literal["button", "reset", "submit"]
- | Var[Literal["button", "reset", "submit"]]
- | None = None,
- value: Var[float | int | str] | float | int | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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: Var[bool] | bool | None = None,
- form: Var[str] | str | None = None,
- name: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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: Var[str] | str | None = None,
- accept_charset: Var[str] | str | None = None,
- action: Var[str] | str | None = None,
- auto_complete: Var[str] | str | None = None,
- enc_type: Var[str] | str | None = None,
- method: Var[str] | str | None = None,
- name: Var[str] | str | None = None,
- no_validate: Var[bool] | bool | None = None,
- target: Var[str] | str | None = None,
- reset_on_submit: Var[bool] | bool | None = None,
- handle_submit_unique_name: Var[str] | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_submit: Optional[
- Union[
- EventType[()] | EventType[dict[str, Any]],
- EventType[()] | EventType[dict[str, str]],
- ]
- ] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "Form":
- """Create a form component.
- Args:
- *children: The children of the form.
- 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]: ...
- HTMLInputTypeAttribute = Literal[
- "button",
- "checkbox",
- "color",
- "date",
- "datetime-local",
- "email",
- "file",
- "hidden",
- "image",
- "month",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "tel",
- "text",
- "time",
- "url",
- "week",
- ]
- class Input(BaseHTML):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- accept: Var[str] | str | None = None,
- alt: Var[str] | str | None = None,
- auto_complete: Var[str] | str | None = None,
- auto_focus: Var[bool] | bool | None = None,
- capture: Literal["environment", "user", False, True]
- | Var[Literal["environment", "user", False, True]]
- | None = None,
- checked: Var[bool] | bool | None = None,
- default_checked: Var[bool] | bool | None = None,
- default_value: Var[float | int | str] | float | int | str | None = None,
- disabled: Var[bool] | bool | None = None,
- form: Var[str] | str | None = None,
- form_action: Var[str] | str | None = None,
- form_enc_type: Var[str] | str | None = None,
- form_method: Var[str] | str | None = None,
- form_no_validate: Var[bool] | bool | None = None,
- form_target: Var[str] | str | None = None,
- list: Var[str] | str | None = None,
- max: Var[float | int | str] | float | int | str | None = None,
- max_length: Var[float | int] | float | int | None = None,
- min_length: Var[float | int] | float | int | None = None,
- min: Var[float | int | str] | float | int | str | None = None,
- multiple: Var[bool] | bool | None = None,
- name: Var[str] | str | None = None,
- pattern: Var[str] | str | None = None,
- placeholder: Var[str] | str | None = None,
- read_only: Var[bool] | bool | None = None,
- required: Var[bool] | bool | None = None,
- size: Var[float | int] | float | int | None = None,
- src: Var[str] | str | None = None,
- step: Var[float | int | str] | float | int | str | None = None,
- type: Literal[
- "button",
- "checkbox",
- "color",
- "date",
- "datetime-local",
- "email",
- "file",
- "hidden",
- "image",
- "month",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "tel",
- "text",
- "time",
- "url",
- "week",
- ]
- | Var[
- Literal[
- "button",
- "checkbox",
- "color",
- "date",
- "datetime-local",
- "email",
- "file",
- "hidden",
- "image",
- "month",
- "number",
- "password",
- "radio",
- "range",
- "reset",
- "search",
- "submit",
- "tel",
- "text",
- "time",
- "url",
- "week",
- ]
- ]
- | None = None,
- value: Var[float | int | str] | float | int | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()] | EventType[str]] = None,
- on_change: Optional[EventType[()] | EventType[str]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()] | EventType[str]] = None,
- on_key_down: Optional[
- EventType[()] | EventType[str] | EventType[str, KeyInputInfo]
- ] = None,
- on_key_up: Optional[
- EventType[()] | EventType[str] | EventType[str, KeyInputInfo]
- ] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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
- 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
- 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: Var[str] | str | None = None,
- form: Var[str] | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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: Var[str] | str | None = None,
- high: Var[float | int] | float | int | None = None,
- low: Var[float | int] | float | int | None = None,
- max: Var[float | int] | float | int | None = None,
- min: Var[float | int] | float | int | None = None,
- optimum: Var[float | int] | float | int | None = None,
- value: Var[float | int] | float | int | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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: Var[bool] | bool | None = None,
- label: Var[str] | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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: Var[bool] | bool | None = None,
- label: Var[str] | str | None = None,
- selected: Var[bool] | bool | None = None,
- value: Var[float | int | str] | float | int | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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: Var[str] | str | None = None,
- form: Var[str] | str | None = None,
- name: Var[str] | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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: Var[str] | str | None = None,
- max: Var[float | int | str] | float | int | str | None = None,
- value: Var[float | int | str] | float | int | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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: Var[str] | str | None = None,
- auto_focus: Var[bool] | bool | None = None,
- disabled: Var[bool] | bool | None = None,
- form: Var[str] | str | None = None,
- multiple: Var[bool] | bool | None = None,
- name: Var[str] | str | None = None,
- required: Var[bool] | bool | None = None,
- size: Var[int] | int | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()]] = None,
- on_change: Optional[EventType[()] | EventType[str]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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: Var[str] | str | None = None,
- auto_focus: Var[bool] | bool | None = None,
- auto_height: Var[bool] | bool | None = None,
- cols: Var[int] | int | None = None,
- default_value: Var[str] | str | None = None,
- dirname: Var[str] | str | None = None,
- disabled: Var[bool] | bool | None = None,
- enter_key_submit: Var[bool] | bool | None = None,
- form: Var[str] | str | None = None,
- max_length: Var[int] | int | None = None,
- min_length: Var[int] | int | None = None,
- name: Var[str] | str | None = None,
- placeholder: Var[str] | str | None = None,
- read_only: Var[bool] | bool | None = None,
- required: Var[bool] | bool | None = None,
- rows: Var[int] | int | None = None,
- value: Var[str] | str | None = None,
- wrap: Var[str] | str | None = None,
- access_key: Var[str] | str | None = None,
- auto_capitalize: Literal[
- "characters", "none", "off", "on", "sentences", "words"
- ]
- | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
- | None = None,
- content_editable: Literal["inherit", "plaintext-only", False, True]
- | Var[Literal["inherit", "plaintext-only", False, True]]
- | None = None,
- context_menu: Var[str] | str | None = None,
- dir: Var[str] | str | None = None,
- draggable: Var[bool] | bool | None = None,
- enter_key_hint: Literal[
- "done", "enter", "go", "next", "previous", "search", "send"
- ]
- | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
- | None = None,
- hidden: Var[bool] | bool | None = None,
- input_mode: Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- | Var[
- Literal[
- "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
- ]
- ]
- | None = None,
- item_prop: Var[str] | str | None = None,
- lang: Var[str] | str | None = None,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- | Var[
- Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "button",
- "cell",
- "checkbox",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "dialog",
- "directory",
- "document",
- "feed",
- "figure",
- "form",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "navigation",
- "none",
- "note",
- "option",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ]
- ]
- | None = None,
- slot: Var[str] | str | None = None,
- spell_check: Var[bool] | bool | None = None,
- tab_index: Var[int] | int | None = None,
- title: Var[str] | str | None = None,
- style: Style | None = None,
- key: Any | None = None,
- id: Any | None = None,
- class_name: Any | None = None,
- autofocus: bool | None = None,
- custom_attrs: dict[str, Var | Any] | None = None,
- on_blur: Optional[EventType[()] | EventType[str]] = None,
- on_change: Optional[EventType[()] | EventType[str]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()] | EventType[str]] = None,
- on_key_down: Optional[
- EventType[()] | EventType[str] | EventType[str, KeyInputInfo]
- ] = None,
- on_key_up: Optional[
- EventType[()] | EventType[str] | EventType[str, KeyInputInfo]
- ] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "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
|