document.pyi 13 KB

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