document.pyi 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  1. """Stub file for reflex/components/base/document.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 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. """
  83. ...
  84. class Html(NextDocumentLib):
  85. @overload
  86. @classmethod
  87. def create( # type: ignore
  88. cls,
  89. *children,
  90. lang: Optional[str] = None,
  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. """
  157. ...
  158. class DocumentHead(NextDocumentLib):
  159. @overload
  160. @classmethod
  161. def create( # type: ignore
  162. cls,
  163. *children,
  164. style: Optional[Style] = None,
  165. key: Optional[Any] = None,
  166. id: Optional[Any] = None,
  167. class_name: Optional[Any] = None,
  168. autofocus: Optional[bool] = None,
  169. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  170. on_blur: Optional[
  171. Union[EventHandler, EventSpec, list, function, BaseVar]
  172. ] = None,
  173. on_click: Optional[
  174. Union[EventHandler, EventSpec, list, function, BaseVar]
  175. ] = None,
  176. on_context_menu: Optional[
  177. Union[EventHandler, EventSpec, list, function, BaseVar]
  178. ] = None,
  179. on_double_click: Optional[
  180. Union[EventHandler, EventSpec, list, function, BaseVar]
  181. ] = None,
  182. on_focus: Optional[
  183. Union[EventHandler, EventSpec, list, function, BaseVar]
  184. ] = None,
  185. on_mount: Optional[
  186. Union[EventHandler, EventSpec, list, function, BaseVar]
  187. ] = None,
  188. on_mouse_down: Optional[
  189. Union[EventHandler, EventSpec, list, function, BaseVar]
  190. ] = None,
  191. on_mouse_enter: Optional[
  192. Union[EventHandler, EventSpec, list, function, BaseVar]
  193. ] = None,
  194. on_mouse_leave: Optional[
  195. Union[EventHandler, EventSpec, list, function, BaseVar]
  196. ] = None,
  197. on_mouse_move: Optional[
  198. Union[EventHandler, EventSpec, list, function, BaseVar]
  199. ] = None,
  200. on_mouse_out: Optional[
  201. Union[EventHandler, EventSpec, list, function, BaseVar]
  202. ] = None,
  203. on_mouse_over: Optional[
  204. Union[EventHandler, EventSpec, list, function, BaseVar]
  205. ] = None,
  206. on_mouse_up: Optional[
  207. Union[EventHandler, EventSpec, list, function, BaseVar]
  208. ] = None,
  209. on_scroll: Optional[
  210. Union[EventHandler, EventSpec, list, function, BaseVar]
  211. ] = None,
  212. on_unmount: Optional[
  213. Union[EventHandler, EventSpec, list, function, BaseVar]
  214. ] = None,
  215. **props
  216. ) -> "DocumentHead":
  217. """Create the component.
  218. Args:
  219. *children: The children of the component.
  220. style: The style of the component.
  221. key: A unique key for the component.
  222. id: The id for the component.
  223. class_name: The class name for the component.
  224. autofocus: Whether the component should take the focus once the page is loaded
  225. custom_attrs: custom attribute
  226. **props: The props of the component.
  227. Returns:
  228. The component.
  229. """
  230. ...
  231. class Main(NextDocumentLib):
  232. @overload
  233. @classmethod
  234. def create( # type: ignore
  235. cls,
  236. *children,
  237. style: Optional[Style] = None,
  238. key: Optional[Any] = None,
  239. id: Optional[Any] = None,
  240. class_name: Optional[Any] = None,
  241. autofocus: Optional[bool] = None,
  242. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  243. on_blur: Optional[
  244. Union[EventHandler, EventSpec, list, function, BaseVar]
  245. ] = None,
  246. on_click: Optional[
  247. Union[EventHandler, EventSpec, list, function, BaseVar]
  248. ] = None,
  249. on_context_menu: Optional[
  250. Union[EventHandler, EventSpec, list, function, BaseVar]
  251. ] = None,
  252. on_double_click: Optional[
  253. Union[EventHandler, EventSpec, list, function, BaseVar]
  254. ] = None,
  255. on_focus: Optional[
  256. Union[EventHandler, EventSpec, list, function, BaseVar]
  257. ] = None,
  258. on_mount: Optional[
  259. Union[EventHandler, EventSpec, list, function, BaseVar]
  260. ] = None,
  261. on_mouse_down: Optional[
  262. Union[EventHandler, EventSpec, list, function, BaseVar]
  263. ] = None,
  264. on_mouse_enter: Optional[
  265. Union[EventHandler, EventSpec, list, function, BaseVar]
  266. ] = None,
  267. on_mouse_leave: Optional[
  268. Union[EventHandler, EventSpec, list, function, BaseVar]
  269. ] = None,
  270. on_mouse_move: Optional[
  271. Union[EventHandler, EventSpec, list, function, BaseVar]
  272. ] = None,
  273. on_mouse_out: Optional[
  274. Union[EventHandler, EventSpec, list, function, BaseVar]
  275. ] = None,
  276. on_mouse_over: Optional[
  277. Union[EventHandler, EventSpec, list, function, BaseVar]
  278. ] = None,
  279. on_mouse_up: Optional[
  280. Union[EventHandler, EventSpec, list, function, BaseVar]
  281. ] = None,
  282. on_scroll: Optional[
  283. Union[EventHandler, EventSpec, list, function, BaseVar]
  284. ] = None,
  285. on_unmount: Optional[
  286. Union[EventHandler, EventSpec, list, function, BaseVar]
  287. ] = None,
  288. **props
  289. ) -> "Main":
  290. """Create the component.
  291. Args:
  292. *children: The children of the component.
  293. style: The style of the component.
  294. key: A unique key for the component.
  295. id: The id for the component.
  296. class_name: The class name for the component.
  297. autofocus: Whether the component should take the focus once the page is loaded
  298. custom_attrs: custom attribute
  299. **props: The props of the component.
  300. Returns:
  301. The component.
  302. """
  303. ...
  304. class NextScript(NextDocumentLib):
  305. @overload
  306. @classmethod
  307. def create( # type: ignore
  308. cls,
  309. *children,
  310. style: Optional[Style] = None,
  311. key: Optional[Any] = None,
  312. id: Optional[Any] = None,
  313. class_name: Optional[Any] = None,
  314. autofocus: Optional[bool] = None,
  315. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  316. on_blur: Optional[
  317. Union[EventHandler, EventSpec, list, function, BaseVar]
  318. ] = None,
  319. on_click: Optional[
  320. Union[EventHandler, EventSpec, list, function, BaseVar]
  321. ] = None,
  322. on_context_menu: Optional[
  323. Union[EventHandler, EventSpec, list, function, BaseVar]
  324. ] = None,
  325. on_double_click: Optional[
  326. Union[EventHandler, EventSpec, list, function, BaseVar]
  327. ] = None,
  328. on_focus: Optional[
  329. Union[EventHandler, EventSpec, list, function, BaseVar]
  330. ] = None,
  331. on_mount: Optional[
  332. Union[EventHandler, EventSpec, list, function, BaseVar]
  333. ] = None,
  334. on_mouse_down: Optional[
  335. Union[EventHandler, EventSpec, list, function, BaseVar]
  336. ] = None,
  337. on_mouse_enter: Optional[
  338. Union[EventHandler, EventSpec, list, function, BaseVar]
  339. ] = None,
  340. on_mouse_leave: Optional[
  341. Union[EventHandler, EventSpec, list, function, BaseVar]
  342. ] = None,
  343. on_mouse_move: Optional[
  344. Union[EventHandler, EventSpec, list, function, BaseVar]
  345. ] = None,
  346. on_mouse_out: Optional[
  347. Union[EventHandler, EventSpec, list, function, BaseVar]
  348. ] = None,
  349. on_mouse_over: Optional[
  350. Union[EventHandler, EventSpec, list, function, BaseVar]
  351. ] = None,
  352. on_mouse_up: Optional[
  353. Union[EventHandler, EventSpec, list, function, BaseVar]
  354. ] = None,
  355. on_scroll: Optional[
  356. Union[EventHandler, EventSpec, list, function, BaseVar]
  357. ] = None,
  358. on_unmount: Optional[
  359. Union[EventHandler, EventSpec, list, function, BaseVar]
  360. ] = None,
  361. **props
  362. ) -> "NextScript":
  363. """Create the component.
  364. Args:
  365. *children: The children of the component.
  366. style: The style of the component.
  367. key: A unique key for the component.
  368. id: The id for the component.
  369. class_name: The class name for the component.
  370. autofocus: Whether the component should take the focus once the page is loaded
  371. custom_attrs: custom attribute
  372. **props: The props of the component.
  373. Returns:
  374. The component.
  375. """
  376. ...