forms.pyi 89 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724
  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, Callable, Dict, Optional, Union, overload
  6. from jinja2 import Environment
  7. from reflex.components.el.element import Element
  8. from reflex.event import EventHandler, EventSpec
  9. from reflex.ivars.base import ImmutableVar
  10. from reflex.style import Style
  11. from reflex.utils.imports import ImportDict
  12. from reflex.vars import Var
  13. from .base import BaseHTML
  14. FORM_DATA = ImmutableVar.create("form_data")
  15. HANDLE_SUBMIT_JS_JINJA2 = Environment().from_string(
  16. "\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 "
  17. )
  18. class Button(BaseHTML):
  19. @overload
  20. @classmethod
  21. def create( # type: ignore
  22. cls,
  23. *children,
  24. auto_focus: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  25. disabled: Optional[Union[Var[bool], bool]] = None,
  26. form: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  27. form_action: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  28. form_enc_type: Optional[
  29. Union[Var[Union[bool, int, str]], str, int, bool]
  30. ] = None,
  31. form_method: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  32. form_no_validate: Optional[
  33. Union[Var[Union[bool, int, str]], str, int, bool]
  34. ] = None,
  35. form_target: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  36. name: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  37. type: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  38. value: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  39. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  40. auto_capitalize: Optional[
  41. Union[Var[Union[bool, int, str]], str, int, bool]
  42. ] = None,
  43. content_editable: Optional[
  44. Union[Var[Union[bool, int, str]], str, int, bool]
  45. ] = None,
  46. context_menu: Optional[
  47. Union[Var[Union[bool, int, str]], str, int, bool]
  48. ] = None,
  49. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  50. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  51. enter_key_hint: Optional[
  52. Union[Var[Union[bool, int, str]], str, int, bool]
  53. ] = None,
  54. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  55. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  56. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  57. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  58. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  59. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  60. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  61. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  62. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  63. style: Optional[Style] = None,
  64. key: Optional[Any] = None,
  65. id: Optional[Any] = None,
  66. class_name: Optional[Any] = None,
  67. autofocus: Optional[bool] = None,
  68. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  69. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  70. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  71. on_context_menu: Optional[
  72. Union[EventHandler, EventSpec, list, Callable, Var]
  73. ] = None,
  74. on_double_click: Optional[
  75. Union[EventHandler, EventSpec, list, Callable, Var]
  76. ] = None,
  77. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  78. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  79. on_mouse_down: Optional[
  80. Union[EventHandler, EventSpec, list, Callable, Var]
  81. ] = None,
  82. on_mouse_enter: Optional[
  83. Union[EventHandler, EventSpec, list, Callable, Var]
  84. ] = None,
  85. on_mouse_leave: Optional[
  86. Union[EventHandler, EventSpec, list, Callable, Var]
  87. ] = None,
  88. on_mouse_move: Optional[
  89. Union[EventHandler, EventSpec, list, Callable, Var]
  90. ] = None,
  91. on_mouse_out: Optional[
  92. Union[EventHandler, EventSpec, list, Callable, Var]
  93. ] = None,
  94. on_mouse_over: Optional[
  95. Union[EventHandler, EventSpec, list, Callable, Var]
  96. ] = None,
  97. on_mouse_up: Optional[
  98. Union[EventHandler, EventSpec, list, Callable, Var]
  99. ] = None,
  100. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  101. on_unmount: Optional[
  102. Union[EventHandler, EventSpec, list, Callable, Var]
  103. ] = None,
  104. **props,
  105. ) -> "Button":
  106. """Create the component.
  107. Args:
  108. *children: The children of the component.
  109. auto_focus: Automatically focuses the button when the page loads
  110. disabled: Disables the button
  111. form: Associates the button with a form (by id)
  112. form_action: URL to send the form data to (for type="submit" buttons)
  113. form_enc_type: How the form data should be encoded when submitting to the server (for type="submit" buttons)
  114. form_method: HTTP method to use for sending form data (for type="submit" buttons)
  115. form_no_validate: Bypasses form validation when submitting (for type="submit" buttons)
  116. form_target: Specifies where to display the response after submitting the form (for type="submit" buttons)
  117. name: Name of the button, used when sending form data
  118. type: Type of the button (submit, reset, or button)
  119. value: Value of the button, used when sending form data
  120. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  121. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  122. content_editable: Indicates whether the element's content is editable.
  123. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  124. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  125. draggable: Defines whether the element can be dragged.
  126. enter_key_hint: Hints what media types the media element is able to play.
  127. hidden: Defines whether the element is hidden.
  128. input_mode: Defines the type of the element.
  129. item_prop: Defines the name of the element for metadata purposes.
  130. lang: Defines the language used in the element.
  131. role: Defines the role of the element.
  132. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  133. spell_check: Defines whether the element may be checked for spelling errors.
  134. tab_index: Defines the position of the current element in the tabbing order.
  135. title: Defines a tooltip for the element.
  136. style: The style of the component.
  137. key: A unique key for the component.
  138. id: The id for the component.
  139. class_name: The class name for the component.
  140. autofocus: Whether the component should take the focus once the page is loaded
  141. custom_attrs: custom attribute
  142. **props: The props of the component.
  143. Returns:
  144. The component.
  145. """
  146. ...
  147. class Datalist(BaseHTML):
  148. @overload
  149. @classmethod
  150. def create( # type: ignore
  151. cls,
  152. *children,
  153. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  154. auto_capitalize: Optional[
  155. Union[Var[Union[bool, int, str]], str, int, bool]
  156. ] = None,
  157. content_editable: Optional[
  158. Union[Var[Union[bool, int, str]], str, int, bool]
  159. ] = None,
  160. context_menu: Optional[
  161. Union[Var[Union[bool, int, str]], str, int, bool]
  162. ] = None,
  163. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  164. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  165. enter_key_hint: Optional[
  166. Union[Var[Union[bool, int, str]], str, int, bool]
  167. ] = None,
  168. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  169. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  170. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  171. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  172. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  173. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  174. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  175. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  176. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  177. style: Optional[Style] = None,
  178. key: Optional[Any] = None,
  179. id: Optional[Any] = None,
  180. class_name: Optional[Any] = None,
  181. autofocus: Optional[bool] = None,
  182. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  183. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  184. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  185. on_context_menu: Optional[
  186. Union[EventHandler, EventSpec, list, Callable, Var]
  187. ] = None,
  188. on_double_click: Optional[
  189. Union[EventHandler, EventSpec, list, Callable, Var]
  190. ] = None,
  191. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  192. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  193. on_mouse_down: Optional[
  194. Union[EventHandler, EventSpec, list, Callable, Var]
  195. ] = None,
  196. on_mouse_enter: Optional[
  197. Union[EventHandler, EventSpec, list, Callable, Var]
  198. ] = None,
  199. on_mouse_leave: Optional[
  200. Union[EventHandler, EventSpec, list, Callable, Var]
  201. ] = None,
  202. on_mouse_move: Optional[
  203. Union[EventHandler, EventSpec, list, Callable, Var]
  204. ] = None,
  205. on_mouse_out: Optional[
  206. Union[EventHandler, EventSpec, list, Callable, Var]
  207. ] = None,
  208. on_mouse_over: Optional[
  209. Union[EventHandler, EventSpec, list, Callable, Var]
  210. ] = None,
  211. on_mouse_up: Optional[
  212. Union[EventHandler, EventSpec, list, Callable, Var]
  213. ] = None,
  214. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  215. on_unmount: Optional[
  216. Union[EventHandler, EventSpec, list, Callable, Var]
  217. ] = None,
  218. **props,
  219. ) -> "Datalist":
  220. """Create the component.
  221. Args:
  222. *children: The children of the component.
  223. access_key: No unique attributes, only common ones are inherited Provides a hint for generating a keyboard shortcut for the current element.
  224. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  225. content_editable: Indicates whether the element's content is editable.
  226. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  227. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  228. draggable: Defines whether the element can be dragged.
  229. enter_key_hint: Hints what media types the media element is able to play.
  230. hidden: Defines whether the element is hidden.
  231. input_mode: Defines the type of the element.
  232. item_prop: Defines the name of the element for metadata purposes.
  233. lang: Defines the language used in the element.
  234. role: Defines the role of the element.
  235. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  236. spell_check: Defines whether the element may be checked for spelling errors.
  237. tab_index: Defines the position of the current element in the tabbing order.
  238. title: Defines a tooltip for the element.
  239. style: The style of the component.
  240. key: A unique key for the component.
  241. id: The id for the component.
  242. class_name: The class name for the component.
  243. autofocus: Whether the component should take the focus once the page is loaded
  244. custom_attrs: custom attribute
  245. **props: The props of the component.
  246. Returns:
  247. The component.
  248. """
  249. ...
  250. class Fieldset(Element):
  251. @overload
  252. @classmethod
  253. def create( # type: ignore
  254. cls,
  255. *children,
  256. disabled: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  257. form: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  258. name: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  259. style: Optional[Style] = None,
  260. key: Optional[Any] = None,
  261. id: Optional[Any] = None,
  262. class_name: Optional[Any] = None,
  263. autofocus: Optional[bool] = None,
  264. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  265. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  266. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  267. on_context_menu: Optional[
  268. Union[EventHandler, EventSpec, list, Callable, Var]
  269. ] = None,
  270. on_double_click: Optional[
  271. Union[EventHandler, EventSpec, list, Callable, Var]
  272. ] = None,
  273. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  274. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  275. on_mouse_down: Optional[
  276. Union[EventHandler, EventSpec, list, Callable, Var]
  277. ] = None,
  278. on_mouse_enter: Optional[
  279. Union[EventHandler, EventSpec, list, Callable, Var]
  280. ] = None,
  281. on_mouse_leave: Optional[
  282. Union[EventHandler, EventSpec, list, Callable, Var]
  283. ] = None,
  284. on_mouse_move: Optional[
  285. Union[EventHandler, EventSpec, list, Callable, Var]
  286. ] = None,
  287. on_mouse_out: Optional[
  288. Union[EventHandler, EventSpec, list, Callable, Var]
  289. ] = None,
  290. on_mouse_over: Optional[
  291. Union[EventHandler, EventSpec, list, Callable, Var]
  292. ] = None,
  293. on_mouse_up: Optional[
  294. Union[EventHandler, EventSpec, list, Callable, Var]
  295. ] = None,
  296. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  297. on_unmount: Optional[
  298. Union[EventHandler, EventSpec, list, Callable, Var]
  299. ] = None,
  300. **props,
  301. ) -> "Fieldset":
  302. """Create the component.
  303. Args:
  304. *children: The children of the component.
  305. disabled: Disables all the form control descendants of the fieldset
  306. form: Associates the fieldset with a form (by id)
  307. name: Name of the fieldset, used for scripting
  308. style: The style of the component.
  309. key: A unique key for the component.
  310. id: The id for the component.
  311. class_name: The class name for the component.
  312. autofocus: Whether the component should take the focus once the page is loaded
  313. custom_attrs: custom attribute
  314. **props: The props of the component.
  315. Returns:
  316. The component.
  317. """
  318. ...
  319. class Form(BaseHTML):
  320. @overload
  321. @classmethod
  322. def create( # type: ignore
  323. cls,
  324. *children,
  325. accept: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  326. accept_charset: Optional[
  327. Union[Var[Union[bool, int, str]], str, int, bool]
  328. ] = None,
  329. action: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  330. auto_complete: Optional[
  331. Union[Var[Union[bool, int, str]], str, int, bool]
  332. ] = None,
  333. enc_type: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  334. method: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  335. name: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  336. no_validate: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  337. target: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  338. reset_on_submit: Optional[Union[Var[bool], bool]] = None,
  339. handle_submit_unique_name: Optional[Union[Var[str], str]] = None,
  340. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  341. auto_capitalize: Optional[
  342. Union[Var[Union[bool, int, str]], str, int, bool]
  343. ] = None,
  344. content_editable: Optional[
  345. Union[Var[Union[bool, int, str]], str, int, bool]
  346. ] = None,
  347. context_menu: Optional[
  348. Union[Var[Union[bool, int, str]], str, int, bool]
  349. ] = None,
  350. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  351. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  352. enter_key_hint: Optional[
  353. Union[Var[Union[bool, int, str]], str, int, bool]
  354. ] = None,
  355. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  356. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  357. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  358. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  359. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  360. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  361. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  362. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  363. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  364. style: Optional[Style] = None,
  365. key: Optional[Any] = None,
  366. id: Optional[Any] = None,
  367. class_name: Optional[Any] = None,
  368. autofocus: Optional[bool] = None,
  369. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  370. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  371. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  372. on_context_menu: Optional[
  373. Union[EventHandler, EventSpec, list, Callable, Var]
  374. ] = None,
  375. on_double_click: Optional[
  376. Union[EventHandler, EventSpec, list, Callable, Var]
  377. ] = None,
  378. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  379. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  380. on_mouse_down: Optional[
  381. Union[EventHandler, EventSpec, list, Callable, Var]
  382. ] = None,
  383. on_mouse_enter: Optional[
  384. Union[EventHandler, EventSpec, list, Callable, Var]
  385. ] = None,
  386. on_mouse_leave: Optional[
  387. Union[EventHandler, EventSpec, list, Callable, Var]
  388. ] = None,
  389. on_mouse_move: Optional[
  390. Union[EventHandler, EventSpec, list, Callable, Var]
  391. ] = None,
  392. on_mouse_out: Optional[
  393. Union[EventHandler, EventSpec, list, Callable, Var]
  394. ] = None,
  395. on_mouse_over: Optional[
  396. Union[EventHandler, EventSpec, list, Callable, Var]
  397. ] = None,
  398. on_mouse_up: Optional[
  399. Union[EventHandler, EventSpec, list, Callable, Var]
  400. ] = None,
  401. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  402. on_submit: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  403. on_unmount: Optional[
  404. Union[EventHandler, EventSpec, list, Callable, Var]
  405. ] = None,
  406. **props,
  407. ) -> "Form":
  408. """Create a form component.
  409. Args:
  410. *children: The children of the form.
  411. accept: MIME types the server accepts for file upload
  412. accept_charset: Character encodings to be used for form submission
  413. action: URL where the form's data should be submitted
  414. auto_complete: Whether the form should have autocomplete enabled
  415. enc_type: Encoding type for the form data when submitted
  416. method: HTTP method to use for form submission
  417. name: Name of the form
  418. no_validate: Indicates that the form should not be validated on submit
  419. target: Where to display the response after submitting the form
  420. reset_on_submit: If true, the form will be cleared after submit.
  421. handle_submit_unique_name: The name used to make this form's submit handler function unique.
  422. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  423. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  424. content_editable: Indicates whether the element's content is editable.
  425. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  426. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  427. draggable: Defines whether the element can be dragged.
  428. enter_key_hint: Hints what media types the media element is able to play.
  429. hidden: Defines whether the element is hidden.
  430. input_mode: Defines the type of the element.
  431. item_prop: Defines the name of the element for metadata purposes.
  432. lang: Defines the language used in the element.
  433. role: Defines the role of the element.
  434. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  435. spell_check: Defines whether the element may be checked for spelling errors.
  436. tab_index: Defines the position of the current element in the tabbing order.
  437. title: Defines a tooltip for the element.
  438. style: The style of the component.
  439. key: A unique key for the component.
  440. id: The id for the component.
  441. class_name: The class name for the component.
  442. autofocus: Whether the component should take the focus once the page is loaded
  443. custom_attrs: custom attribute
  444. **props: The properties of the form.
  445. Returns:
  446. The form component.
  447. """
  448. ...
  449. def add_imports(self) -> ImportDict: ...
  450. def add_hooks(self) -> list[str]: ...
  451. class Input(BaseHTML):
  452. @overload
  453. @classmethod
  454. def create( # type: ignore
  455. cls,
  456. *children,
  457. accept: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  458. alt: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  459. auto_complete: Optional[
  460. Union[Var[Union[bool, int, str]], str, int, bool]
  461. ] = None,
  462. auto_focus: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  463. capture: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  464. checked: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  465. default_checked: Optional[Union[Var[bool], bool]] = None,
  466. default_value: Optional[Union[Var[str], str]] = None,
  467. dirname: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  468. disabled: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  469. form: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  470. form_action: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  471. form_enc_type: Optional[
  472. Union[Var[Union[bool, int, str]], str, int, bool]
  473. ] = None,
  474. form_method: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  475. form_no_validate: Optional[
  476. Union[Var[Union[bool, int, str]], str, int, bool]
  477. ] = None,
  478. form_target: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  479. list: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  480. max: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  481. max_length: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  482. min_length: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  483. min: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  484. multiple: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  485. name: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  486. pattern: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  487. placeholder: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  488. read_only: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  489. required: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  490. size: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  491. src: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  492. step: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  493. type: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  494. use_map: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  495. value: Optional[Union[Var[Union[float, int, str]], str, int, float]] = None,
  496. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  497. auto_capitalize: Optional[
  498. Union[Var[Union[bool, int, str]], str, int, bool]
  499. ] = None,
  500. content_editable: Optional[
  501. Union[Var[Union[bool, int, str]], str, int, bool]
  502. ] = None,
  503. context_menu: Optional[
  504. Union[Var[Union[bool, int, str]], str, int, bool]
  505. ] = None,
  506. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  507. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  508. enter_key_hint: Optional[
  509. Union[Var[Union[bool, int, str]], str, int, bool]
  510. ] = None,
  511. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  512. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  513. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  514. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  515. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  516. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  517. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  518. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  519. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  520. style: Optional[Style] = None,
  521. key: Optional[Any] = None,
  522. id: Optional[Any] = None,
  523. class_name: Optional[Any] = None,
  524. autofocus: Optional[bool] = None,
  525. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  526. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  527. on_change: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  528. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  529. on_context_menu: Optional[
  530. Union[EventHandler, EventSpec, list, Callable, Var]
  531. ] = None,
  532. on_double_click: Optional[
  533. Union[EventHandler, EventSpec, list, Callable, Var]
  534. ] = None,
  535. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  536. on_key_down: Optional[
  537. Union[EventHandler, EventSpec, list, Callable, Var]
  538. ] = None,
  539. on_key_up: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  540. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  541. on_mouse_down: Optional[
  542. Union[EventHandler, EventSpec, list, Callable, Var]
  543. ] = None,
  544. on_mouse_enter: Optional[
  545. Union[EventHandler, EventSpec, list, Callable, Var]
  546. ] = None,
  547. on_mouse_leave: Optional[
  548. Union[EventHandler, EventSpec, list, Callable, Var]
  549. ] = None,
  550. on_mouse_move: Optional[
  551. Union[EventHandler, EventSpec, list, Callable, Var]
  552. ] = None,
  553. on_mouse_out: Optional[
  554. Union[EventHandler, EventSpec, list, Callable, Var]
  555. ] = None,
  556. on_mouse_over: Optional[
  557. Union[EventHandler, EventSpec, list, Callable, Var]
  558. ] = None,
  559. on_mouse_up: Optional[
  560. Union[EventHandler, EventSpec, list, Callable, Var]
  561. ] = None,
  562. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  563. on_unmount: Optional[
  564. Union[EventHandler, EventSpec, list, Callable, Var]
  565. ] = None,
  566. **props,
  567. ) -> "Input":
  568. """Create the component.
  569. Args:
  570. *children: The children of the component.
  571. accept: Accepted types of files when the input is file type
  572. alt: Alternate text for input type="image"
  573. auto_complete: Whether the input should have autocomplete enabled
  574. auto_focus: Automatically focuses the input when the page loads
  575. capture: Captures media from the user (camera or microphone)
  576. checked: Indicates whether the input is checked (for checkboxes and radio buttons)
  577. default_checked: The initial value (for checkboxes and radio buttons)
  578. default_value: The initial value for a text field
  579. dirname: Name part of the input to submit in 'dir' and 'name' pair when form is submitted
  580. disabled: Disables the input
  581. form: Associates the input with a form (by id)
  582. form_action: URL to send the form data to (for type="submit" buttons)
  583. form_enc_type: How the form data should be encoded when submitting to the server (for type="submit" buttons)
  584. form_method: HTTP method to use for sending form data (for type="submit" buttons)
  585. form_no_validate: Bypasses form validation when submitting (for type="submit" buttons)
  586. form_target: Specifies where to display the response after submitting the form (for type="submit" buttons)
  587. list: References a datalist for suggested options
  588. max: Specifies the maximum value for the input
  589. max_length: Specifies the maximum number of characters allowed in the input
  590. min_length: Specifies the minimum number of characters required in the input
  591. min: Specifies the minimum value for the input
  592. multiple: Indicates whether multiple values can be entered in an input of the type email or file
  593. name: Name of the input, used when sending form data
  594. pattern: Regex pattern the input's value must match to be valid
  595. placeholder: Placeholder text in the input
  596. read_only: Indicates whether the input is read-only
  597. required: Indicates that the input is required
  598. size: Specifies the visible width of a text control
  599. src: URL for image inputs
  600. step: Specifies the legal number intervals for an input
  601. type: Specifies the type of input
  602. use_map: Name of the image map used with the input
  603. value: Value of the input
  604. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  605. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  606. content_editable: Indicates whether the element's content is editable.
  607. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  608. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  609. draggable: Defines whether the element can be dragged.
  610. enter_key_hint: Hints what media types the media element is able to play.
  611. hidden: Defines whether the element is hidden.
  612. input_mode: Defines the type of the element.
  613. item_prop: Defines the name of the element for metadata purposes.
  614. lang: Defines the language used in the element.
  615. role: Defines the role of the element.
  616. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  617. spell_check: Defines whether the element may be checked for spelling errors.
  618. tab_index: Defines the position of the current element in the tabbing order.
  619. title: Defines a tooltip for the element.
  620. style: The style of the component.
  621. key: A unique key for the component.
  622. id: The id for the component.
  623. class_name: The class name for the component.
  624. autofocus: Whether the component should take the focus once the page is loaded
  625. custom_attrs: custom attribute
  626. **props: The props of the component.
  627. Returns:
  628. The component.
  629. """
  630. ...
  631. class Label(BaseHTML):
  632. @overload
  633. @classmethod
  634. def create( # type: ignore
  635. cls,
  636. *children,
  637. html_for: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  638. form: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  639. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  640. auto_capitalize: Optional[
  641. Union[Var[Union[bool, int, str]], str, int, bool]
  642. ] = None,
  643. content_editable: Optional[
  644. Union[Var[Union[bool, int, str]], str, int, bool]
  645. ] = None,
  646. context_menu: Optional[
  647. Union[Var[Union[bool, int, str]], str, int, bool]
  648. ] = None,
  649. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  650. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  651. enter_key_hint: Optional[
  652. Union[Var[Union[bool, int, str]], str, int, bool]
  653. ] = None,
  654. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  655. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  656. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  657. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  658. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  659. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  660. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  661. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  662. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  663. style: Optional[Style] = None,
  664. key: Optional[Any] = None,
  665. id: Optional[Any] = None,
  666. class_name: Optional[Any] = None,
  667. autofocus: Optional[bool] = None,
  668. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  669. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  670. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  671. on_context_menu: Optional[
  672. Union[EventHandler, EventSpec, list, Callable, Var]
  673. ] = None,
  674. on_double_click: Optional[
  675. Union[EventHandler, EventSpec, list, Callable, Var]
  676. ] = None,
  677. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  678. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  679. on_mouse_down: Optional[
  680. Union[EventHandler, EventSpec, list, Callable, Var]
  681. ] = None,
  682. on_mouse_enter: Optional[
  683. Union[EventHandler, EventSpec, list, Callable, Var]
  684. ] = None,
  685. on_mouse_leave: Optional[
  686. Union[EventHandler, EventSpec, list, Callable, Var]
  687. ] = None,
  688. on_mouse_move: Optional[
  689. Union[EventHandler, EventSpec, list, Callable, Var]
  690. ] = None,
  691. on_mouse_out: Optional[
  692. Union[EventHandler, EventSpec, list, Callable, Var]
  693. ] = None,
  694. on_mouse_over: Optional[
  695. Union[EventHandler, EventSpec, list, Callable, Var]
  696. ] = None,
  697. on_mouse_up: Optional[
  698. Union[EventHandler, EventSpec, list, Callable, Var]
  699. ] = None,
  700. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  701. on_unmount: Optional[
  702. Union[EventHandler, EventSpec, list, Callable, Var]
  703. ] = None,
  704. **props,
  705. ) -> "Label":
  706. """Create the component.
  707. Args:
  708. *children: The children of the component.
  709. html_for: ID of a form control with which the label is associated
  710. form: Associates the label with a form (by id)
  711. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  712. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  713. content_editable: Indicates whether the element's content is editable.
  714. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  715. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  716. draggable: Defines whether the element can be dragged.
  717. enter_key_hint: Hints what media types the media element is able to play.
  718. hidden: Defines whether the element is hidden.
  719. input_mode: Defines the type of the element.
  720. item_prop: Defines the name of the element for metadata purposes.
  721. lang: Defines the language used in the element.
  722. role: Defines the role of the element.
  723. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  724. spell_check: Defines whether the element may be checked for spelling errors.
  725. tab_index: Defines the position of the current element in the tabbing order.
  726. title: Defines a tooltip for the element.
  727. style: The style of the component.
  728. key: A unique key for the component.
  729. id: The id for the component.
  730. class_name: The class name for the component.
  731. autofocus: Whether the component should take the focus once the page is loaded
  732. custom_attrs: custom attribute
  733. **props: The props of the component.
  734. Returns:
  735. The component.
  736. """
  737. ...
  738. class Legend(BaseHTML):
  739. @overload
  740. @classmethod
  741. def create( # type: ignore
  742. cls,
  743. *children,
  744. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  745. auto_capitalize: Optional[
  746. Union[Var[Union[bool, int, str]], str, int, bool]
  747. ] = None,
  748. content_editable: Optional[
  749. Union[Var[Union[bool, int, str]], str, int, bool]
  750. ] = None,
  751. context_menu: Optional[
  752. Union[Var[Union[bool, int, str]], str, int, bool]
  753. ] = None,
  754. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  755. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  756. enter_key_hint: Optional[
  757. Union[Var[Union[bool, int, str]], str, int, bool]
  758. ] = None,
  759. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  760. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  761. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  762. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  763. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  764. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  765. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  766. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  767. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  768. style: Optional[Style] = None,
  769. key: Optional[Any] = None,
  770. id: Optional[Any] = None,
  771. class_name: Optional[Any] = None,
  772. autofocus: Optional[bool] = None,
  773. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  774. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  775. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  776. on_context_menu: Optional[
  777. Union[EventHandler, EventSpec, list, Callable, Var]
  778. ] = None,
  779. on_double_click: Optional[
  780. Union[EventHandler, EventSpec, list, Callable, Var]
  781. ] = None,
  782. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  783. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  784. on_mouse_down: Optional[
  785. Union[EventHandler, EventSpec, list, Callable, Var]
  786. ] = None,
  787. on_mouse_enter: Optional[
  788. Union[EventHandler, EventSpec, list, Callable, Var]
  789. ] = None,
  790. on_mouse_leave: Optional[
  791. Union[EventHandler, EventSpec, list, Callable, Var]
  792. ] = None,
  793. on_mouse_move: Optional[
  794. Union[EventHandler, EventSpec, list, Callable, Var]
  795. ] = None,
  796. on_mouse_out: Optional[
  797. Union[EventHandler, EventSpec, list, Callable, Var]
  798. ] = None,
  799. on_mouse_over: Optional[
  800. Union[EventHandler, EventSpec, list, Callable, Var]
  801. ] = None,
  802. on_mouse_up: Optional[
  803. Union[EventHandler, EventSpec, list, Callable, Var]
  804. ] = None,
  805. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  806. on_unmount: Optional[
  807. Union[EventHandler, EventSpec, list, Callable, Var]
  808. ] = None,
  809. **props,
  810. ) -> "Legend":
  811. """Create the component.
  812. Args:
  813. *children: The children of the component.
  814. access_key: No unique attributes, only common ones are inherited Provides a hint for generating a keyboard shortcut for the current element.
  815. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  816. content_editable: Indicates whether the element's content is editable.
  817. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  818. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  819. draggable: Defines whether the element can be dragged.
  820. enter_key_hint: Hints what media types the media element is able to play.
  821. hidden: Defines whether the element is hidden.
  822. input_mode: Defines the type of the element.
  823. item_prop: Defines the name of the element for metadata purposes.
  824. lang: Defines the language used in the element.
  825. role: Defines the role of the element.
  826. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  827. spell_check: Defines whether the element may be checked for spelling errors.
  828. tab_index: Defines the position of the current element in the tabbing order.
  829. title: Defines a tooltip for the element.
  830. style: The style of the component.
  831. key: A unique key for the component.
  832. id: The id for the component.
  833. class_name: The class name for the component.
  834. autofocus: Whether the component should take the focus once the page is loaded
  835. custom_attrs: custom attribute
  836. **props: The props of the component.
  837. Returns:
  838. The component.
  839. """
  840. ...
  841. class Meter(BaseHTML):
  842. @overload
  843. @classmethod
  844. def create( # type: ignore
  845. cls,
  846. *children,
  847. form: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  848. high: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  849. low: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  850. max: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  851. min: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  852. optimum: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  853. value: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  854. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  855. auto_capitalize: Optional[
  856. Union[Var[Union[bool, int, str]], str, int, bool]
  857. ] = None,
  858. content_editable: Optional[
  859. Union[Var[Union[bool, int, str]], str, int, bool]
  860. ] = None,
  861. context_menu: Optional[
  862. Union[Var[Union[bool, int, str]], str, int, bool]
  863. ] = None,
  864. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  865. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  866. enter_key_hint: Optional[
  867. Union[Var[Union[bool, int, str]], str, int, bool]
  868. ] = None,
  869. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  870. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  871. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  872. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  873. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  874. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  875. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  876. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  877. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  878. style: Optional[Style] = None,
  879. key: Optional[Any] = None,
  880. id: Optional[Any] = None,
  881. class_name: Optional[Any] = None,
  882. autofocus: Optional[bool] = None,
  883. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  884. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  885. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  886. on_context_menu: Optional[
  887. Union[EventHandler, EventSpec, list, Callable, Var]
  888. ] = None,
  889. on_double_click: Optional[
  890. Union[EventHandler, EventSpec, list, Callable, Var]
  891. ] = None,
  892. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  893. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  894. on_mouse_down: Optional[
  895. Union[EventHandler, EventSpec, list, Callable, Var]
  896. ] = None,
  897. on_mouse_enter: Optional[
  898. Union[EventHandler, EventSpec, list, Callable, Var]
  899. ] = None,
  900. on_mouse_leave: Optional[
  901. Union[EventHandler, EventSpec, list, Callable, Var]
  902. ] = None,
  903. on_mouse_move: Optional[
  904. Union[EventHandler, EventSpec, list, Callable, Var]
  905. ] = None,
  906. on_mouse_out: Optional[
  907. Union[EventHandler, EventSpec, list, Callable, Var]
  908. ] = None,
  909. on_mouse_over: Optional[
  910. Union[EventHandler, EventSpec, list, Callable, Var]
  911. ] = None,
  912. on_mouse_up: Optional[
  913. Union[EventHandler, EventSpec, list, Callable, Var]
  914. ] = None,
  915. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  916. on_unmount: Optional[
  917. Union[EventHandler, EventSpec, list, Callable, Var]
  918. ] = None,
  919. **props,
  920. ) -> "Meter":
  921. """Create the component.
  922. Args:
  923. *children: The children of the component.
  924. form: Associates the meter with a form (by id)
  925. high: High limit of range (above this is considered high value)
  926. low: Low limit of range (below this is considered low value)
  927. max: Maximum value of the range
  928. min: Minimum value of the range
  929. optimum: Optimum value in the range
  930. value: Current value of the meter
  931. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  932. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  933. content_editable: Indicates whether the element's content is editable.
  934. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  935. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  936. draggable: Defines whether the element can be dragged.
  937. enter_key_hint: Hints what media types the media element is able to play.
  938. hidden: Defines whether the element is hidden.
  939. input_mode: Defines the type of the element.
  940. item_prop: Defines the name of the element for metadata purposes.
  941. lang: Defines the language used in the element.
  942. role: Defines the role of the element.
  943. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  944. spell_check: Defines whether the element may be checked for spelling errors.
  945. tab_index: Defines the position of the current element in the tabbing order.
  946. title: Defines a tooltip for the element.
  947. style: The style of the component.
  948. key: A unique key for the component.
  949. id: The id for the component.
  950. class_name: The class name for the component.
  951. autofocus: Whether the component should take the focus once the page is loaded
  952. custom_attrs: custom attribute
  953. **props: The props of the component.
  954. Returns:
  955. The component.
  956. """
  957. ...
  958. class Optgroup(BaseHTML):
  959. @overload
  960. @classmethod
  961. def create( # type: ignore
  962. cls,
  963. *children,
  964. disabled: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  965. label: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  966. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  967. auto_capitalize: Optional[
  968. Union[Var[Union[bool, int, str]], str, int, bool]
  969. ] = None,
  970. content_editable: Optional[
  971. Union[Var[Union[bool, int, str]], str, int, bool]
  972. ] = None,
  973. context_menu: Optional[
  974. Union[Var[Union[bool, int, str]], str, int, bool]
  975. ] = None,
  976. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  977. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  978. enter_key_hint: Optional[
  979. Union[Var[Union[bool, int, str]], str, int, bool]
  980. ] = None,
  981. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  982. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  983. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  984. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  985. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  986. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  987. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  988. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  989. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  990. style: Optional[Style] = None,
  991. key: Optional[Any] = None,
  992. id: Optional[Any] = None,
  993. class_name: Optional[Any] = None,
  994. autofocus: Optional[bool] = None,
  995. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  996. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  997. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  998. on_context_menu: Optional[
  999. Union[EventHandler, EventSpec, list, Callable, Var]
  1000. ] = None,
  1001. on_double_click: Optional[
  1002. Union[EventHandler, EventSpec, list, Callable, Var]
  1003. ] = None,
  1004. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1005. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1006. on_mouse_down: Optional[
  1007. Union[EventHandler, EventSpec, list, Callable, Var]
  1008. ] = None,
  1009. on_mouse_enter: Optional[
  1010. Union[EventHandler, EventSpec, list, Callable, Var]
  1011. ] = None,
  1012. on_mouse_leave: Optional[
  1013. Union[EventHandler, EventSpec, list, Callable, Var]
  1014. ] = None,
  1015. on_mouse_move: Optional[
  1016. Union[EventHandler, EventSpec, list, Callable, Var]
  1017. ] = None,
  1018. on_mouse_out: Optional[
  1019. Union[EventHandler, EventSpec, list, Callable, Var]
  1020. ] = None,
  1021. on_mouse_over: Optional[
  1022. Union[EventHandler, EventSpec, list, Callable, Var]
  1023. ] = None,
  1024. on_mouse_up: Optional[
  1025. Union[EventHandler, EventSpec, list, Callable, Var]
  1026. ] = None,
  1027. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1028. on_unmount: Optional[
  1029. Union[EventHandler, EventSpec, list, Callable, Var]
  1030. ] = None,
  1031. **props,
  1032. ) -> "Optgroup":
  1033. """Create the component.
  1034. Args:
  1035. *children: The children of the component.
  1036. disabled: Disables the optgroup
  1037. label: Label for the optgroup
  1038. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1039. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1040. content_editable: Indicates whether the element's content is editable.
  1041. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1042. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1043. draggable: Defines whether the element can be dragged.
  1044. enter_key_hint: Hints what media types the media element is able to play.
  1045. hidden: Defines whether the element is hidden.
  1046. input_mode: Defines the type of the element.
  1047. item_prop: Defines the name of the element for metadata purposes.
  1048. lang: Defines the language used in the element.
  1049. role: Defines the role of the element.
  1050. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1051. spell_check: Defines whether the element may be checked for spelling errors.
  1052. tab_index: Defines the position of the current element in the tabbing order.
  1053. title: Defines a tooltip for the element.
  1054. style: The style of the component.
  1055. key: A unique key for the component.
  1056. id: The id for the component.
  1057. class_name: The class name for the component.
  1058. autofocus: Whether the component should take the focus once the page is loaded
  1059. custom_attrs: custom attribute
  1060. **props: The props of the component.
  1061. Returns:
  1062. The component.
  1063. """
  1064. ...
  1065. class Option(BaseHTML):
  1066. @overload
  1067. @classmethod
  1068. def create( # type: ignore
  1069. cls,
  1070. *children,
  1071. disabled: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1072. label: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1073. selected: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1074. value: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1075. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1076. auto_capitalize: Optional[
  1077. Union[Var[Union[bool, int, str]], str, int, bool]
  1078. ] = None,
  1079. content_editable: Optional[
  1080. Union[Var[Union[bool, int, str]], str, int, bool]
  1081. ] = None,
  1082. context_menu: Optional[
  1083. Union[Var[Union[bool, int, str]], str, int, bool]
  1084. ] = None,
  1085. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1086. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1087. enter_key_hint: Optional[
  1088. Union[Var[Union[bool, int, str]], str, int, bool]
  1089. ] = None,
  1090. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1091. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1092. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1093. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1094. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1095. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1096. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1097. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1098. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1099. style: Optional[Style] = None,
  1100. key: Optional[Any] = None,
  1101. id: Optional[Any] = None,
  1102. class_name: Optional[Any] = None,
  1103. autofocus: Optional[bool] = None,
  1104. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1105. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1106. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1107. on_context_menu: Optional[
  1108. Union[EventHandler, EventSpec, list, Callable, Var]
  1109. ] = None,
  1110. on_double_click: Optional[
  1111. Union[EventHandler, EventSpec, list, Callable, Var]
  1112. ] = None,
  1113. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1114. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1115. on_mouse_down: Optional[
  1116. Union[EventHandler, EventSpec, list, Callable, Var]
  1117. ] = None,
  1118. on_mouse_enter: Optional[
  1119. Union[EventHandler, EventSpec, list, Callable, Var]
  1120. ] = None,
  1121. on_mouse_leave: Optional[
  1122. Union[EventHandler, EventSpec, list, Callable, Var]
  1123. ] = None,
  1124. on_mouse_move: Optional[
  1125. Union[EventHandler, EventSpec, list, Callable, Var]
  1126. ] = None,
  1127. on_mouse_out: Optional[
  1128. Union[EventHandler, EventSpec, list, Callable, Var]
  1129. ] = None,
  1130. on_mouse_over: Optional[
  1131. Union[EventHandler, EventSpec, list, Callable, Var]
  1132. ] = None,
  1133. on_mouse_up: Optional[
  1134. Union[EventHandler, EventSpec, list, Callable, Var]
  1135. ] = None,
  1136. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1137. on_unmount: Optional[
  1138. Union[EventHandler, EventSpec, list, Callable, Var]
  1139. ] = None,
  1140. **props,
  1141. ) -> "Option":
  1142. """Create the component.
  1143. Args:
  1144. *children: The children of the component.
  1145. disabled: Disables the option
  1146. label: Label for the option, if the text is not the label
  1147. selected: Indicates that the option is initially selected
  1148. value: Value to be sent as form data
  1149. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1150. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1151. content_editable: Indicates whether the element's content is editable.
  1152. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1153. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1154. draggable: Defines whether the element can be dragged.
  1155. enter_key_hint: Hints what media types the media element is able to play.
  1156. hidden: Defines whether the element is hidden.
  1157. input_mode: Defines the type of the element.
  1158. item_prop: Defines the name of the element for metadata purposes.
  1159. lang: Defines the language used in the element.
  1160. role: Defines the role of the element.
  1161. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1162. spell_check: Defines whether the element may be checked for spelling errors.
  1163. tab_index: Defines the position of the current element in the tabbing order.
  1164. title: Defines a tooltip for the element.
  1165. style: The style of the component.
  1166. key: A unique key for the component.
  1167. id: The id for the component.
  1168. class_name: The class name for the component.
  1169. autofocus: Whether the component should take the focus once the page is loaded
  1170. custom_attrs: custom attribute
  1171. **props: The props of the component.
  1172. Returns:
  1173. The component.
  1174. """
  1175. ...
  1176. class Output(BaseHTML):
  1177. @overload
  1178. @classmethod
  1179. def create( # type: ignore
  1180. cls,
  1181. *children,
  1182. html_for: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1183. form: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1184. name: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1185. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1186. auto_capitalize: Optional[
  1187. Union[Var[Union[bool, int, str]], str, int, bool]
  1188. ] = None,
  1189. content_editable: Optional[
  1190. Union[Var[Union[bool, int, str]], str, int, bool]
  1191. ] = None,
  1192. context_menu: Optional[
  1193. Union[Var[Union[bool, int, str]], str, int, bool]
  1194. ] = None,
  1195. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1196. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1197. enter_key_hint: Optional[
  1198. Union[Var[Union[bool, int, str]], str, int, bool]
  1199. ] = None,
  1200. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1201. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1202. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1203. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1204. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1205. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1206. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1207. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1208. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1209. style: Optional[Style] = None,
  1210. key: Optional[Any] = None,
  1211. id: Optional[Any] = None,
  1212. class_name: Optional[Any] = None,
  1213. autofocus: Optional[bool] = None,
  1214. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1215. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1216. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1217. on_context_menu: Optional[
  1218. Union[EventHandler, EventSpec, list, Callable, Var]
  1219. ] = None,
  1220. on_double_click: Optional[
  1221. Union[EventHandler, EventSpec, list, Callable, Var]
  1222. ] = None,
  1223. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1224. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1225. on_mouse_down: Optional[
  1226. Union[EventHandler, EventSpec, list, Callable, Var]
  1227. ] = None,
  1228. on_mouse_enter: Optional[
  1229. Union[EventHandler, EventSpec, list, Callable, Var]
  1230. ] = None,
  1231. on_mouse_leave: Optional[
  1232. Union[EventHandler, EventSpec, list, Callable, Var]
  1233. ] = None,
  1234. on_mouse_move: Optional[
  1235. Union[EventHandler, EventSpec, list, Callable, Var]
  1236. ] = None,
  1237. on_mouse_out: Optional[
  1238. Union[EventHandler, EventSpec, list, Callable, Var]
  1239. ] = None,
  1240. on_mouse_over: Optional[
  1241. Union[EventHandler, EventSpec, list, Callable, Var]
  1242. ] = None,
  1243. on_mouse_up: Optional[
  1244. Union[EventHandler, EventSpec, list, Callable, Var]
  1245. ] = None,
  1246. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1247. on_unmount: Optional[
  1248. Union[EventHandler, EventSpec, list, Callable, Var]
  1249. ] = None,
  1250. **props,
  1251. ) -> "Output":
  1252. """Create the component.
  1253. Args:
  1254. *children: The children of the component.
  1255. html_for: Associates the output with one or more elements (by their IDs)
  1256. form: Associates the output with a form (by id)
  1257. name: Name of the output element for form submission
  1258. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1259. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1260. content_editable: Indicates whether the element's content is editable.
  1261. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1262. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1263. draggable: Defines whether the element can be dragged.
  1264. enter_key_hint: Hints what media types the media element is able to play.
  1265. hidden: Defines whether the element is hidden.
  1266. input_mode: Defines the type of the element.
  1267. item_prop: Defines the name of the element for metadata purposes.
  1268. lang: Defines the language used in the element.
  1269. role: Defines the role of the element.
  1270. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1271. spell_check: Defines whether the element may be checked for spelling errors.
  1272. tab_index: Defines the position of the current element in the tabbing order.
  1273. title: Defines a tooltip for the element.
  1274. style: The style of the component.
  1275. key: A unique key for the component.
  1276. id: The id for the component.
  1277. class_name: The class name for the component.
  1278. autofocus: Whether the component should take the focus once the page is loaded
  1279. custom_attrs: custom attribute
  1280. **props: The props of the component.
  1281. Returns:
  1282. The component.
  1283. """
  1284. ...
  1285. class Progress(BaseHTML):
  1286. @overload
  1287. @classmethod
  1288. def create( # type: ignore
  1289. cls,
  1290. *children,
  1291. form: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1292. max: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1293. value: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1294. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1295. auto_capitalize: Optional[
  1296. Union[Var[Union[bool, int, str]], str, int, bool]
  1297. ] = None,
  1298. content_editable: Optional[
  1299. Union[Var[Union[bool, int, str]], str, int, bool]
  1300. ] = None,
  1301. context_menu: Optional[
  1302. Union[Var[Union[bool, int, str]], str, int, bool]
  1303. ] = None,
  1304. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1305. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1306. enter_key_hint: Optional[
  1307. Union[Var[Union[bool, int, str]], str, int, bool]
  1308. ] = None,
  1309. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1310. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1311. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1312. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1313. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1314. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1315. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1316. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1317. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1318. style: Optional[Style] = None,
  1319. key: Optional[Any] = None,
  1320. id: Optional[Any] = None,
  1321. class_name: Optional[Any] = None,
  1322. autofocus: Optional[bool] = None,
  1323. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1324. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1325. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1326. on_context_menu: Optional[
  1327. Union[EventHandler, EventSpec, list, Callable, Var]
  1328. ] = None,
  1329. on_double_click: Optional[
  1330. Union[EventHandler, EventSpec, list, Callable, Var]
  1331. ] = None,
  1332. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1333. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1334. on_mouse_down: Optional[
  1335. Union[EventHandler, EventSpec, list, Callable, Var]
  1336. ] = None,
  1337. on_mouse_enter: Optional[
  1338. Union[EventHandler, EventSpec, list, Callable, Var]
  1339. ] = None,
  1340. on_mouse_leave: Optional[
  1341. Union[EventHandler, EventSpec, list, Callable, Var]
  1342. ] = None,
  1343. on_mouse_move: Optional[
  1344. Union[EventHandler, EventSpec, list, Callable, Var]
  1345. ] = None,
  1346. on_mouse_out: Optional[
  1347. Union[EventHandler, EventSpec, list, Callable, Var]
  1348. ] = None,
  1349. on_mouse_over: Optional[
  1350. Union[EventHandler, EventSpec, list, Callable, Var]
  1351. ] = None,
  1352. on_mouse_up: Optional[
  1353. Union[EventHandler, EventSpec, list, Callable, Var]
  1354. ] = None,
  1355. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1356. on_unmount: Optional[
  1357. Union[EventHandler, EventSpec, list, Callable, Var]
  1358. ] = None,
  1359. **props,
  1360. ) -> "Progress":
  1361. """Create the component.
  1362. Args:
  1363. *children: The children of the component.
  1364. form: Associates the progress element with a form (by id)
  1365. max: Maximum value of the progress indicator
  1366. value: Current value of the progress indicator
  1367. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1368. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1369. content_editable: Indicates whether the element's content is editable.
  1370. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1371. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1372. draggable: Defines whether the element can be dragged.
  1373. enter_key_hint: Hints what media types the media element is able to play.
  1374. hidden: Defines whether the element is hidden.
  1375. input_mode: Defines the type of the element.
  1376. item_prop: Defines the name of the element for metadata purposes.
  1377. lang: Defines the language used in the element.
  1378. role: Defines the role of the element.
  1379. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1380. spell_check: Defines whether the element may be checked for spelling errors.
  1381. tab_index: Defines the position of the current element in the tabbing order.
  1382. title: Defines a tooltip for the element.
  1383. style: The style of the component.
  1384. key: A unique key for the component.
  1385. id: The id for the component.
  1386. class_name: The class name for the component.
  1387. autofocus: Whether the component should take the focus once the page is loaded
  1388. custom_attrs: custom attribute
  1389. **props: The props of the component.
  1390. Returns:
  1391. The component.
  1392. """
  1393. ...
  1394. class Select(BaseHTML):
  1395. @overload
  1396. @classmethod
  1397. def create( # type: ignore
  1398. cls,
  1399. *children,
  1400. auto_complete: Optional[
  1401. Union[Var[Union[bool, int, str]], str, int, bool]
  1402. ] = None,
  1403. auto_focus: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1404. disabled: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1405. form: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1406. multiple: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1407. name: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1408. required: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1409. size: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1410. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1411. auto_capitalize: Optional[
  1412. Union[Var[Union[bool, int, str]], str, int, bool]
  1413. ] = None,
  1414. content_editable: Optional[
  1415. Union[Var[Union[bool, int, str]], str, int, bool]
  1416. ] = None,
  1417. context_menu: Optional[
  1418. Union[Var[Union[bool, int, str]], str, int, bool]
  1419. ] = None,
  1420. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1421. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1422. enter_key_hint: Optional[
  1423. Union[Var[Union[bool, int, str]], str, int, bool]
  1424. ] = None,
  1425. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1426. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1427. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1428. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1429. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1430. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1431. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1432. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1433. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1434. style: Optional[Style] = None,
  1435. key: Optional[Any] = None,
  1436. id: Optional[Any] = None,
  1437. class_name: Optional[Any] = None,
  1438. autofocus: Optional[bool] = None,
  1439. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1440. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1441. on_change: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1442. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1443. on_context_menu: Optional[
  1444. Union[EventHandler, EventSpec, list, Callable, Var]
  1445. ] = None,
  1446. on_double_click: Optional[
  1447. Union[EventHandler, EventSpec, list, Callable, Var]
  1448. ] = None,
  1449. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1450. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1451. on_mouse_down: Optional[
  1452. Union[EventHandler, EventSpec, list, Callable, Var]
  1453. ] = None,
  1454. on_mouse_enter: Optional[
  1455. Union[EventHandler, EventSpec, list, Callable, Var]
  1456. ] = None,
  1457. on_mouse_leave: Optional[
  1458. Union[EventHandler, EventSpec, list, Callable, Var]
  1459. ] = None,
  1460. on_mouse_move: Optional[
  1461. Union[EventHandler, EventSpec, list, Callable, Var]
  1462. ] = None,
  1463. on_mouse_out: Optional[
  1464. Union[EventHandler, EventSpec, list, Callable, Var]
  1465. ] = None,
  1466. on_mouse_over: Optional[
  1467. Union[EventHandler, EventSpec, list, Callable, Var]
  1468. ] = None,
  1469. on_mouse_up: Optional[
  1470. Union[EventHandler, EventSpec, list, Callable, Var]
  1471. ] = None,
  1472. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1473. on_unmount: Optional[
  1474. Union[EventHandler, EventSpec, list, Callable, Var]
  1475. ] = None,
  1476. **props,
  1477. ) -> "Select":
  1478. """Create the component.
  1479. Args:
  1480. *children: The children of the component.
  1481. auto_complete: Whether the form control should have autocomplete enabled
  1482. auto_focus: Automatically focuses the select when the page loads
  1483. disabled: Disables the select control
  1484. form: Associates the select with a form (by id)
  1485. multiple: Indicates that multiple options can be selected
  1486. name: Name of the select, used when submitting the form
  1487. required: Indicates that the select control must have a selected option
  1488. size: Number of visible options in a drop-down list
  1489. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1490. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1491. content_editable: Indicates whether the element's content is editable.
  1492. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1493. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1494. draggable: Defines whether the element can be dragged.
  1495. enter_key_hint: Hints what media types the media element is able to play.
  1496. hidden: Defines whether the element is hidden.
  1497. input_mode: Defines the type of the element.
  1498. item_prop: Defines the name of the element for metadata purposes.
  1499. lang: Defines the language used in the element.
  1500. role: Defines the role of the element.
  1501. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1502. spell_check: Defines whether the element may be checked for spelling errors.
  1503. tab_index: Defines the position of the current element in the tabbing order.
  1504. title: Defines a tooltip for the element.
  1505. style: The style of the component.
  1506. key: A unique key for the component.
  1507. id: The id for the component.
  1508. class_name: The class name for the component.
  1509. autofocus: Whether the component should take the focus once the page is loaded
  1510. custom_attrs: custom attribute
  1511. **props: The props of the component.
  1512. Returns:
  1513. The component.
  1514. """
  1515. ...
  1516. 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'
  1517. 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"
  1518. class Textarea(BaseHTML):
  1519. @overload
  1520. @classmethod
  1521. def create( # type: ignore
  1522. cls,
  1523. *children,
  1524. auto_complete: Optional[
  1525. Union[Var[Union[bool, int, str]], str, int, bool]
  1526. ] = None,
  1527. auto_focus: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1528. auto_height: Optional[Union[Var[bool], bool]] = None,
  1529. cols: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1530. dirname: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1531. disabled: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1532. enter_key_submit: Optional[Union[Var[bool], bool]] = None,
  1533. form: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1534. max_length: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1535. min_length: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1536. name: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1537. placeholder: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1538. read_only: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1539. required: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1540. rows: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1541. value: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1542. wrap: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1543. access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1544. auto_capitalize: Optional[
  1545. Union[Var[Union[bool, int, str]], str, int, bool]
  1546. ] = None,
  1547. content_editable: Optional[
  1548. Union[Var[Union[bool, int, str]], str, int, bool]
  1549. ] = None,
  1550. context_menu: Optional[
  1551. Union[Var[Union[bool, int, str]], str, int, bool]
  1552. ] = None,
  1553. dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1554. draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1555. enter_key_hint: Optional[
  1556. Union[Var[Union[bool, int, str]], str, int, bool]
  1557. ] = None,
  1558. hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1559. input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1560. item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1561. lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1562. role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1563. slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1564. spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1565. tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1566. title: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
  1567. style: Optional[Style] = None,
  1568. key: Optional[Any] = None,
  1569. id: Optional[Any] = None,
  1570. class_name: Optional[Any] = None,
  1571. autofocus: Optional[bool] = None,
  1572. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  1573. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1574. on_change: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1575. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1576. on_context_menu: Optional[
  1577. Union[EventHandler, EventSpec, list, Callable, Var]
  1578. ] = None,
  1579. on_double_click: Optional[
  1580. Union[EventHandler, EventSpec, list, Callable, Var]
  1581. ] = None,
  1582. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1583. on_key_down: Optional[
  1584. Union[EventHandler, EventSpec, list, Callable, Var]
  1585. ] = None,
  1586. on_key_up: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1587. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1588. on_mouse_down: Optional[
  1589. Union[EventHandler, EventSpec, list, Callable, Var]
  1590. ] = None,
  1591. on_mouse_enter: Optional[
  1592. Union[EventHandler, EventSpec, list, Callable, Var]
  1593. ] = None,
  1594. on_mouse_leave: Optional[
  1595. Union[EventHandler, EventSpec, list, Callable, Var]
  1596. ] = None,
  1597. on_mouse_move: Optional[
  1598. Union[EventHandler, EventSpec, list, Callable, Var]
  1599. ] = None,
  1600. on_mouse_out: Optional[
  1601. Union[EventHandler, EventSpec, list, Callable, Var]
  1602. ] = None,
  1603. on_mouse_over: Optional[
  1604. Union[EventHandler, EventSpec, list, Callable, Var]
  1605. ] = None,
  1606. on_mouse_up: Optional[
  1607. Union[EventHandler, EventSpec, list, Callable, Var]
  1608. ] = None,
  1609. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  1610. on_unmount: Optional[
  1611. Union[EventHandler, EventSpec, list, Callable, Var]
  1612. ] = None,
  1613. **props,
  1614. ) -> "Textarea":
  1615. """Create the component.
  1616. Args:
  1617. *children: The children of the component.
  1618. auto_complete: Whether the form control should have autocomplete enabled
  1619. auto_focus: Automatically focuses the textarea when the page loads
  1620. auto_height: Automatically fit the content height to the text (use min-height with this prop)
  1621. cols: Visible width of the text control, in average character widths
  1622. dirname: Name part of the textarea to submit in 'dir' and 'name' pair when form is submitted
  1623. disabled: Disables the textarea
  1624. enter_key_submit: Enter key submits form (shift-enter adds new line)
  1625. form: Associates the textarea with a form (by id)
  1626. max_length: Maximum number of characters allowed in the textarea
  1627. min_length: Minimum number of characters required in the textarea
  1628. name: Name of the textarea, used when submitting the form
  1629. placeholder: Placeholder text in the textarea
  1630. read_only: Indicates whether the textarea is read-only
  1631. required: Indicates that the textarea is required
  1632. rows: Visible number of lines in the text control
  1633. value: The controlled value of the textarea, read only unless used with on_change
  1634. wrap: How the text in the textarea is to be wrapped when submitting the form
  1635. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  1636. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  1637. content_editable: Indicates whether the element's content is editable.
  1638. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  1639. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  1640. draggable: Defines whether the element can be dragged.
  1641. enter_key_hint: Hints what media types the media element is able to play.
  1642. hidden: Defines whether the element is hidden.
  1643. input_mode: Defines the type of the element.
  1644. item_prop: Defines the name of the element for metadata purposes.
  1645. lang: Defines the language used in the element.
  1646. role: Defines the role of the element.
  1647. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  1648. spell_check: Defines whether the element may be checked for spelling errors.
  1649. tab_index: Defines the position of the current element in the tabbing order.
  1650. title: Defines a tooltip for the element.
  1651. style: The style of the component.
  1652. key: A unique key for the component.
  1653. id: The id for the component.
  1654. class_name: The class name for the component.
  1655. autofocus: Whether the component should take the focus once the page is loaded
  1656. custom_attrs: custom attribute
  1657. **props: The props of the component.
  1658. Returns:
  1659. The component.
  1660. """
  1661. ...
  1662. button = Button.create
  1663. fieldset = Fieldset.create
  1664. form = Form.create
  1665. input = Input.create
  1666. label = Label.create
  1667. legend = Legend.create
  1668. meter = Meter.create
  1669. optgroup = Optgroup.create
  1670. option = Option.create
  1671. output = Output.create
  1672. progress = Progress.create
  1673. select = Select.create
  1674. textarea = Textarea.create