document.pyi 14 KB

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