forms.pyi 97 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195
  1. """Stub file for reflex/components/el/elements/forms.py"""
  2. # ------------------- DO NOT EDIT ----------------------
  3. # This file was generated by `reflex/utils/pyi_generator.py`!
  4. # ------------------------------------------------------
  5. from typing import Any, Dict, Literal, Optional, Union, overload
  6. from reflex.vars import Var, BaseVar, ComputedVar
  7. from reflex.event import EventChain, EventHandler, EventSpec
  8. from reflex.style import Style
  9. from hashlib import md5
  10. from typing import Any, Dict, Iterator, Set, Union
  11. from jinja2 import Environment
  12. from reflex.components.el.element import Element
  13. from reflex.components.tags.tag import Tag
  14. from reflex.constants import Dirs, EventTriggers
  15. from reflex.event import EventChain, EventHandler
  16. from reflex.utils.format import format_event_chain
  17. from reflex.utils.imports import ImportDict
  18. from reflex.vars import BaseVar, Var
  19. from .base import BaseHTML
  20. FORM_DATA = Var.create("form_data", _var_is_string=False)
  21. HANDLE_SUBMIT_JS_JINJA2 = Environment().from_string(
  22. "\n const handleSubmit_{{ handle_submit_unique_name }} = useCallback((ev) => {\n const $form = ev.target\n ev.preventDefault()\n const {{ form_data }} = {...Object.fromEntries(new FormData($form).entries()), ...{{ field_ref_mapping }}}\n\n {{ on_submit_event_chain }}\n\n if ({{ reset_on_submit }}) {\n $form.reset()\n }\n })\n "
  23. )
  24. class Button(BaseHTML):
  25. @overload
  26. @classmethod
  27. def create( # type: ignore
  28. cls,
  29. *children,
  30. auto_focus: Optional[
  31. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  32. ] = None,
  33. disabled: Optional[Union[Var[bool], bool]] = None,
  34. form: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  35. form_action: Optional[
  36. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  37. ] = None,
  38. form_enc_type: Optional[
  39. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  40. ] = None,
  41. form_method: Optional[
  42. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  43. ] = None,
  44. form_no_validate: Optional[
  45. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  46. ] = None,
  47. form_target: Optional[
  48. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  49. ] = None,
  50. name: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  51. type: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  52. value: Optional[
  53. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  54. ] = None,
  55. access_key: Optional[
  56. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  57. ] = None,
  58. auto_capitalize: Optional[
  59. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  60. ] = None,
  61. content_editable: Optional[
  62. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  63. ] = None,
  64. context_menu: Optional[
  65. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  66. ] = None,
  67. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  68. draggable: Optional[
  69. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  70. ] = None,
  71. enter_key_hint: Optional[
  72. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  73. ] = None,
  74. hidden: Optional[
  75. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  76. ] = None,
  77. input_mode: Optional[
  78. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  79. ] = None,
  80. item_prop: Optional[
  81. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  82. ] = None,
  83. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  84. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  85. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  86. spell_check: Optional[
  87. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  88. ] = None,
  89. tab_index: Optional[
  90. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  91. ] = None,
  92. title: Optional[
  93. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  94. ] = None,
  95. style: Optional[Style] = None,
  96. key: Optional[Any] = None,
  97. id: Optional[Any] = None,
  98. class_name: Optional[Any] = None,
  99. autofocus: Optional[bool] = None,
  100. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  101. on_blur: Optional[
  102. Union[EventHandler, EventSpec, list, function, BaseVar]
  103. ] = None,
  104. on_click: Optional[
  105. Union[EventHandler, EventSpec, list, function, BaseVar]
  106. ] = None,
  107. on_context_menu: Optional[
  108. Union[EventHandler, EventSpec, list, function, BaseVar]
  109. ] = None,
  110. on_double_click: Optional[
  111. Union[EventHandler, EventSpec, list, function, BaseVar]
  112. ] = None,
  113. on_focus: Optional[
  114. Union[EventHandler, EventSpec, list, function, BaseVar]
  115. ] = None,
  116. on_mount: Optional[
  117. Union[EventHandler, EventSpec, list, function, BaseVar]
  118. ] = None,
  119. on_mouse_down: Optional[
  120. Union[EventHandler, EventSpec, list, function, BaseVar]
  121. ] = None,
  122. on_mouse_enter: Optional[
  123. Union[EventHandler, EventSpec, list, function, BaseVar]
  124. ] = None,
  125. on_mouse_leave: Optional[
  126. Union[EventHandler, EventSpec, list, function, BaseVar]
  127. ] = None,
  128. on_mouse_move: Optional[
  129. Union[EventHandler, EventSpec, list, function, BaseVar]
  130. ] = None,
  131. on_mouse_out: Optional[
  132. Union[EventHandler, EventSpec, list, function, BaseVar]
  133. ] = None,
  134. on_mouse_over: Optional[
  135. Union[EventHandler, EventSpec, list, function, BaseVar]
  136. ] = None,
  137. on_mouse_up: Optional[
  138. Union[EventHandler, EventSpec, list, function, BaseVar]
  139. ] = None,
  140. on_scroll: Optional[
  141. Union[EventHandler, EventSpec, list, function, BaseVar]
  142. ] = None,
  143. on_unmount: Optional[
  144. Union[EventHandler, EventSpec, list, function, BaseVar]
  145. ] = None,
  146. **props
  147. ) -> "Button":
  148. """Create the component.
  149. Args:
  150. *children: The children of the component.
  151. auto_focus: Automatically focuses the button when the page loads
  152. disabled: Disables the button
  153. form: Associates the button with a form (by id)
  154. form_action: URL to send the form data to (for type="submit" buttons)
  155. form_enc_type: How the form data should be encoded when submitting to the server (for type="submit" buttons)
  156. form_method: HTTP method to use for sending form data (for type="submit" buttons)
  157. form_no_validate: Bypasses form validation when submitting (for type="submit" buttons)
  158. form_target: Specifies where to display the response after submitting the form (for type="submit" buttons)
  159. name: Name of the button, used when sending form data
  160. type: Type of the button (submit, reset, or button)
  161. value: Value of the button, used when sending form data
  162. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  163. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  164. content_editable: Indicates whether the element's content is editable.
  165. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  166. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  167. draggable: Defines whether the element can be dragged.
  168. enter_key_hint: Hints what media types the media element is able to play.
  169. hidden: Defines whether the element is hidden.
  170. input_mode: Defines the type of the element.
  171. item_prop: Defines the name of the element for metadata purposes.
  172. lang: Defines the language used in the element.
  173. role: Defines the role of the element.
  174. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  175. spell_check: Defines whether the element may be checked for spelling errors.
  176. tab_index: Defines the position of the current element in the tabbing order.
  177. title: Defines a tooltip for the element.
  178. style: The style of the component.
  179. key: A unique key for the component.
  180. id: The id for the component.
  181. class_name: The class name for the component.
  182. autofocus: Whether the component should take the focus once the page is loaded
  183. custom_attrs: custom attribute
  184. **props: The props of the component.
  185. Returns:
  186. The component.
  187. """
  188. ...
  189. class Datalist(BaseHTML):
  190. @overload
  191. @classmethod
  192. def create( # type: ignore
  193. cls,
  194. *children,
  195. access_key: Optional[
  196. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  197. ] = None,
  198. auto_capitalize: Optional[
  199. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  200. ] = None,
  201. content_editable: Optional[
  202. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  203. ] = None,
  204. context_menu: Optional[
  205. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  206. ] = None,
  207. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  208. draggable: Optional[
  209. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  210. ] = None,
  211. enter_key_hint: Optional[
  212. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  213. ] = None,
  214. hidden: Optional[
  215. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  216. ] = None,
  217. input_mode: Optional[
  218. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  219. ] = None,
  220. item_prop: Optional[
  221. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  222. ] = None,
  223. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  224. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  225. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  226. spell_check: Optional[
  227. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  228. ] = None,
  229. tab_index: Optional[
  230. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  231. ] = None,
  232. title: Optional[
  233. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  234. ] = None,
  235. style: Optional[Style] = None,
  236. key: Optional[Any] = None,
  237. id: Optional[Any] = None,
  238. class_name: Optional[Any] = None,
  239. autofocus: Optional[bool] = None,
  240. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  241. on_blur: Optional[
  242. Union[EventHandler, EventSpec, list, function, BaseVar]
  243. ] = None,
  244. on_click: Optional[
  245. Union[EventHandler, EventSpec, list, function, BaseVar]
  246. ] = None,
  247. on_context_menu: Optional[
  248. Union[EventHandler, EventSpec, list, function, BaseVar]
  249. ] = None,
  250. on_double_click: Optional[
  251. Union[EventHandler, EventSpec, list, function, BaseVar]
  252. ] = None,
  253. on_focus: Optional[
  254. Union[EventHandler, EventSpec, list, function, BaseVar]
  255. ] = None,
  256. on_mount: Optional[
  257. Union[EventHandler, EventSpec, list, function, BaseVar]
  258. ] = None,
  259. on_mouse_down: Optional[
  260. Union[EventHandler, EventSpec, list, function, BaseVar]
  261. ] = None,
  262. on_mouse_enter: Optional[
  263. Union[EventHandler, EventSpec, list, function, BaseVar]
  264. ] = None,
  265. on_mouse_leave: Optional[
  266. Union[EventHandler, EventSpec, list, function, BaseVar]
  267. ] = None,
  268. on_mouse_move: Optional[
  269. Union[EventHandler, EventSpec, list, function, BaseVar]
  270. ] = None,
  271. on_mouse_out: Optional[
  272. Union[EventHandler, EventSpec, list, function, BaseVar]
  273. ] = None,
  274. on_mouse_over: Optional[
  275. Union[EventHandler, EventSpec, list, function, BaseVar]
  276. ] = None,
  277. on_mouse_up: Optional[
  278. Union[EventHandler, EventSpec, list, function, BaseVar]
  279. ] = None,
  280. on_scroll: Optional[
  281. Union[EventHandler, EventSpec, list, function, BaseVar]
  282. ] = None,
  283. on_unmount: Optional[
  284. Union[EventHandler, EventSpec, list, function, BaseVar]
  285. ] = None,
  286. **props
  287. ) -> "Datalist":
  288. """Create the component.
  289. Args:
  290. *children: The children of the component.
  291. access_key: No unique attributes, only common ones are inherited Provides a hint for generating a keyboard shortcut for the current element.
  292. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  293. content_editable: Indicates whether the element's content is editable.
  294. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  295. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  296. draggable: Defines whether the element can be dragged.
  297. enter_key_hint: Hints what media types the media element is able to play.
  298. hidden: Defines whether the element is hidden.
  299. input_mode: Defines the type of the element.
  300. item_prop: Defines the name of the element for metadata purposes.
  301. lang: Defines the language used in the element.
  302. role: Defines the role of the element.
  303. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  304. spell_check: Defines whether the element may be checked for spelling errors.
  305. tab_index: Defines the position of the current element in the tabbing order.
  306. title: Defines a tooltip for the element.
  307. style: The style of the component.
  308. key: A unique key for the component.
  309. id: The id for the component.
  310. class_name: The class name for the component.
  311. autofocus: Whether the component should take the focus once the page is loaded
  312. custom_attrs: custom attribute
  313. **props: The props of the component.
  314. Returns:
  315. The component.
  316. """
  317. ...
  318. class Fieldset(Element):
  319. @overload
  320. @classmethod
  321. def create( # type: ignore
  322. cls,
  323. *children,
  324. disabled: Optional[
  325. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  326. ] = None,
  327. form: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  328. name: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  329. style: Optional[Style] = None,
  330. key: Optional[Any] = None,
  331. id: Optional[Any] = None,
  332. class_name: Optional[Any] = None,
  333. autofocus: Optional[bool] = None,
  334. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  335. on_blur: Optional[
  336. Union[EventHandler, EventSpec, list, function, BaseVar]
  337. ] = None,
  338. on_click: Optional[
  339. Union[EventHandler, EventSpec, list, function, BaseVar]
  340. ] = None,
  341. on_context_menu: Optional[
  342. Union[EventHandler, EventSpec, list, function, BaseVar]
  343. ] = None,
  344. on_double_click: Optional[
  345. Union[EventHandler, EventSpec, list, function, BaseVar]
  346. ] = None,
  347. on_focus: Optional[
  348. Union[EventHandler, EventSpec, list, function, BaseVar]
  349. ] = None,
  350. on_mount: Optional[
  351. Union[EventHandler, EventSpec, list, function, BaseVar]
  352. ] = None,
  353. on_mouse_down: Optional[
  354. Union[EventHandler, EventSpec, list, function, BaseVar]
  355. ] = None,
  356. on_mouse_enter: Optional[
  357. Union[EventHandler, EventSpec, list, function, BaseVar]
  358. ] = None,
  359. on_mouse_leave: Optional[
  360. Union[EventHandler, EventSpec, list, function, BaseVar]
  361. ] = None,
  362. on_mouse_move: Optional[
  363. Union[EventHandler, EventSpec, list, function, BaseVar]
  364. ] = None,
  365. on_mouse_out: Optional[
  366. Union[EventHandler, EventSpec, list, function, BaseVar]
  367. ] = None,
  368. on_mouse_over: Optional[
  369. Union[EventHandler, EventSpec, list, function, BaseVar]
  370. ] = None,
  371. on_mouse_up: Optional[
  372. Union[EventHandler, EventSpec, list, function, BaseVar]
  373. ] = None,
  374. on_scroll: Optional[
  375. Union[EventHandler, EventSpec, list, function, BaseVar]
  376. ] = None,
  377. on_unmount: Optional[
  378. Union[EventHandler, EventSpec, list, function, BaseVar]
  379. ] = None,
  380. **props
  381. ) -> "Fieldset":
  382. """Create the component.
  383. Args:
  384. *children: The children of the component.
  385. disabled: Disables all the form control descendants of the fieldset
  386. form: Associates the fieldset with a form (by id)
  387. name: Name of the fieldset, used for scripting
  388. style: The style of the component.
  389. key: A unique key for the component.
  390. id: The id for the component.
  391. class_name: The class name for the component.
  392. autofocus: Whether the component should take the focus once the page is loaded
  393. custom_attrs: custom attribute
  394. **props: The props of the component.
  395. Returns:
  396. The component.
  397. """
  398. ...
  399. class Form(BaseHTML):
  400. @overload
  401. @classmethod
  402. def create( # type: ignore
  403. cls,
  404. *children,
  405. accept: Optional[
  406. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  407. ] = None,
  408. accept_charset: Optional[
  409. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  410. ] = None,
  411. action: Optional[
  412. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  413. ] = None,
  414. auto_complete: Optional[
  415. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  416. ] = None,
  417. enc_type: Optional[
  418. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  419. ] = None,
  420. method: Optional[
  421. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  422. ] = None,
  423. name: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  424. no_validate: Optional[
  425. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  426. ] = None,
  427. target: Optional[
  428. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  429. ] = None,
  430. reset_on_submit: Optional[Union[Var[bool], bool]] = None,
  431. handle_submit_unique_name: Optional[Union[Var[str], str]] = None,
  432. access_key: Optional[
  433. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  434. ] = None,
  435. auto_capitalize: Optional[
  436. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  437. ] = None,
  438. content_editable: Optional[
  439. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  440. ] = None,
  441. context_menu: Optional[
  442. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  443. ] = None,
  444. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  445. draggable: Optional[
  446. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  447. ] = None,
  448. enter_key_hint: Optional[
  449. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  450. ] = None,
  451. hidden: Optional[
  452. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  453. ] = None,
  454. input_mode: Optional[
  455. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  456. ] = None,
  457. item_prop: Optional[
  458. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  459. ] = None,
  460. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  461. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  462. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  463. spell_check: Optional[
  464. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  465. ] = None,
  466. tab_index: Optional[
  467. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  468. ] = None,
  469. title: Optional[
  470. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  471. ] = None,
  472. style: Optional[Style] = None,
  473. key: Optional[Any] = None,
  474. id: Optional[Any] = None,
  475. class_name: Optional[Any] = None,
  476. autofocus: Optional[bool] = None,
  477. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  478. on_blur: Optional[
  479. Union[EventHandler, EventSpec, list, function, BaseVar]
  480. ] = None,
  481. on_click: Optional[
  482. Union[EventHandler, EventSpec, list, function, BaseVar]
  483. ] = None,
  484. on_context_menu: Optional[
  485. Union[EventHandler, EventSpec, list, function, BaseVar]
  486. ] = None,
  487. on_double_click: Optional[
  488. Union[EventHandler, EventSpec, list, function, BaseVar]
  489. ] = None,
  490. on_focus: Optional[
  491. Union[EventHandler, EventSpec, list, function, BaseVar]
  492. ] = None,
  493. on_mount: Optional[
  494. Union[EventHandler, EventSpec, list, function, BaseVar]
  495. ] = None,
  496. on_mouse_down: Optional[
  497. Union[EventHandler, EventSpec, list, function, BaseVar]
  498. ] = None,
  499. on_mouse_enter: Optional[
  500. Union[EventHandler, EventSpec, list, function, BaseVar]
  501. ] = None,
  502. on_mouse_leave: Optional[
  503. Union[EventHandler, EventSpec, list, function, BaseVar]
  504. ] = None,
  505. on_mouse_move: Optional[
  506. Union[EventHandler, EventSpec, list, function, BaseVar]
  507. ] = None,
  508. on_mouse_out: Optional[
  509. Union[EventHandler, EventSpec, list, function, BaseVar]
  510. ] = None,
  511. on_mouse_over: Optional[
  512. Union[EventHandler, EventSpec, list, function, BaseVar]
  513. ] = None,
  514. on_mouse_up: Optional[
  515. Union[EventHandler, EventSpec, list, function, BaseVar]
  516. ] = None,
  517. on_scroll: Optional[
  518. Union[EventHandler, EventSpec, list, function, BaseVar]
  519. ] = None,
  520. on_submit: Optional[
  521. Union[EventHandler, EventSpec, list, function, BaseVar]
  522. ] = None,
  523. on_unmount: Optional[
  524. Union[EventHandler, EventSpec, list, function, BaseVar]
  525. ] = None,
  526. **props
  527. ) -> "Form":
  528. """Create a form component.
  529. Args:
  530. *children: The children of the form.
  531. accept: MIME types the server accepts for file upload
  532. accept_charset: Character encodings to be used for form submission
  533. action: URL where the form's data should be submitted
  534. auto_complete: Whether the form should have autocomplete enabled
  535. enc_type: Encoding type for the form data when submitted
  536. method: HTTP method to use for form submission
  537. name: Name of the form
  538. no_validate: Indicates that the form should not be validated on submit
  539. target: Where to display the response after submitting the form
  540. reset_on_submit: If true, the form will be cleared after submit.
  541. handle_submit_unique_name: The name used to make this form's submit handler function unique.
  542. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  543. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  544. content_editable: Indicates whether the element's content is editable.
  545. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  546. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  547. draggable: Defines whether the element can be dragged.
  548. enter_key_hint: Hints what media types the media element is able to play.
  549. hidden: Defines whether the element is hidden.
  550. input_mode: Defines the type of the element.
  551. item_prop: Defines the name of the element for metadata purposes.
  552. lang: Defines the language used in the element.
  553. role: Defines the role of the element.
  554. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  555. spell_check: Defines whether the element may be checked for spelling errors.
  556. tab_index: Defines the position of the current element in the tabbing order.
  557. title: Defines a tooltip for the element.
  558. style: The style of the component.
  559. key: A unique key for the component.
  560. id: The id for the component.
  561. class_name: The class name for the component.
  562. autofocus: Whether the component should take the focus once the page is loaded
  563. custom_attrs: custom attribute
  564. **props: The properties of the form.
  565. Returns:
  566. The form component.
  567. """
  568. ...
  569. def add_imports(self) -> ImportDict: ...
  570. def add_hooks(self) -> list[str]: ...
  571. class Input(BaseHTML):
  572. @overload
  573. @classmethod
  574. def create( # type: ignore
  575. cls,
  576. *children,
  577. accept: Optional[
  578. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  579. ] = None,
  580. alt: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  581. auto_complete: Optional[
  582. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  583. ] = None,
  584. auto_focus: Optional[
  585. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  586. ] = None,
  587. capture: Optional[
  588. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  589. ] = None,
  590. checked: Optional[
  591. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  592. ] = None,
  593. default_checked: Optional[Union[Var[bool], bool]] = None,
  594. default_value: Optional[Union[Var[str], str]] = None,
  595. dirname: Optional[
  596. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  597. ] = None,
  598. disabled: Optional[
  599. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  600. ] = None,
  601. form: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  602. form_action: Optional[
  603. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  604. ] = None,
  605. form_enc_type: Optional[
  606. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  607. ] = None,
  608. form_method: Optional[
  609. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  610. ] = None,
  611. form_no_validate: Optional[
  612. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  613. ] = None,
  614. form_target: Optional[
  615. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  616. ] = None,
  617. list: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  618. max: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  619. max_length: Optional[
  620. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  621. ] = None,
  622. min_length: Optional[
  623. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  624. ] = None,
  625. min: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  626. multiple: Optional[
  627. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  628. ] = None,
  629. name: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  630. pattern: Optional[
  631. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  632. ] = None,
  633. placeholder: Optional[
  634. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  635. ] = None,
  636. read_only: Optional[
  637. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  638. ] = None,
  639. required: Optional[
  640. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  641. ] = None,
  642. size: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  643. src: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  644. step: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  645. type: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  646. use_map: Optional[
  647. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  648. ] = None,
  649. value: Optional[
  650. Union[Var[Union[str, int, float]], Union[str, int, float]]
  651. ] = None,
  652. access_key: Optional[
  653. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  654. ] = None,
  655. auto_capitalize: Optional[
  656. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  657. ] = None,
  658. content_editable: Optional[
  659. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  660. ] = None,
  661. context_menu: Optional[
  662. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  663. ] = None,
  664. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  665. draggable: Optional[
  666. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  667. ] = None,
  668. enter_key_hint: Optional[
  669. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  670. ] = None,
  671. hidden: Optional[
  672. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  673. ] = None,
  674. input_mode: Optional[
  675. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  676. ] = None,
  677. item_prop: Optional[
  678. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  679. ] = None,
  680. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  681. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  682. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  683. spell_check: Optional[
  684. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  685. ] = None,
  686. tab_index: Optional[
  687. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  688. ] = None,
  689. title: Optional[
  690. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  691. ] = None,
  692. style: Optional[Style] = None,
  693. key: Optional[Any] = None,
  694. id: Optional[Any] = None,
  695. class_name: Optional[Any] = None,
  696. autofocus: Optional[bool] = None,
  697. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  698. on_blur: Optional[
  699. Union[EventHandler, EventSpec, list, function, BaseVar]
  700. ] = None,
  701. on_change: Optional[
  702. Union[EventHandler, EventSpec, list, function, BaseVar]
  703. ] = None,
  704. on_click: Optional[
  705. Union[EventHandler, EventSpec, list, function, BaseVar]
  706. ] = None,
  707. on_context_menu: Optional[
  708. Union[EventHandler, EventSpec, list, function, BaseVar]
  709. ] = None,
  710. on_double_click: Optional[
  711. Union[EventHandler, EventSpec, list, function, BaseVar]
  712. ] = None,
  713. on_focus: Optional[
  714. Union[EventHandler, EventSpec, list, function, BaseVar]
  715. ] = None,
  716. on_key_down: Optional[
  717. Union[EventHandler, EventSpec, list, function, BaseVar]
  718. ] = None,
  719. on_key_up: Optional[
  720. Union[EventHandler, EventSpec, list, function, BaseVar]
  721. ] = None,
  722. on_mount: Optional[
  723. Union[EventHandler, EventSpec, list, function, BaseVar]
  724. ] = None,
  725. on_mouse_down: Optional[
  726. Union[EventHandler, EventSpec, list, function, BaseVar]
  727. ] = None,
  728. on_mouse_enter: Optional[
  729. Union[EventHandler, EventSpec, list, function, BaseVar]
  730. ] = None,
  731. on_mouse_leave: Optional[
  732. Union[EventHandler, EventSpec, list, function, BaseVar]
  733. ] = None,
  734. on_mouse_move: Optional[
  735. Union[EventHandler, EventSpec, list, function, BaseVar]
  736. ] = None,
  737. on_mouse_out: Optional[
  738. Union[EventHandler, EventSpec, list, function, BaseVar]
  739. ] = None,
  740. on_mouse_over: Optional[
  741. Union[EventHandler, EventSpec, list, function, BaseVar]
  742. ] = None,
  743. on_mouse_up: Optional[
  744. Union[EventHandler, EventSpec, list, function, BaseVar]
  745. ] = None,
  746. on_scroll: Optional[
  747. Union[EventHandler, EventSpec, list, function, BaseVar]
  748. ] = None,
  749. on_unmount: Optional[
  750. Union[EventHandler, EventSpec, list, function, BaseVar]
  751. ] = None,
  752. **props
  753. ) -> "Input":
  754. """Create the component.
  755. Args:
  756. *children: The children of the component.
  757. accept: Accepted types of files when the input is file type
  758. alt: Alternate text for input type="image"
  759. auto_complete: Whether the input should have autocomplete enabled
  760. auto_focus: Automatically focuses the input when the page loads
  761. capture: Captures media from the user (camera or microphone)
  762. checked: Indicates whether the input is checked (for checkboxes and radio buttons)
  763. default_checked: The initial value (for checkboxes and radio buttons)
  764. default_value: The initial value for a text field
  765. dirname: Name part of the input to submit in 'dir' and 'name' pair when form is submitted
  766. disabled: Disables the input
  767. form: Associates the input with a form (by id)
  768. form_action: URL to send the form data to (for type="submit" buttons)
  769. form_enc_type: How the form data should be encoded when submitting to the server (for type="submit" buttons)
  770. form_method: HTTP method to use for sending form data (for type="submit" buttons)
  771. form_no_validate: Bypasses form validation when submitting (for type="submit" buttons)
  772. form_target: Specifies where to display the response after submitting the form (for type="submit" buttons)
  773. list: References a datalist for suggested options
  774. max: Specifies the maximum value for the input
  775. max_length: Specifies the maximum number of characters allowed in the input
  776. min_length: Specifies the minimum number of characters required in the input
  777. min: Specifies the minimum value for the input
  778. multiple: Indicates whether multiple values can be entered in an input of the type email or file
  779. name: Name of the input, used when sending form data
  780. pattern: Regex pattern the input's value must match to be valid
  781. placeholder: Placeholder text in the input
  782. read_only: Indicates whether the input is read-only
  783. required: Indicates that the input is required
  784. size: Specifies the visible width of a text control
  785. src: URL for image inputs
  786. step: Specifies the legal number intervals for an input
  787. type: Specifies the type of input
  788. use_map: Name of the image map used with the input
  789. value: Value of the input
  790. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  791. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  792. content_editable: Indicates whether the element's content is editable.
  793. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  794. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  795. draggable: Defines whether the element can be dragged.
  796. enter_key_hint: Hints what media types the media element is able to play.
  797. hidden: Defines whether the element is hidden.
  798. input_mode: Defines the type of the element.
  799. item_prop: Defines the name of the element for metadata purposes.
  800. lang: Defines the language used in the element.
  801. role: Defines the role of the element.
  802. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  803. spell_check: Defines whether the element may be checked for spelling errors.
  804. tab_index: Defines the position of the current element in the tabbing order.
  805. title: Defines a tooltip for the element.
  806. style: The style of the component.
  807. key: A unique key for the component.
  808. id: The id for the component.
  809. class_name: The class name for the component.
  810. autofocus: Whether the component should take the focus once the page is loaded
  811. custom_attrs: custom attribute
  812. **props: The props of the component.
  813. Returns:
  814. The component.
  815. """
  816. ...
  817. class Label(BaseHTML):
  818. @overload
  819. @classmethod
  820. def create( # type: ignore
  821. cls,
  822. *children,
  823. html_for: Optional[
  824. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  825. ] = None,
  826. form: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  827. access_key: Optional[
  828. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  829. ] = None,
  830. auto_capitalize: Optional[
  831. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  832. ] = None,
  833. content_editable: Optional[
  834. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  835. ] = None,
  836. context_menu: Optional[
  837. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  838. ] = None,
  839. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  840. draggable: Optional[
  841. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  842. ] = None,
  843. enter_key_hint: Optional[
  844. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  845. ] = None,
  846. hidden: Optional[
  847. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  848. ] = None,
  849. input_mode: Optional[
  850. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  851. ] = None,
  852. item_prop: Optional[
  853. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  854. ] = None,
  855. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  856. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  857. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  858. spell_check: Optional[
  859. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  860. ] = None,
  861. tab_index: Optional[
  862. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  863. ] = None,
  864. title: Optional[
  865. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  866. ] = None,
  867. style: Optional[Style] = None,
  868. key: Optional[Any] = None,
  869. id: Optional[Any] = None,
  870. class_name: Optional[Any] = None,
  871. autofocus: Optional[bool] = None,
  872. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  873. on_blur: Optional[
  874. Union[EventHandler, EventSpec, list, function, BaseVar]
  875. ] = None,
  876. on_click: Optional[
  877. Union[EventHandler, EventSpec, list, function, BaseVar]
  878. ] = None,
  879. on_context_menu: Optional[
  880. Union[EventHandler, EventSpec, list, function, BaseVar]
  881. ] = None,
  882. on_double_click: Optional[
  883. Union[EventHandler, EventSpec, list, function, BaseVar]
  884. ] = None,
  885. on_focus: Optional[
  886. Union[EventHandler, EventSpec, list, function, BaseVar]
  887. ] = None,
  888. on_mount: Optional[
  889. Union[EventHandler, EventSpec, list, function, BaseVar]
  890. ] = None,
  891. on_mouse_down: Optional[
  892. Union[EventHandler, EventSpec, list, function, BaseVar]
  893. ] = None,
  894. on_mouse_enter: Optional[
  895. Union[EventHandler, EventSpec, list, function, BaseVar]
  896. ] = None,
  897. on_mouse_leave: Optional[
  898. Union[EventHandler, EventSpec, list, function, BaseVar]
  899. ] = None,
  900. on_mouse_move: Optional[
  901. Union[EventHandler, EventSpec, list, function, BaseVar]
  902. ] = None,
  903. on_mouse_out: Optional[
  904. Union[EventHandler, EventSpec, list, function, BaseVar]
  905. ] = None,
  906. on_mouse_over: Optional[
  907. Union[EventHandler, EventSpec, list, function, BaseVar]
  908. ] = None,
  909. on_mouse_up: Optional[
  910. Union[EventHandler, EventSpec, list, function, BaseVar]
  911. ] = None,
  912. on_scroll: Optional[
  913. Union[EventHandler, EventSpec, list, function, BaseVar]
  914. ] = None,
  915. on_unmount: Optional[
  916. Union[EventHandler, EventSpec, list, function, BaseVar]
  917. ] = None,
  918. **props
  919. ) -> "Label":
  920. """Create the component.
  921. Args:
  922. *children: The children of the component.
  923. html_for: ID of a form control with which the label is associated
  924. form: Associates the label with a form (by id)
  925. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  926. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  927. content_editable: Indicates whether the element's content is editable.
  928. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  929. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  930. draggable: Defines whether the element can be dragged.
  931. enter_key_hint: Hints what media types the media element is able to play.
  932. hidden: Defines whether the element is hidden.
  933. input_mode: Defines the type of the element.
  934. item_prop: Defines the name of the element for metadata purposes.
  935. lang: Defines the language used in the element.
  936. role: Defines the role of the element.
  937. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  938. spell_check: Defines whether the element may be checked for spelling errors.
  939. tab_index: Defines the position of the current element in the tabbing order.
  940. title: Defines a tooltip for the element.
  941. style: The style of the component.
  942. key: A unique key for the component.
  943. id: The id for the component.
  944. class_name: The class name for the component.
  945. autofocus: Whether the component should take the focus once the page is loaded
  946. custom_attrs: custom attribute
  947. **props: The props of the component.
  948. Returns:
  949. The component.
  950. """
  951. ...
  952. class Legend(BaseHTML):
  953. @overload
  954. @classmethod
  955. def create( # type: ignore
  956. cls,
  957. *children,
  958. access_key: Optional[
  959. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  960. ] = None,
  961. auto_capitalize: Optional[
  962. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  963. ] = None,
  964. content_editable: Optional[
  965. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  966. ] = None,
  967. context_menu: Optional[
  968. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  969. ] = None,
  970. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  971. draggable: Optional[
  972. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  973. ] = None,
  974. enter_key_hint: Optional[
  975. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  976. ] = None,
  977. hidden: Optional[
  978. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  979. ] = None,
  980. input_mode: Optional[
  981. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  982. ] = None,
  983. item_prop: Optional[
  984. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  985. ] = None,
  986. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  987. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  988. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  989. spell_check: Optional[
  990. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  991. ] = None,
  992. tab_index: Optional[
  993. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  994. ] = None,
  995. title: Optional[
  996. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  997. ] = None,
  998. style: Optional[Style] = None,
  999. key: Optional[Any] = None,
  1000. id: Optional[Any] = None,
  1001. class_name: Optional[Any] = None,
  1002. autofocus: Optional[bool] = None,
  1003. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1004. on_blur: Optional[
  1005. Union[EventHandler, EventSpec, list, function, BaseVar]
  1006. ] = None,
  1007. on_click: Optional[
  1008. Union[EventHandler, EventSpec, list, function, BaseVar]
  1009. ] = None,
  1010. on_context_menu: Optional[
  1011. Union[EventHandler, EventSpec, list, function, BaseVar]
  1012. ] = None,
  1013. on_double_click: Optional[
  1014. Union[EventHandler, EventSpec, list, function, BaseVar]
  1015. ] = None,
  1016. on_focus: Optional[
  1017. Union[EventHandler, EventSpec, list, function, BaseVar]
  1018. ] = None,
  1019. on_mount: Optional[
  1020. Union[EventHandler, EventSpec, list, function, BaseVar]
  1021. ] = None,
  1022. on_mouse_down: Optional[
  1023. Union[EventHandler, EventSpec, list, function, BaseVar]
  1024. ] = None,
  1025. on_mouse_enter: Optional[
  1026. Union[EventHandler, EventSpec, list, function, BaseVar]
  1027. ] = None,
  1028. on_mouse_leave: Optional[
  1029. Union[EventHandler, EventSpec, list, function, BaseVar]
  1030. ] = None,
  1031. on_mouse_move: Optional[
  1032. Union[EventHandler, EventSpec, list, function, BaseVar]
  1033. ] = None,
  1034. on_mouse_out: Optional[
  1035. Union[EventHandler, EventSpec, list, function, BaseVar]
  1036. ] = None,
  1037. on_mouse_over: Optional[
  1038. Union[EventHandler, EventSpec, list, function, BaseVar]
  1039. ] = None,
  1040. on_mouse_up: Optional[
  1041. Union[EventHandler, EventSpec, list, function, BaseVar]
  1042. ] = None,
  1043. on_scroll: Optional[
  1044. Union[EventHandler, EventSpec, list, function, BaseVar]
  1045. ] = None,
  1046. on_unmount: Optional[
  1047. Union[EventHandler, EventSpec, list, function, BaseVar]
  1048. ] = None,
  1049. **props
  1050. ) -> "Legend":
  1051. """Create the component.
  1052. Args:
  1053. *children: The children of the component.
  1054. access_key: No unique attributes, only common ones are inherited Provides a hint for generating a keyboard shortcut for the current element.
  1055. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1056. content_editable: Indicates whether the element's content is editable.
  1057. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1058. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1059. draggable: Defines whether the element can be dragged.
  1060. enter_key_hint: Hints what media types the media element is able to play.
  1061. hidden: Defines whether the element is hidden.
  1062. input_mode: Defines the type of the element.
  1063. item_prop: Defines the name of the element for metadata purposes.
  1064. lang: Defines the language used in the element.
  1065. role: Defines the role of the element.
  1066. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1067. spell_check: Defines whether the element may be checked for spelling errors.
  1068. tab_index: Defines the position of the current element in the tabbing order.
  1069. title: Defines a tooltip for the element.
  1070. style: The style of the component.
  1071. key: A unique key for the component.
  1072. id: The id for the component.
  1073. class_name: The class name for the component.
  1074. autofocus: Whether the component should take the focus once the page is loaded
  1075. custom_attrs: custom attribute
  1076. **props: The props of the component.
  1077. Returns:
  1078. The component.
  1079. """
  1080. ...
  1081. class Meter(BaseHTML):
  1082. @overload
  1083. @classmethod
  1084. def create( # type: ignore
  1085. cls,
  1086. *children,
  1087. form: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1088. high: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1089. low: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1090. max: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1091. min: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1092. optimum: Optional[
  1093. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1094. ] = None,
  1095. value: Optional[
  1096. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1097. ] = None,
  1098. access_key: Optional[
  1099. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1100. ] = None,
  1101. auto_capitalize: Optional[
  1102. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1103. ] = None,
  1104. content_editable: Optional[
  1105. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1106. ] = None,
  1107. context_menu: Optional[
  1108. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1109. ] = None,
  1110. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1111. draggable: Optional[
  1112. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1113. ] = None,
  1114. enter_key_hint: Optional[
  1115. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1116. ] = None,
  1117. hidden: Optional[
  1118. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1119. ] = None,
  1120. input_mode: Optional[
  1121. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1122. ] = None,
  1123. item_prop: Optional[
  1124. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1125. ] = None,
  1126. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1127. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1128. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1129. spell_check: Optional[
  1130. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1131. ] = None,
  1132. tab_index: Optional[
  1133. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1134. ] = None,
  1135. title: Optional[
  1136. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1137. ] = None,
  1138. style: Optional[Style] = None,
  1139. key: Optional[Any] = None,
  1140. id: Optional[Any] = None,
  1141. class_name: Optional[Any] = None,
  1142. autofocus: Optional[bool] = None,
  1143. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1144. on_blur: Optional[
  1145. Union[EventHandler, EventSpec, list, function, BaseVar]
  1146. ] = None,
  1147. on_click: Optional[
  1148. Union[EventHandler, EventSpec, list, function, BaseVar]
  1149. ] = None,
  1150. on_context_menu: Optional[
  1151. Union[EventHandler, EventSpec, list, function, BaseVar]
  1152. ] = None,
  1153. on_double_click: Optional[
  1154. Union[EventHandler, EventSpec, list, function, BaseVar]
  1155. ] = None,
  1156. on_focus: Optional[
  1157. Union[EventHandler, EventSpec, list, function, BaseVar]
  1158. ] = None,
  1159. on_mount: Optional[
  1160. Union[EventHandler, EventSpec, list, function, BaseVar]
  1161. ] = None,
  1162. on_mouse_down: Optional[
  1163. Union[EventHandler, EventSpec, list, function, BaseVar]
  1164. ] = None,
  1165. on_mouse_enter: Optional[
  1166. Union[EventHandler, EventSpec, list, function, BaseVar]
  1167. ] = None,
  1168. on_mouse_leave: Optional[
  1169. Union[EventHandler, EventSpec, list, function, BaseVar]
  1170. ] = None,
  1171. on_mouse_move: Optional[
  1172. Union[EventHandler, EventSpec, list, function, BaseVar]
  1173. ] = None,
  1174. on_mouse_out: Optional[
  1175. Union[EventHandler, EventSpec, list, function, BaseVar]
  1176. ] = None,
  1177. on_mouse_over: Optional[
  1178. Union[EventHandler, EventSpec, list, function, BaseVar]
  1179. ] = None,
  1180. on_mouse_up: Optional[
  1181. Union[EventHandler, EventSpec, list, function, BaseVar]
  1182. ] = None,
  1183. on_scroll: Optional[
  1184. Union[EventHandler, EventSpec, list, function, BaseVar]
  1185. ] = None,
  1186. on_unmount: Optional[
  1187. Union[EventHandler, EventSpec, list, function, BaseVar]
  1188. ] = None,
  1189. **props
  1190. ) -> "Meter":
  1191. """Create the component.
  1192. Args:
  1193. *children: The children of the component.
  1194. form: Associates the meter with a form (by id)
  1195. high: High limit of range (above this is considered high value)
  1196. low: Low limit of range (below this is considered low value)
  1197. max: Maximum value of the range
  1198. min: Minimum value of the range
  1199. optimum: Optimum value in the range
  1200. value: Current value of the meter
  1201. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1202. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1203. content_editable: Indicates whether the element's content is editable.
  1204. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1205. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1206. draggable: Defines whether the element can be dragged.
  1207. enter_key_hint: Hints what media types the media element is able to play.
  1208. hidden: Defines whether the element is hidden.
  1209. input_mode: Defines the type of the element.
  1210. item_prop: Defines the name of the element for metadata purposes.
  1211. lang: Defines the language used in the element.
  1212. role: Defines the role of the element.
  1213. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1214. spell_check: Defines whether the element may be checked for spelling errors.
  1215. tab_index: Defines the position of the current element in the tabbing order.
  1216. title: Defines a tooltip for the element.
  1217. style: The style of the component.
  1218. key: A unique key for the component.
  1219. id: The id for the component.
  1220. class_name: The class name for the component.
  1221. autofocus: Whether the component should take the focus once the page is loaded
  1222. custom_attrs: custom attribute
  1223. **props: The props of the component.
  1224. Returns:
  1225. The component.
  1226. """
  1227. ...
  1228. class Optgroup(BaseHTML):
  1229. @overload
  1230. @classmethod
  1231. def create( # type: ignore
  1232. cls,
  1233. *children,
  1234. disabled: Optional[
  1235. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1236. ] = None,
  1237. label: Optional[
  1238. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1239. ] = None,
  1240. access_key: Optional[
  1241. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1242. ] = None,
  1243. auto_capitalize: Optional[
  1244. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1245. ] = None,
  1246. content_editable: Optional[
  1247. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1248. ] = None,
  1249. context_menu: Optional[
  1250. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1251. ] = None,
  1252. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1253. draggable: Optional[
  1254. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1255. ] = None,
  1256. enter_key_hint: Optional[
  1257. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1258. ] = None,
  1259. hidden: Optional[
  1260. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1261. ] = None,
  1262. input_mode: Optional[
  1263. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1264. ] = None,
  1265. item_prop: Optional[
  1266. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1267. ] = None,
  1268. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1269. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1270. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1271. spell_check: Optional[
  1272. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1273. ] = None,
  1274. tab_index: Optional[
  1275. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1276. ] = None,
  1277. title: Optional[
  1278. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1279. ] = None,
  1280. style: Optional[Style] = None,
  1281. key: Optional[Any] = None,
  1282. id: Optional[Any] = None,
  1283. class_name: Optional[Any] = None,
  1284. autofocus: Optional[bool] = None,
  1285. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1286. on_blur: Optional[
  1287. Union[EventHandler, EventSpec, list, function, BaseVar]
  1288. ] = None,
  1289. on_click: Optional[
  1290. Union[EventHandler, EventSpec, list, function, BaseVar]
  1291. ] = None,
  1292. on_context_menu: Optional[
  1293. Union[EventHandler, EventSpec, list, function, BaseVar]
  1294. ] = None,
  1295. on_double_click: Optional[
  1296. Union[EventHandler, EventSpec, list, function, BaseVar]
  1297. ] = None,
  1298. on_focus: Optional[
  1299. Union[EventHandler, EventSpec, list, function, BaseVar]
  1300. ] = None,
  1301. on_mount: Optional[
  1302. Union[EventHandler, EventSpec, list, function, BaseVar]
  1303. ] = None,
  1304. on_mouse_down: Optional[
  1305. Union[EventHandler, EventSpec, list, function, BaseVar]
  1306. ] = None,
  1307. on_mouse_enter: Optional[
  1308. Union[EventHandler, EventSpec, list, function, BaseVar]
  1309. ] = None,
  1310. on_mouse_leave: Optional[
  1311. Union[EventHandler, EventSpec, list, function, BaseVar]
  1312. ] = None,
  1313. on_mouse_move: Optional[
  1314. Union[EventHandler, EventSpec, list, function, BaseVar]
  1315. ] = None,
  1316. on_mouse_out: Optional[
  1317. Union[EventHandler, EventSpec, list, function, BaseVar]
  1318. ] = None,
  1319. on_mouse_over: Optional[
  1320. Union[EventHandler, EventSpec, list, function, BaseVar]
  1321. ] = None,
  1322. on_mouse_up: Optional[
  1323. Union[EventHandler, EventSpec, list, function, BaseVar]
  1324. ] = None,
  1325. on_scroll: Optional[
  1326. Union[EventHandler, EventSpec, list, function, BaseVar]
  1327. ] = None,
  1328. on_unmount: Optional[
  1329. Union[EventHandler, EventSpec, list, function, BaseVar]
  1330. ] = None,
  1331. **props
  1332. ) -> "Optgroup":
  1333. """Create the component.
  1334. Args:
  1335. *children: The children of the component.
  1336. disabled: Disables the optgroup
  1337. label: Label for the optgroup
  1338. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1339. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1340. content_editable: Indicates whether the element's content is editable.
  1341. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1342. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1343. draggable: Defines whether the element can be dragged.
  1344. enter_key_hint: Hints what media types the media element is able to play.
  1345. hidden: Defines whether the element is hidden.
  1346. input_mode: Defines the type of the element.
  1347. item_prop: Defines the name of the element for metadata purposes.
  1348. lang: Defines the language used in the element.
  1349. role: Defines the role of the element.
  1350. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1351. spell_check: Defines whether the element may be checked for spelling errors.
  1352. tab_index: Defines the position of the current element in the tabbing order.
  1353. title: Defines a tooltip for the element.
  1354. style: The style of the component.
  1355. key: A unique key for the component.
  1356. id: The id for the component.
  1357. class_name: The class name for the component.
  1358. autofocus: Whether the component should take the focus once the page is loaded
  1359. custom_attrs: custom attribute
  1360. **props: The props of the component.
  1361. Returns:
  1362. The component.
  1363. """
  1364. ...
  1365. class Option(BaseHTML):
  1366. @overload
  1367. @classmethod
  1368. def create( # type: ignore
  1369. cls,
  1370. *children,
  1371. disabled: Optional[
  1372. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1373. ] = None,
  1374. label: Optional[
  1375. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1376. ] = None,
  1377. selected: Optional[
  1378. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1379. ] = None,
  1380. value: Optional[
  1381. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1382. ] = None,
  1383. access_key: Optional[
  1384. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1385. ] = None,
  1386. auto_capitalize: Optional[
  1387. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1388. ] = None,
  1389. content_editable: Optional[
  1390. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1391. ] = None,
  1392. context_menu: Optional[
  1393. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1394. ] = None,
  1395. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1396. draggable: Optional[
  1397. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1398. ] = None,
  1399. enter_key_hint: Optional[
  1400. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1401. ] = None,
  1402. hidden: Optional[
  1403. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1404. ] = None,
  1405. input_mode: Optional[
  1406. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1407. ] = None,
  1408. item_prop: Optional[
  1409. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1410. ] = None,
  1411. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1412. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1413. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1414. spell_check: Optional[
  1415. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1416. ] = None,
  1417. tab_index: Optional[
  1418. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1419. ] = None,
  1420. title: Optional[
  1421. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1422. ] = None,
  1423. style: Optional[Style] = None,
  1424. key: Optional[Any] = None,
  1425. id: Optional[Any] = None,
  1426. class_name: Optional[Any] = None,
  1427. autofocus: Optional[bool] = None,
  1428. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1429. on_blur: Optional[
  1430. Union[EventHandler, EventSpec, list, function, BaseVar]
  1431. ] = None,
  1432. on_click: Optional[
  1433. Union[EventHandler, EventSpec, list, function, BaseVar]
  1434. ] = None,
  1435. on_context_menu: Optional[
  1436. Union[EventHandler, EventSpec, list, function, BaseVar]
  1437. ] = None,
  1438. on_double_click: Optional[
  1439. Union[EventHandler, EventSpec, list, function, BaseVar]
  1440. ] = None,
  1441. on_focus: Optional[
  1442. Union[EventHandler, EventSpec, list, function, BaseVar]
  1443. ] = None,
  1444. on_mount: Optional[
  1445. Union[EventHandler, EventSpec, list, function, BaseVar]
  1446. ] = None,
  1447. on_mouse_down: Optional[
  1448. Union[EventHandler, EventSpec, list, function, BaseVar]
  1449. ] = None,
  1450. on_mouse_enter: Optional[
  1451. Union[EventHandler, EventSpec, list, function, BaseVar]
  1452. ] = None,
  1453. on_mouse_leave: Optional[
  1454. Union[EventHandler, EventSpec, list, function, BaseVar]
  1455. ] = None,
  1456. on_mouse_move: Optional[
  1457. Union[EventHandler, EventSpec, list, function, BaseVar]
  1458. ] = None,
  1459. on_mouse_out: Optional[
  1460. Union[EventHandler, EventSpec, list, function, BaseVar]
  1461. ] = None,
  1462. on_mouse_over: Optional[
  1463. Union[EventHandler, EventSpec, list, function, BaseVar]
  1464. ] = None,
  1465. on_mouse_up: Optional[
  1466. Union[EventHandler, EventSpec, list, function, BaseVar]
  1467. ] = None,
  1468. on_scroll: Optional[
  1469. Union[EventHandler, EventSpec, list, function, BaseVar]
  1470. ] = None,
  1471. on_unmount: Optional[
  1472. Union[EventHandler, EventSpec, list, function, BaseVar]
  1473. ] = None,
  1474. **props
  1475. ) -> "Option":
  1476. """Create the component.
  1477. Args:
  1478. *children: The children of the component.
  1479. disabled: Disables the option
  1480. label: Label for the option, if the text is not the label
  1481. selected: Indicates that the option is initially selected
  1482. value: Value to be sent as form data
  1483. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1484. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1485. content_editable: Indicates whether the element's content is editable.
  1486. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1487. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1488. draggable: Defines whether the element can be dragged.
  1489. enter_key_hint: Hints what media types the media element is able to play.
  1490. hidden: Defines whether the element is hidden.
  1491. input_mode: Defines the type of the element.
  1492. item_prop: Defines the name of the element for metadata purposes.
  1493. lang: Defines the language used in the element.
  1494. role: Defines the role of the element.
  1495. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1496. spell_check: Defines whether the element may be checked for spelling errors.
  1497. tab_index: Defines the position of the current element in the tabbing order.
  1498. title: Defines a tooltip for the element.
  1499. style: The style of the component.
  1500. key: A unique key for the component.
  1501. id: The id for the component.
  1502. class_name: The class name for the component.
  1503. autofocus: Whether the component should take the focus once the page is loaded
  1504. custom_attrs: custom attribute
  1505. **props: The props of the component.
  1506. Returns:
  1507. The component.
  1508. """
  1509. ...
  1510. class Output(BaseHTML):
  1511. @overload
  1512. @classmethod
  1513. def create( # type: ignore
  1514. cls,
  1515. *children,
  1516. html_for: Optional[
  1517. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1518. ] = None,
  1519. form: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1520. name: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1521. access_key: Optional[
  1522. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1523. ] = None,
  1524. auto_capitalize: Optional[
  1525. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1526. ] = None,
  1527. content_editable: Optional[
  1528. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1529. ] = None,
  1530. context_menu: Optional[
  1531. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1532. ] = None,
  1533. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1534. draggable: Optional[
  1535. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1536. ] = None,
  1537. enter_key_hint: Optional[
  1538. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1539. ] = None,
  1540. hidden: Optional[
  1541. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1542. ] = None,
  1543. input_mode: Optional[
  1544. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1545. ] = None,
  1546. item_prop: Optional[
  1547. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1548. ] = None,
  1549. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1550. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1551. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1552. spell_check: Optional[
  1553. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1554. ] = None,
  1555. tab_index: Optional[
  1556. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1557. ] = None,
  1558. title: Optional[
  1559. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1560. ] = None,
  1561. style: Optional[Style] = None,
  1562. key: Optional[Any] = None,
  1563. id: Optional[Any] = None,
  1564. class_name: Optional[Any] = None,
  1565. autofocus: Optional[bool] = None,
  1566. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1567. on_blur: Optional[
  1568. Union[EventHandler, EventSpec, list, function, BaseVar]
  1569. ] = None,
  1570. on_click: Optional[
  1571. Union[EventHandler, EventSpec, list, function, BaseVar]
  1572. ] = None,
  1573. on_context_menu: Optional[
  1574. Union[EventHandler, EventSpec, list, function, BaseVar]
  1575. ] = None,
  1576. on_double_click: Optional[
  1577. Union[EventHandler, EventSpec, list, function, BaseVar]
  1578. ] = None,
  1579. on_focus: Optional[
  1580. Union[EventHandler, EventSpec, list, function, BaseVar]
  1581. ] = None,
  1582. on_mount: Optional[
  1583. Union[EventHandler, EventSpec, list, function, BaseVar]
  1584. ] = None,
  1585. on_mouse_down: Optional[
  1586. Union[EventHandler, EventSpec, list, function, BaseVar]
  1587. ] = None,
  1588. on_mouse_enter: Optional[
  1589. Union[EventHandler, EventSpec, list, function, BaseVar]
  1590. ] = None,
  1591. on_mouse_leave: Optional[
  1592. Union[EventHandler, EventSpec, list, function, BaseVar]
  1593. ] = None,
  1594. on_mouse_move: Optional[
  1595. Union[EventHandler, EventSpec, list, function, BaseVar]
  1596. ] = None,
  1597. on_mouse_out: Optional[
  1598. Union[EventHandler, EventSpec, list, function, BaseVar]
  1599. ] = None,
  1600. on_mouse_over: Optional[
  1601. Union[EventHandler, EventSpec, list, function, BaseVar]
  1602. ] = None,
  1603. on_mouse_up: Optional[
  1604. Union[EventHandler, EventSpec, list, function, BaseVar]
  1605. ] = None,
  1606. on_scroll: Optional[
  1607. Union[EventHandler, EventSpec, list, function, BaseVar]
  1608. ] = None,
  1609. on_unmount: Optional[
  1610. Union[EventHandler, EventSpec, list, function, BaseVar]
  1611. ] = None,
  1612. **props
  1613. ) -> "Output":
  1614. """Create the component.
  1615. Args:
  1616. *children: The children of the component.
  1617. html_for: Associates the output with one or more elements (by their IDs)
  1618. form: Associates the output with a form (by id)
  1619. name: Name of the output element for form submission
  1620. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1621. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1622. content_editable: Indicates whether the element's content is editable.
  1623. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1624. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1625. draggable: Defines whether the element can be dragged.
  1626. enter_key_hint: Hints what media types the media element is able to play.
  1627. hidden: Defines whether the element is hidden.
  1628. input_mode: Defines the type of the element.
  1629. item_prop: Defines the name of the element for metadata purposes.
  1630. lang: Defines the language used in the element.
  1631. role: Defines the role of the element.
  1632. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1633. spell_check: Defines whether the element may be checked for spelling errors.
  1634. tab_index: Defines the position of the current element in the tabbing order.
  1635. title: Defines a tooltip for the element.
  1636. style: The style of the component.
  1637. key: A unique key for the component.
  1638. id: The id for the component.
  1639. class_name: The class name for the component.
  1640. autofocus: Whether the component should take the focus once the page is loaded
  1641. custom_attrs: custom attribute
  1642. **props: The props of the component.
  1643. Returns:
  1644. The component.
  1645. """
  1646. ...
  1647. class Progress(BaseHTML):
  1648. @overload
  1649. @classmethod
  1650. def create( # type: ignore
  1651. cls,
  1652. *children,
  1653. form: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1654. max: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1655. value: Optional[
  1656. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1657. ] = None,
  1658. access_key: Optional[
  1659. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1660. ] = None,
  1661. auto_capitalize: Optional[
  1662. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1663. ] = None,
  1664. content_editable: Optional[
  1665. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1666. ] = None,
  1667. context_menu: Optional[
  1668. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1669. ] = None,
  1670. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1671. draggable: Optional[
  1672. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1673. ] = None,
  1674. enter_key_hint: Optional[
  1675. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1676. ] = None,
  1677. hidden: Optional[
  1678. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1679. ] = None,
  1680. input_mode: Optional[
  1681. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1682. ] = None,
  1683. item_prop: Optional[
  1684. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1685. ] = None,
  1686. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1687. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1688. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1689. spell_check: Optional[
  1690. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1691. ] = None,
  1692. tab_index: Optional[
  1693. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1694. ] = None,
  1695. title: Optional[
  1696. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1697. ] = None,
  1698. style: Optional[Style] = None,
  1699. key: Optional[Any] = None,
  1700. id: Optional[Any] = None,
  1701. class_name: Optional[Any] = None,
  1702. autofocus: Optional[bool] = None,
  1703. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1704. on_blur: Optional[
  1705. Union[EventHandler, EventSpec, list, function, BaseVar]
  1706. ] = None,
  1707. on_click: Optional[
  1708. Union[EventHandler, EventSpec, list, function, BaseVar]
  1709. ] = None,
  1710. on_context_menu: Optional[
  1711. Union[EventHandler, EventSpec, list, function, BaseVar]
  1712. ] = None,
  1713. on_double_click: Optional[
  1714. Union[EventHandler, EventSpec, list, function, BaseVar]
  1715. ] = None,
  1716. on_focus: Optional[
  1717. Union[EventHandler, EventSpec, list, function, BaseVar]
  1718. ] = None,
  1719. on_mount: Optional[
  1720. Union[EventHandler, EventSpec, list, function, BaseVar]
  1721. ] = None,
  1722. on_mouse_down: Optional[
  1723. Union[EventHandler, EventSpec, list, function, BaseVar]
  1724. ] = None,
  1725. on_mouse_enter: Optional[
  1726. Union[EventHandler, EventSpec, list, function, BaseVar]
  1727. ] = None,
  1728. on_mouse_leave: Optional[
  1729. Union[EventHandler, EventSpec, list, function, BaseVar]
  1730. ] = None,
  1731. on_mouse_move: Optional[
  1732. Union[EventHandler, EventSpec, list, function, BaseVar]
  1733. ] = None,
  1734. on_mouse_out: Optional[
  1735. Union[EventHandler, EventSpec, list, function, BaseVar]
  1736. ] = None,
  1737. on_mouse_over: Optional[
  1738. Union[EventHandler, EventSpec, list, function, BaseVar]
  1739. ] = None,
  1740. on_mouse_up: Optional[
  1741. Union[EventHandler, EventSpec, list, function, BaseVar]
  1742. ] = None,
  1743. on_scroll: Optional[
  1744. Union[EventHandler, EventSpec, list, function, BaseVar]
  1745. ] = None,
  1746. on_unmount: Optional[
  1747. Union[EventHandler, EventSpec, list, function, BaseVar]
  1748. ] = None,
  1749. **props
  1750. ) -> "Progress":
  1751. """Create the component.
  1752. Args:
  1753. *children: The children of the component.
  1754. form: Associates the progress element with a form (by id)
  1755. max: Maximum value of the progress indicator
  1756. value: Current value of the progress indicator
  1757. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1758. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1759. content_editable: Indicates whether the element's content is editable.
  1760. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1761. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1762. draggable: Defines whether the element can be dragged.
  1763. enter_key_hint: Hints what media types the media element is able to play.
  1764. hidden: Defines whether the element is hidden.
  1765. input_mode: Defines the type of the element.
  1766. item_prop: Defines the name of the element for metadata purposes.
  1767. lang: Defines the language used in the element.
  1768. role: Defines the role of the element.
  1769. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1770. spell_check: Defines whether the element may be checked for spelling errors.
  1771. tab_index: Defines the position of the current element in the tabbing order.
  1772. title: Defines a tooltip for the element.
  1773. style: The style of the component.
  1774. key: A unique key for the component.
  1775. id: The id for the component.
  1776. class_name: The class name for the component.
  1777. autofocus: Whether the component should take the focus once the page is loaded
  1778. custom_attrs: custom attribute
  1779. **props: The props of the component.
  1780. Returns:
  1781. The component.
  1782. """
  1783. ...
  1784. class Select(BaseHTML):
  1785. @overload
  1786. @classmethod
  1787. def create( # type: ignore
  1788. cls,
  1789. *children,
  1790. auto_complete: Optional[
  1791. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1792. ] = None,
  1793. auto_focus: Optional[
  1794. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1795. ] = None,
  1796. disabled: Optional[
  1797. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1798. ] = None,
  1799. form: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1800. multiple: Optional[
  1801. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1802. ] = None,
  1803. name: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1804. required: Optional[
  1805. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1806. ] = None,
  1807. size: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1808. access_key: Optional[
  1809. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1810. ] = None,
  1811. auto_capitalize: Optional[
  1812. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1813. ] = None,
  1814. content_editable: Optional[
  1815. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1816. ] = None,
  1817. context_menu: Optional[
  1818. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1819. ] = None,
  1820. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1821. draggable: Optional[
  1822. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1823. ] = None,
  1824. enter_key_hint: Optional[
  1825. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1826. ] = None,
  1827. hidden: Optional[
  1828. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1829. ] = None,
  1830. input_mode: Optional[
  1831. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1832. ] = None,
  1833. item_prop: Optional[
  1834. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1835. ] = None,
  1836. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1837. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1838. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1839. spell_check: Optional[
  1840. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1841. ] = None,
  1842. tab_index: Optional[
  1843. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1844. ] = None,
  1845. title: Optional[
  1846. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1847. ] = None,
  1848. style: Optional[Style] = None,
  1849. key: Optional[Any] = None,
  1850. id: Optional[Any] = None,
  1851. class_name: Optional[Any] = None,
  1852. autofocus: Optional[bool] = None,
  1853. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1854. on_blur: Optional[
  1855. Union[EventHandler, EventSpec, list, function, BaseVar]
  1856. ] = None,
  1857. on_change: Optional[
  1858. Union[EventHandler, EventSpec, list, function, BaseVar]
  1859. ] = None,
  1860. on_click: Optional[
  1861. Union[EventHandler, EventSpec, list, function, BaseVar]
  1862. ] = None,
  1863. on_context_menu: Optional[
  1864. Union[EventHandler, EventSpec, list, function, BaseVar]
  1865. ] = None,
  1866. on_double_click: Optional[
  1867. Union[EventHandler, EventSpec, list, function, BaseVar]
  1868. ] = None,
  1869. on_focus: Optional[
  1870. Union[EventHandler, EventSpec, list, function, BaseVar]
  1871. ] = None,
  1872. on_mount: Optional[
  1873. Union[EventHandler, EventSpec, list, function, BaseVar]
  1874. ] = None,
  1875. on_mouse_down: Optional[
  1876. Union[EventHandler, EventSpec, list, function, BaseVar]
  1877. ] = None,
  1878. on_mouse_enter: Optional[
  1879. Union[EventHandler, EventSpec, list, function, BaseVar]
  1880. ] = None,
  1881. on_mouse_leave: Optional[
  1882. Union[EventHandler, EventSpec, list, function, BaseVar]
  1883. ] = None,
  1884. on_mouse_move: Optional[
  1885. Union[EventHandler, EventSpec, list, function, BaseVar]
  1886. ] = None,
  1887. on_mouse_out: Optional[
  1888. Union[EventHandler, EventSpec, list, function, BaseVar]
  1889. ] = None,
  1890. on_mouse_over: Optional[
  1891. Union[EventHandler, EventSpec, list, function, BaseVar]
  1892. ] = None,
  1893. on_mouse_up: Optional[
  1894. Union[EventHandler, EventSpec, list, function, BaseVar]
  1895. ] = None,
  1896. on_scroll: Optional[
  1897. Union[EventHandler, EventSpec, list, function, BaseVar]
  1898. ] = None,
  1899. on_unmount: Optional[
  1900. Union[EventHandler, EventSpec, list, function, BaseVar]
  1901. ] = None,
  1902. **props
  1903. ) -> "Select":
  1904. """Create the component.
  1905. Args:
  1906. *children: The children of the component.
  1907. auto_complete: Whether the form control should have autocomplete enabled
  1908. auto_focus: Automatically focuses the select when the page loads
  1909. disabled: Disables the select control
  1910. form: Associates the select with a form (by id)
  1911. multiple: Indicates that multiple options can be selected
  1912. name: Name of the select, used when submitting the form
  1913. required: Indicates that the select control must have a selected option
  1914. size: Number of visible options in a drop-down list
  1915. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1916. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1917. content_editable: Indicates whether the element's content is editable.
  1918. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1919. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1920. draggable: Defines whether the element can be dragged.
  1921. enter_key_hint: Hints what media types the media element is able to play.
  1922. hidden: Defines whether the element is hidden.
  1923. input_mode: Defines the type of the element.
  1924. item_prop: Defines the name of the element for metadata purposes.
  1925. lang: Defines the language used in the element.
  1926. role: Defines the role of the element.
  1927. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1928. spell_check: Defines whether the element may be checked for spelling errors.
  1929. tab_index: Defines the position of the current element in the tabbing order.
  1930. title: Defines a tooltip for the element.
  1931. style: The style of the component.
  1932. key: A unique key for the component.
  1933. id: The id for the component.
  1934. class_name: The class name for the component.
  1935. autofocus: Whether the component should take the focus once the page is loaded
  1936. custom_attrs: custom attribute
  1937. **props: The props of the component.
  1938. Returns:
  1939. The component.
  1940. """
  1941. ...
  1942. AUTO_HEIGHT_JS = '\nconst autoHeightOnInput = (e, is_enabled) => {\n if (is_enabled) {\n const el = e.target;\n el.style.overflowY = "hidden";\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'
  1943. 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"
  1944. class Textarea(BaseHTML):
  1945. @overload
  1946. @classmethod
  1947. def create( # type: ignore
  1948. cls,
  1949. *children,
  1950. auto_complete: Optional[
  1951. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1952. ] = None,
  1953. auto_focus: Optional[
  1954. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1955. ] = None,
  1956. auto_height: Optional[Union[Var[bool], bool]] = None,
  1957. cols: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1958. dirname: Optional[
  1959. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1960. ] = None,
  1961. disabled: Optional[
  1962. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1963. ] = None,
  1964. enter_key_submit: Optional[Union[Var[bool], bool]] = None,
  1965. form: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1966. max_length: Optional[
  1967. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1968. ] = None,
  1969. min_length: Optional[
  1970. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1971. ] = None,
  1972. name: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1973. placeholder: Optional[
  1974. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1975. ] = None,
  1976. read_only: Optional[
  1977. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1978. ] = None,
  1979. required: Optional[
  1980. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1981. ] = None,
  1982. rows: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1983. value: Optional[
  1984. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1985. ] = None,
  1986. wrap: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  1987. access_key: Optional[
  1988. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1989. ] = None,
  1990. auto_capitalize: Optional[
  1991. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1992. ] = None,
  1993. content_editable: Optional[
  1994. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1995. ] = None,
  1996. context_menu: Optional[
  1997. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  1998. ] = None,
  1999. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  2000. draggable: Optional[
  2001. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  2002. ] = None,
  2003. enter_key_hint: Optional[
  2004. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  2005. ] = None,
  2006. hidden: Optional[
  2007. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  2008. ] = None,
  2009. input_mode: Optional[
  2010. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  2011. ] = None,
  2012. item_prop: Optional[
  2013. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  2014. ] = None,
  2015. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  2016. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  2017. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  2018. spell_check: Optional[
  2019. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  2020. ] = None,
  2021. tab_index: Optional[
  2022. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  2023. ] = None,
  2024. title: Optional[
  2025. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  2026. ] = None,
  2027. style: Optional[Style] = None,
  2028. key: Optional[Any] = None,
  2029. id: Optional[Any] = None,
  2030. class_name: Optional[Any] = None,
  2031. autofocus: Optional[bool] = None,
  2032. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  2033. on_blur: Optional[
  2034. Union[EventHandler, EventSpec, list, function, BaseVar]
  2035. ] = None,
  2036. on_change: Optional[
  2037. Union[EventHandler, EventSpec, list, function, BaseVar]
  2038. ] = None,
  2039. on_click: Optional[
  2040. Union[EventHandler, EventSpec, list, function, BaseVar]
  2041. ] = None,
  2042. on_context_menu: Optional[
  2043. Union[EventHandler, EventSpec, list, function, BaseVar]
  2044. ] = None,
  2045. on_double_click: Optional[
  2046. Union[EventHandler, EventSpec, list, function, BaseVar]
  2047. ] = None,
  2048. on_focus: Optional[
  2049. Union[EventHandler, EventSpec, list, function, BaseVar]
  2050. ] = None,
  2051. on_key_down: Optional[
  2052. Union[EventHandler, EventSpec, list, function, BaseVar]
  2053. ] = None,
  2054. on_key_up: Optional[
  2055. Union[EventHandler, EventSpec, list, function, BaseVar]
  2056. ] = None,
  2057. on_mount: Optional[
  2058. Union[EventHandler, EventSpec, list, function, BaseVar]
  2059. ] = None,
  2060. on_mouse_down: Optional[
  2061. Union[EventHandler, EventSpec, list, function, BaseVar]
  2062. ] = None,
  2063. on_mouse_enter: Optional[
  2064. Union[EventHandler, EventSpec, list, function, BaseVar]
  2065. ] = None,
  2066. on_mouse_leave: Optional[
  2067. Union[EventHandler, EventSpec, list, function, BaseVar]
  2068. ] = None,
  2069. on_mouse_move: Optional[
  2070. Union[EventHandler, EventSpec, list, function, BaseVar]
  2071. ] = None,
  2072. on_mouse_out: Optional[
  2073. Union[EventHandler, EventSpec, list, function, BaseVar]
  2074. ] = None,
  2075. on_mouse_over: Optional[
  2076. Union[EventHandler, EventSpec, list, function, BaseVar]
  2077. ] = None,
  2078. on_mouse_up: Optional[
  2079. Union[EventHandler, EventSpec, list, function, BaseVar]
  2080. ] = None,
  2081. on_scroll: Optional[
  2082. Union[EventHandler, EventSpec, list, function, BaseVar]
  2083. ] = None,
  2084. on_unmount: Optional[
  2085. Union[EventHandler, EventSpec, list, function, BaseVar]
  2086. ] = None,
  2087. **props
  2088. ) -> "Textarea":
  2089. """Create the component.
  2090. Args:
  2091. *children: The children of the component.
  2092. auto_complete: Whether the form control should have autocomplete enabled
  2093. auto_focus: Automatically focuses the textarea when the page loads
  2094. auto_height: Automatically fit the content height to the text (use min-height with this prop)
  2095. cols: Visible width of the text control, in average character widths
  2096. dirname: Name part of the textarea to submit in 'dir' and 'name' pair when form is submitted
  2097. disabled: Disables the textarea
  2098. enter_key_submit: Enter key submits form (shift-enter adds new line)
  2099. form: Associates the textarea with a form (by id)
  2100. max_length: Maximum number of characters allowed in the textarea
  2101. min_length: Minimum number of characters required in the textarea
  2102. name: Name of the textarea, used when submitting the form
  2103. placeholder: Placeholder text in the textarea
  2104. read_only: Indicates whether the textarea is read-only
  2105. required: Indicates that the textarea is required
  2106. rows: Visible number of lines in the text control
  2107. value: The controlled value of the textarea, read only unless used with on_change
  2108. wrap: How the text in the textarea is to be wrapped when submitting the form
  2109. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  2110. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  2111. content_editable: Indicates whether the element's content is editable.
  2112. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  2113. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  2114. draggable: Defines whether the element can be dragged.
  2115. enter_key_hint: Hints what media types the media element is able to play.
  2116. hidden: Defines whether the element is hidden.
  2117. input_mode: Defines the type of the element.
  2118. item_prop: Defines the name of the element for metadata purposes.
  2119. lang: Defines the language used in the element.
  2120. role: Defines the role of the element.
  2121. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  2122. spell_check: Defines whether the element may be checked for spelling errors.
  2123. tab_index: Defines the position of the current element in the tabbing order.
  2124. title: Defines a tooltip for the element.
  2125. style: The style of the component.
  2126. key: A unique key for the component.
  2127. id: The id for the component.
  2128. class_name: The class name for the component.
  2129. autofocus: Whether the component should take the focus once the page is loaded
  2130. custom_attrs: custom attribute
  2131. **props: The props of the component.
  2132. Returns:
  2133. The component.
  2134. """
  2135. ...
  2136. button = Button.create
  2137. fieldset = Fieldset.create
  2138. form = Form.create
  2139. input = Input.create
  2140. label = Label.create
  2141. legend = Legend.create
  2142. meter = Meter.create
  2143. optgroup = Optgroup.create
  2144. option = Option.create
  2145. output = Output.create
  2146. progress = Progress.create
  2147. select = Select.create
  2148. textarea = Textarea.create