scripts.pyi 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440
  1. """Stub file for reflex/components/el/elements/scripts.py"""
  2. # ------------------- DO NOT EDIT ----------------------
  3. # This file was generated by `reflex/utils/pyi_generator.py`!
  4. # ------------------------------------------------------
  5. from typing import Any, Dict, Literal, Optional, Union, overload
  6. from reflex.vars import Var, BaseVar, ComputedVar
  7. from reflex.event import EventChain, EventHandler, EventSpec
  8. from reflex.style import Style
  9. from typing import Union
  10. from reflex.vars import Var as Var
  11. from .base import BaseHTML
  12. class Canvas(BaseHTML):
  13. @overload
  14. @classmethod
  15. def create( # type: ignore
  16. cls,
  17. *children,
  18. access_key: Optional[
  19. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  20. ] = None,
  21. auto_capitalize: Optional[
  22. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  23. ] = None,
  24. content_editable: Optional[
  25. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  26. ] = None,
  27. context_menu: Optional[
  28. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  29. ] = None,
  30. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  31. draggable: Optional[
  32. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  33. ] = None,
  34. enter_key_hint: Optional[
  35. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  36. ] = None,
  37. hidden: Optional[
  38. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  39. ] = None,
  40. input_mode: Optional[
  41. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  42. ] = None,
  43. item_prop: Optional[
  44. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  45. ] = None,
  46. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  47. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  48. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  49. spell_check: Optional[
  50. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  51. ] = None,
  52. tab_index: Optional[
  53. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  54. ] = None,
  55. title: Optional[
  56. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  57. ] = None,
  58. style: Optional[Style] = None,
  59. key: Optional[Any] = None,
  60. id: Optional[Any] = None,
  61. class_name: Optional[Any] = None,
  62. autofocus: Optional[bool] = None,
  63. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  64. on_blur: Optional[
  65. Union[EventHandler, EventSpec, list, function, BaseVar]
  66. ] = None,
  67. on_click: Optional[
  68. Union[EventHandler, EventSpec, list, function, BaseVar]
  69. ] = None,
  70. on_context_menu: Optional[
  71. Union[EventHandler, EventSpec, list, function, BaseVar]
  72. ] = None,
  73. on_double_click: Optional[
  74. Union[EventHandler, EventSpec, list, function, BaseVar]
  75. ] = None,
  76. on_focus: Optional[
  77. Union[EventHandler, EventSpec, list, function, BaseVar]
  78. ] = None,
  79. on_mount: Optional[
  80. Union[EventHandler, EventSpec, list, function, BaseVar]
  81. ] = None,
  82. on_mouse_down: Optional[
  83. Union[EventHandler, EventSpec, list, function, BaseVar]
  84. ] = None,
  85. on_mouse_enter: Optional[
  86. Union[EventHandler, EventSpec, list, function, BaseVar]
  87. ] = None,
  88. on_mouse_leave: Optional[
  89. Union[EventHandler, EventSpec, list, function, BaseVar]
  90. ] = None,
  91. on_mouse_move: Optional[
  92. Union[EventHandler, EventSpec, list, function, BaseVar]
  93. ] = None,
  94. on_mouse_out: Optional[
  95. Union[EventHandler, EventSpec, list, function, BaseVar]
  96. ] = None,
  97. on_mouse_over: Optional[
  98. Union[EventHandler, EventSpec, list, function, BaseVar]
  99. ] = None,
  100. on_mouse_up: Optional[
  101. Union[EventHandler, EventSpec, list, function, BaseVar]
  102. ] = None,
  103. on_scroll: Optional[
  104. Union[EventHandler, EventSpec, list, function, BaseVar]
  105. ] = None,
  106. on_unmount: Optional[
  107. Union[EventHandler, EventSpec, list, function, BaseVar]
  108. ] = None,
  109. **props
  110. ) -> "Canvas":
  111. """Create the component.
  112. Args:
  113. *children: The children of the component.
  114. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  115. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  116. content_editable: Indicates whether the element's content is editable.
  117. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  118. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  119. draggable: Defines whether the element can be dragged.
  120. enter_key_hint: Hints what media types the media element is able to play.
  121. hidden: Defines whether the element is hidden.
  122. input_mode: Defines the type of the element.
  123. item_prop: Defines the name of the element for metadata purposes.
  124. lang: Defines the language used in the element.
  125. role: Defines the role of the element.
  126. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  127. spell_check: Defines whether the element may be checked for spelling errors.
  128. tab_index: Defines the position of the current element in the tabbing order.
  129. title: Defines a tooltip for the element.
  130. style: The style of the component.
  131. key: A unique key for the component.
  132. id: The id for the component.
  133. class_name: The class name for the component.
  134. autofocus: Whether the component should take the focus once the page is loaded
  135. custom_attrs: custom attribute
  136. **props: The props of the component.
  137. Returns:
  138. The component.
  139. """
  140. ...
  141. class Noscript(BaseHTML):
  142. @overload
  143. @classmethod
  144. def create( # type: ignore
  145. cls,
  146. *children,
  147. access_key: Optional[
  148. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  149. ] = None,
  150. auto_capitalize: Optional[
  151. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  152. ] = None,
  153. content_editable: Optional[
  154. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  155. ] = None,
  156. context_menu: Optional[
  157. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  158. ] = None,
  159. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  160. draggable: Optional[
  161. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  162. ] = None,
  163. enter_key_hint: Optional[
  164. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  165. ] = None,
  166. hidden: Optional[
  167. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  168. ] = None,
  169. input_mode: Optional[
  170. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  171. ] = None,
  172. item_prop: Optional[
  173. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  174. ] = None,
  175. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  176. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  177. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  178. spell_check: Optional[
  179. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  180. ] = None,
  181. tab_index: Optional[
  182. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  183. ] = None,
  184. title: Optional[
  185. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  186. ] = None,
  187. style: Optional[Style] = None,
  188. key: Optional[Any] = None,
  189. id: Optional[Any] = None,
  190. class_name: Optional[Any] = None,
  191. autofocus: Optional[bool] = None,
  192. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  193. on_blur: Optional[
  194. Union[EventHandler, EventSpec, list, function, BaseVar]
  195. ] = None,
  196. on_click: Optional[
  197. Union[EventHandler, EventSpec, list, function, BaseVar]
  198. ] = None,
  199. on_context_menu: Optional[
  200. Union[EventHandler, EventSpec, list, function, BaseVar]
  201. ] = None,
  202. on_double_click: Optional[
  203. Union[EventHandler, EventSpec, list, function, BaseVar]
  204. ] = None,
  205. on_focus: Optional[
  206. Union[EventHandler, EventSpec, list, function, BaseVar]
  207. ] = None,
  208. on_mount: Optional[
  209. Union[EventHandler, EventSpec, list, function, BaseVar]
  210. ] = None,
  211. on_mouse_down: Optional[
  212. Union[EventHandler, EventSpec, list, function, BaseVar]
  213. ] = None,
  214. on_mouse_enter: Optional[
  215. Union[EventHandler, EventSpec, list, function, BaseVar]
  216. ] = None,
  217. on_mouse_leave: Optional[
  218. Union[EventHandler, EventSpec, list, function, BaseVar]
  219. ] = None,
  220. on_mouse_move: Optional[
  221. Union[EventHandler, EventSpec, list, function, BaseVar]
  222. ] = None,
  223. on_mouse_out: Optional[
  224. Union[EventHandler, EventSpec, list, function, BaseVar]
  225. ] = None,
  226. on_mouse_over: Optional[
  227. Union[EventHandler, EventSpec, list, function, BaseVar]
  228. ] = None,
  229. on_mouse_up: Optional[
  230. Union[EventHandler, EventSpec, list, function, BaseVar]
  231. ] = None,
  232. on_scroll: Optional[
  233. Union[EventHandler, EventSpec, list, function, BaseVar]
  234. ] = None,
  235. on_unmount: Optional[
  236. Union[EventHandler, EventSpec, list, function, BaseVar]
  237. ] = None,
  238. **props
  239. ) -> "Noscript":
  240. """Create the component.
  241. Args:
  242. *children: The children of the component.
  243. access_key: No unique attributes, only common ones are inherited Provides a hint for generating a keyboard shortcut for the current element.
  244. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  245. content_editable: Indicates whether the element's content is editable.
  246. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  247. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  248. draggable: Defines whether the element can be dragged.
  249. enter_key_hint: Hints what media types the media element is able to play.
  250. hidden: Defines whether the element is hidden.
  251. input_mode: Defines the type of the element.
  252. item_prop: Defines the name of the element for metadata purposes.
  253. lang: Defines the language used in the element.
  254. role: Defines the role of the element.
  255. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  256. spell_check: Defines whether the element may be checked for spelling errors.
  257. tab_index: Defines the position of the current element in the tabbing order.
  258. title: Defines a tooltip for the element.
  259. style: The style of the component.
  260. key: A unique key for the component.
  261. id: The id for the component.
  262. class_name: The class name for the component.
  263. autofocus: Whether the component should take the focus once the page is loaded
  264. custom_attrs: custom attribute
  265. **props: The props of the component.
  266. Returns:
  267. The component.
  268. """
  269. ...
  270. class Script(BaseHTML):
  271. @overload
  272. @classmethod
  273. def create( # type: ignore
  274. cls,
  275. *children,
  276. async_: Optional[
  277. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  278. ] = None,
  279. char_set: Optional[
  280. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  281. ] = None,
  282. cross_origin: Optional[
  283. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  284. ] = None,
  285. defer: Optional[
  286. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  287. ] = None,
  288. integrity: Optional[
  289. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  290. ] = None,
  291. language: Optional[
  292. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  293. ] = None,
  294. referrer_policy: Optional[
  295. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  296. ] = None,
  297. src: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  298. type: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  299. access_key: Optional[
  300. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  301. ] = None,
  302. auto_capitalize: Optional[
  303. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  304. ] = None,
  305. content_editable: Optional[
  306. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  307. ] = None,
  308. context_menu: Optional[
  309. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  310. ] = None,
  311. dir: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  312. draggable: Optional[
  313. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  314. ] = None,
  315. enter_key_hint: Optional[
  316. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  317. ] = None,
  318. hidden: Optional[
  319. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  320. ] = None,
  321. input_mode: Optional[
  322. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  323. ] = None,
  324. item_prop: Optional[
  325. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  326. ] = None,
  327. lang: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  328. role: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  329. slot: Optional[Union[Var[Union[str, int, bool]], Union[str, int, bool]]] = None,
  330. spell_check: Optional[
  331. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  332. ] = None,
  333. tab_index: Optional[
  334. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  335. ] = None,
  336. title: Optional[
  337. Union[Var[Union[str, int, bool]], Union[str, int, bool]]
  338. ] = None,
  339. style: Optional[Style] = None,
  340. key: Optional[Any] = None,
  341. id: Optional[Any] = None,
  342. class_name: Optional[Any] = None,
  343. autofocus: Optional[bool] = None,
  344. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  345. on_blur: Optional[
  346. Union[EventHandler, EventSpec, list, function, BaseVar]
  347. ] = None,
  348. on_click: Optional[
  349. Union[EventHandler, EventSpec, list, function, BaseVar]
  350. ] = None,
  351. on_context_menu: Optional[
  352. Union[EventHandler, EventSpec, list, function, BaseVar]
  353. ] = None,
  354. on_double_click: Optional[
  355. Union[EventHandler, EventSpec, list, function, BaseVar]
  356. ] = None,
  357. on_focus: Optional[
  358. Union[EventHandler, EventSpec, list, function, BaseVar]
  359. ] = None,
  360. on_mount: Optional[
  361. Union[EventHandler, EventSpec, list, function, BaseVar]
  362. ] = None,
  363. on_mouse_down: Optional[
  364. Union[EventHandler, EventSpec, list, function, BaseVar]
  365. ] = None,
  366. on_mouse_enter: Optional[
  367. Union[EventHandler, EventSpec, list, function, BaseVar]
  368. ] = None,
  369. on_mouse_leave: Optional[
  370. Union[EventHandler, EventSpec, list, function, BaseVar]
  371. ] = None,
  372. on_mouse_move: Optional[
  373. Union[EventHandler, EventSpec, list, function, BaseVar]
  374. ] = None,
  375. on_mouse_out: Optional[
  376. Union[EventHandler, EventSpec, list, function, BaseVar]
  377. ] = None,
  378. on_mouse_over: Optional[
  379. Union[EventHandler, EventSpec, list, function, BaseVar]
  380. ] = None,
  381. on_mouse_up: Optional[
  382. Union[EventHandler, EventSpec, list, function, BaseVar]
  383. ] = None,
  384. on_scroll: Optional[
  385. Union[EventHandler, EventSpec, list, function, BaseVar]
  386. ] = None,
  387. on_unmount: Optional[
  388. Union[EventHandler, EventSpec, list, function, BaseVar]
  389. ] = None,
  390. **props
  391. ) -> "Script":
  392. """Create the component.
  393. Args:
  394. *children: The children of the component.
  395. async_: Indicates that the script should be executed asynchronously
  396. char_set: Character encoding of the external script
  397. cross_origin: Configures the CORS requests for the script
  398. defer: Indicates that the script should be executed after the page has finished parsing
  399. integrity: Security feature allowing browsers to verify what they fetch
  400. language: Specifies the scripting language used in the type attribute
  401. referrer_policy: Specifies which referrer information to send when fetching the script
  402. src: URL of an external script
  403. type: Specifies the MIME type of the script
  404. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  405. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  406. content_editable: Indicates whether the element's content is editable.
  407. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  408. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  409. draggable: Defines whether the element can be dragged.
  410. enter_key_hint: Hints what media types the media element is able to play.
  411. hidden: Defines whether the element is hidden.
  412. input_mode: Defines the type of the element.
  413. item_prop: Defines the name of the element for metadata purposes.
  414. lang: Defines the language used in the element.
  415. role: Defines the role of the element.
  416. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  417. spell_check: Defines whether the element may be checked for spelling errors.
  418. tab_index: Defines the position of the current element in the tabbing order.
  419. title: Defines a tooltip for the element.
  420. style: The style of the component.
  421. key: A unique key for the component.
  422. id: The id for the component.
  423. class_name: The class name for the component.
  424. autofocus: Whether the component should take the focus once the page is loaded
  425. custom_attrs: custom attribute
  426. **props: The props of the component.
  427. Returns:
  428. The component.
  429. """
  430. ...