document.pyi 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407
  1. """Stub file for reflex/components/base/document.py"""
  2. # ------------------- DO NOT EDIT ----------------------
  3. # This file was generated by `scripts/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 Optional
  10. from reflex.components.component import Component
  11. class NextDocumentLib(Component):
  12. @overload
  13. @classmethod
  14. def create( # type: ignore
  15. cls,
  16. *children,
  17. style: Optional[Style] = None,
  18. key: Optional[Any] = None,
  19. id: Optional[Any] = None,
  20. class_name: Optional[Any] = None,
  21. autofocus: Optional[bool] = None,
  22. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  23. on_blur: Optional[
  24. Union[EventHandler, EventSpec, list, function, BaseVar]
  25. ] = None,
  26. on_click: Optional[
  27. Union[EventHandler, EventSpec, list, function, BaseVar]
  28. ] = None,
  29. on_context_menu: Optional[
  30. Union[EventHandler, EventSpec, list, function, BaseVar]
  31. ] = None,
  32. on_double_click: Optional[
  33. Union[EventHandler, EventSpec, list, function, BaseVar]
  34. ] = None,
  35. on_focus: Optional[
  36. Union[EventHandler, EventSpec, list, function, BaseVar]
  37. ] = None,
  38. on_mount: Optional[
  39. Union[EventHandler, EventSpec, list, function, BaseVar]
  40. ] = None,
  41. on_mouse_down: Optional[
  42. Union[EventHandler, EventSpec, list, function, BaseVar]
  43. ] = None,
  44. on_mouse_enter: Optional[
  45. Union[EventHandler, EventSpec, list, function, BaseVar]
  46. ] = None,
  47. on_mouse_leave: Optional[
  48. Union[EventHandler, EventSpec, list, function, BaseVar]
  49. ] = None,
  50. on_mouse_move: Optional[
  51. Union[EventHandler, EventSpec, list, function, BaseVar]
  52. ] = None,
  53. on_mouse_out: Optional[
  54. Union[EventHandler, EventSpec, list, function, BaseVar]
  55. ] = None,
  56. on_mouse_over: Optional[
  57. Union[EventHandler, EventSpec, list, function, BaseVar]
  58. ] = None,
  59. on_mouse_up: Optional[
  60. Union[EventHandler, EventSpec, list, function, BaseVar]
  61. ] = None,
  62. on_scroll: Optional[
  63. Union[EventHandler, EventSpec, list, function, BaseVar]
  64. ] = None,
  65. on_unmount: Optional[
  66. Union[EventHandler, EventSpec, list, function, BaseVar]
  67. ] = None,
  68. **props
  69. ) -> "NextDocumentLib":
  70. """Create the component.
  71. Args:
  72. *children: The children of the component.
  73. style: The style of the component.
  74. key: A unique key for the component.
  75. id: The id for the component.
  76. class_name: The class name for the component.
  77. autofocus: Whether the component should take the focus once the page is loaded
  78. custom_attrs: custom attribute
  79. **props: The props of the component.
  80. Returns:
  81. The component.
  82. Raises:
  83. TypeError: If an invalid child is passed.
  84. """
  85. ...
  86. class Html(NextDocumentLib):
  87. @overload
  88. @classmethod
  89. def create( # type: ignore
  90. cls,
  91. *children,
  92. lang: Optional[str] = None,
  93. style: Optional[Style] = None,
  94. key: Optional[Any] = None,
  95. id: Optional[Any] = None,
  96. class_name: Optional[Any] = None,
  97. autofocus: Optional[bool] = None,
  98. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  99. on_blur: Optional[
  100. Union[EventHandler, EventSpec, list, function, BaseVar]
  101. ] = None,
  102. on_click: Optional[
  103. Union[EventHandler, EventSpec, list, function, BaseVar]
  104. ] = None,
  105. on_context_menu: Optional[
  106. Union[EventHandler, EventSpec, list, function, BaseVar]
  107. ] = None,
  108. on_double_click: Optional[
  109. Union[EventHandler, EventSpec, list, function, BaseVar]
  110. ] = None,
  111. on_focus: Optional[
  112. Union[EventHandler, EventSpec, list, function, BaseVar]
  113. ] = None,
  114. on_mount: Optional[
  115. Union[EventHandler, EventSpec, list, function, BaseVar]
  116. ] = None,
  117. on_mouse_down: Optional[
  118. Union[EventHandler, EventSpec, list, function, BaseVar]
  119. ] = None,
  120. on_mouse_enter: Optional[
  121. Union[EventHandler, EventSpec, list, function, BaseVar]
  122. ] = None,
  123. on_mouse_leave: Optional[
  124. Union[EventHandler, EventSpec, list, function, BaseVar]
  125. ] = None,
  126. on_mouse_move: Optional[
  127. Union[EventHandler, EventSpec, list, function, BaseVar]
  128. ] = None,
  129. on_mouse_out: Optional[
  130. Union[EventHandler, EventSpec, list, function, BaseVar]
  131. ] = None,
  132. on_mouse_over: Optional[
  133. Union[EventHandler, EventSpec, list, function, BaseVar]
  134. ] = None,
  135. on_mouse_up: Optional[
  136. Union[EventHandler, EventSpec, list, function, BaseVar]
  137. ] = None,
  138. on_scroll: Optional[
  139. Union[EventHandler, EventSpec, list, function, BaseVar]
  140. ] = None,
  141. on_unmount: Optional[
  142. Union[EventHandler, EventSpec, list, function, BaseVar]
  143. ] = None,
  144. **props
  145. ) -> "Html":
  146. """Create the component.
  147. Args:
  148. *children: The children of the component.
  149. style: The style of the component.
  150. key: A unique key for the component.
  151. id: The id for the component.
  152. class_name: The class name for the component.
  153. autofocus: Whether the component should take the focus once the page is loaded
  154. custom_attrs: custom attribute
  155. **props: The props of the component.
  156. Returns:
  157. The component.
  158. Raises:
  159. TypeError: If an invalid child is passed.
  160. """
  161. ...
  162. class DocumentHead(NextDocumentLib):
  163. @overload
  164. @classmethod
  165. def create( # type: ignore
  166. cls,
  167. *children,
  168. style: Optional[Style] = None,
  169. key: Optional[Any] = None,
  170. id: Optional[Any] = None,
  171. class_name: Optional[Any] = None,
  172. autofocus: Optional[bool] = None,
  173. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  174. on_blur: Optional[
  175. Union[EventHandler, EventSpec, list, function, BaseVar]
  176. ] = None,
  177. on_click: Optional[
  178. Union[EventHandler, EventSpec, list, function, BaseVar]
  179. ] = None,
  180. on_context_menu: Optional[
  181. Union[EventHandler, EventSpec, list, function, BaseVar]
  182. ] = None,
  183. on_double_click: Optional[
  184. Union[EventHandler, EventSpec, list, function, BaseVar]
  185. ] = None,
  186. on_focus: Optional[
  187. Union[EventHandler, EventSpec, list, function, BaseVar]
  188. ] = None,
  189. on_mount: Optional[
  190. Union[EventHandler, EventSpec, list, function, BaseVar]
  191. ] = None,
  192. on_mouse_down: Optional[
  193. Union[EventHandler, EventSpec, list, function, BaseVar]
  194. ] = None,
  195. on_mouse_enter: Optional[
  196. Union[EventHandler, EventSpec, list, function, BaseVar]
  197. ] = None,
  198. on_mouse_leave: Optional[
  199. Union[EventHandler, EventSpec, list, function, BaseVar]
  200. ] = None,
  201. on_mouse_move: Optional[
  202. Union[EventHandler, EventSpec, list, function, BaseVar]
  203. ] = None,
  204. on_mouse_out: Optional[
  205. Union[EventHandler, EventSpec, list, function, BaseVar]
  206. ] = None,
  207. on_mouse_over: Optional[
  208. Union[EventHandler, EventSpec, list, function, BaseVar]
  209. ] = None,
  210. on_mouse_up: Optional[
  211. Union[EventHandler, EventSpec, list, function, BaseVar]
  212. ] = None,
  213. on_scroll: Optional[
  214. Union[EventHandler, EventSpec, list, function, BaseVar]
  215. ] = None,
  216. on_unmount: Optional[
  217. Union[EventHandler, EventSpec, list, function, BaseVar]
  218. ] = None,
  219. **props
  220. ) -> "DocumentHead":
  221. """Create the component.
  222. Args:
  223. *children: The children of the component.
  224. style: The style of the component.
  225. key: A unique key for the component.
  226. id: The id for the component.
  227. class_name: The class name for the component.
  228. autofocus: Whether the component should take the focus once the page is loaded
  229. custom_attrs: custom attribute
  230. **props: The props of the component.
  231. Returns:
  232. The component.
  233. Raises:
  234. TypeError: If an invalid child is passed.
  235. """
  236. ...
  237. class Main(NextDocumentLib):
  238. @overload
  239. @classmethod
  240. def create( # type: ignore
  241. cls,
  242. *children,
  243. style: Optional[Style] = None,
  244. key: Optional[Any] = None,
  245. id: Optional[Any] = None,
  246. class_name: Optional[Any] = None,
  247. autofocus: Optional[bool] = None,
  248. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  249. on_blur: Optional[
  250. Union[EventHandler, EventSpec, list, function, BaseVar]
  251. ] = None,
  252. on_click: Optional[
  253. Union[EventHandler, EventSpec, list, function, BaseVar]
  254. ] = None,
  255. on_context_menu: Optional[
  256. Union[EventHandler, EventSpec, list, function, BaseVar]
  257. ] = None,
  258. on_double_click: Optional[
  259. Union[EventHandler, EventSpec, list, function, BaseVar]
  260. ] = None,
  261. on_focus: Optional[
  262. Union[EventHandler, EventSpec, list, function, BaseVar]
  263. ] = None,
  264. on_mount: Optional[
  265. Union[EventHandler, EventSpec, list, function, BaseVar]
  266. ] = None,
  267. on_mouse_down: Optional[
  268. Union[EventHandler, EventSpec, list, function, BaseVar]
  269. ] = None,
  270. on_mouse_enter: Optional[
  271. Union[EventHandler, EventSpec, list, function, BaseVar]
  272. ] = None,
  273. on_mouse_leave: Optional[
  274. Union[EventHandler, EventSpec, list, function, BaseVar]
  275. ] = None,
  276. on_mouse_move: Optional[
  277. Union[EventHandler, EventSpec, list, function, BaseVar]
  278. ] = None,
  279. on_mouse_out: Optional[
  280. Union[EventHandler, EventSpec, list, function, BaseVar]
  281. ] = None,
  282. on_mouse_over: Optional[
  283. Union[EventHandler, EventSpec, list, function, BaseVar]
  284. ] = None,
  285. on_mouse_up: Optional[
  286. Union[EventHandler, EventSpec, list, function, BaseVar]
  287. ] = None,
  288. on_scroll: Optional[
  289. Union[EventHandler, EventSpec, list, function, BaseVar]
  290. ] = None,
  291. on_unmount: Optional[
  292. Union[EventHandler, EventSpec, list, function, BaseVar]
  293. ] = None,
  294. **props
  295. ) -> "Main":
  296. """Create the component.
  297. Args:
  298. *children: The children of the component.
  299. style: The style of the component.
  300. key: A unique key for the component.
  301. id: The id for the component.
  302. class_name: The class name for the component.
  303. autofocus: Whether the component should take the focus once the page is loaded
  304. custom_attrs: custom attribute
  305. **props: The props of the component.
  306. Returns:
  307. The component.
  308. Raises:
  309. TypeError: If an invalid child is passed.
  310. """
  311. ...
  312. class NextScript(NextDocumentLib):
  313. @overload
  314. @classmethod
  315. def create( # type: ignore
  316. cls,
  317. *children,
  318. style: Optional[Style] = None,
  319. key: Optional[Any] = None,
  320. id: Optional[Any] = None,
  321. class_name: Optional[Any] = None,
  322. autofocus: Optional[bool] = None,
  323. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  324. on_blur: Optional[
  325. Union[EventHandler, EventSpec, list, function, BaseVar]
  326. ] = None,
  327. on_click: Optional[
  328. Union[EventHandler, EventSpec, list, function, BaseVar]
  329. ] = None,
  330. on_context_menu: Optional[
  331. Union[EventHandler, EventSpec, list, function, BaseVar]
  332. ] = None,
  333. on_double_click: Optional[
  334. Union[EventHandler, EventSpec, list, function, BaseVar]
  335. ] = None,
  336. on_focus: Optional[
  337. Union[EventHandler, EventSpec, list, function, BaseVar]
  338. ] = None,
  339. on_mount: Optional[
  340. Union[EventHandler, EventSpec, list, function, BaseVar]
  341. ] = None,
  342. on_mouse_down: Optional[
  343. Union[EventHandler, EventSpec, list, function, BaseVar]
  344. ] = None,
  345. on_mouse_enter: Optional[
  346. Union[EventHandler, EventSpec, list, function, BaseVar]
  347. ] = None,
  348. on_mouse_leave: Optional[
  349. Union[EventHandler, EventSpec, list, function, BaseVar]
  350. ] = None,
  351. on_mouse_move: Optional[
  352. Union[EventHandler, EventSpec, list, function, BaseVar]
  353. ] = None,
  354. on_mouse_out: Optional[
  355. Union[EventHandler, EventSpec, list, function, BaseVar]
  356. ] = None,
  357. on_mouse_over: Optional[
  358. Union[EventHandler, EventSpec, list, function, BaseVar]
  359. ] = None,
  360. on_mouse_up: Optional[
  361. Union[EventHandler, EventSpec, list, function, BaseVar]
  362. ] = None,
  363. on_scroll: Optional[
  364. Union[EventHandler, EventSpec, list, function, BaseVar]
  365. ] = None,
  366. on_unmount: Optional[
  367. Union[EventHandler, EventSpec, list, function, BaseVar]
  368. ] = None,
  369. **props
  370. ) -> "NextScript":
  371. """Create the component.
  372. Args:
  373. *children: The children of the component.
  374. style: The style of the component.
  375. key: A unique key for the component.
  376. id: The id for the component.
  377. class_name: The class name for the component.
  378. autofocus: Whether the component should take the focus once the page is loaded
  379. custom_attrs: custom attribute
  380. **props: The props of the component.
  381. Returns:
  382. The component.
  383. Raises:
  384. TypeError: If an invalid child is passed.
  385. """
  386. ...