1
0

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