document.pyi 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  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, Mapping, Optional, Sequence, overload
  6. from reflex.components.component import Component
  7. from reflex.components.core.breakpoints import Breakpoints
  8. from reflex.event import EventType
  9. from reflex.vars.base import Var
  10. class ReactRouterLib(Component):
  11. @overload
  12. @classmethod
  13. def create( # type: ignore
  14. cls,
  15. *children,
  16. style: Style | None = None,
  17. key: Any | None = None,
  18. id: Any | None = None,
  19. class_name: Any | None = None,
  20. autofocus: bool | None = None,
  21. custom_attrs: dict[str, Var | Any] | None = None,
  22. on_blur: Optional[EventType[()]] = None,
  23. on_click: Optional[EventType[()]] = None,
  24. on_context_menu: Optional[EventType[()]] = None,
  25. on_double_click: Optional[EventType[()]] = None,
  26. on_focus: Optional[EventType[()]] = None,
  27. on_mount: Optional[EventType[()]] = None,
  28. on_mouse_down: Optional[EventType[()]] = None,
  29. on_mouse_enter: Optional[EventType[()]] = None,
  30. on_mouse_leave: Optional[EventType[()]] = None,
  31. on_mouse_move: Optional[EventType[()]] = None,
  32. on_mouse_out: Optional[EventType[()]] = None,
  33. on_mouse_over: Optional[EventType[()]] = None,
  34. on_mouse_up: Optional[EventType[()]] = None,
  35. on_scroll: Optional[EventType[()]] = None,
  36. on_unmount: Optional[EventType[()]] = None,
  37. **props,
  38. ) -> "ReactRouterLib":
  39. """Create the component.
  40. Args:
  41. *children: The children of the component.
  42. style: The style of the component.
  43. key: A unique key for the component.
  44. id: The id for the component.
  45. class_name: The class name for the component.
  46. autofocus: Whether the component should take the focus once the page is loaded
  47. custom_attrs: custom attribute
  48. **props: The props of the component.
  49. Returns:
  50. The component.
  51. """
  52. ...
  53. class Meta(ReactRouterLib):
  54. @overload
  55. @classmethod
  56. def create( # type: ignore
  57. cls,
  58. *children,
  59. style: Style | None = None,
  60. key: Any | None = None,
  61. id: Any | None = None,
  62. class_name: Any | None = None,
  63. autofocus: bool | None = None,
  64. custom_attrs: dict[str, Var | Any] | None = None,
  65. on_blur: Optional[EventType[()]] = None,
  66. on_click: Optional[EventType[()]] = None,
  67. on_context_menu: Optional[EventType[()]] = None,
  68. on_double_click: Optional[EventType[()]] = None,
  69. on_focus: Optional[EventType[()]] = None,
  70. on_mount: Optional[EventType[()]] = None,
  71. on_mouse_down: Optional[EventType[()]] = None,
  72. on_mouse_enter: Optional[EventType[()]] = None,
  73. on_mouse_leave: Optional[EventType[()]] = None,
  74. on_mouse_move: Optional[EventType[()]] = None,
  75. on_mouse_out: Optional[EventType[()]] = None,
  76. on_mouse_over: Optional[EventType[()]] = None,
  77. on_mouse_up: Optional[EventType[()]] = None,
  78. on_scroll: Optional[EventType[()]] = None,
  79. on_unmount: Optional[EventType[()]] = None,
  80. **props,
  81. ) -> "Meta":
  82. """Create the component.
  83. Args:
  84. *children: The children of the component.
  85. style: The style of the component.
  86. key: A unique key for the component.
  87. id: The id for the component.
  88. class_name: The class name for the component.
  89. autofocus: Whether the component should take the focus once the page is loaded
  90. custom_attrs: custom attribute
  91. **props: The props of the component.
  92. Returns:
  93. The component.
  94. """
  95. ...
  96. class Links(ReactRouterLib):
  97. @overload
  98. @classmethod
  99. def create( # type: ignore
  100. cls,
  101. *children,
  102. style: Style | None = None,
  103. key: Any | None = None,
  104. id: Any | None = None,
  105. class_name: Any | None = None,
  106. autofocus: bool | None = None,
  107. custom_attrs: dict[str, Var | Any] | None = None,
  108. on_blur: Optional[EventType[()]] = None,
  109. on_click: Optional[EventType[()]] = None,
  110. on_context_menu: Optional[EventType[()]] = None,
  111. on_double_click: Optional[EventType[()]] = None,
  112. on_focus: Optional[EventType[()]] = None,
  113. on_mount: Optional[EventType[()]] = None,
  114. on_mouse_down: Optional[EventType[()]] = None,
  115. on_mouse_enter: Optional[EventType[()]] = None,
  116. on_mouse_leave: Optional[EventType[()]] = None,
  117. on_mouse_move: Optional[EventType[()]] = None,
  118. on_mouse_out: Optional[EventType[()]] = None,
  119. on_mouse_over: Optional[EventType[()]] = None,
  120. on_mouse_up: Optional[EventType[()]] = None,
  121. on_scroll: Optional[EventType[()]] = None,
  122. on_unmount: Optional[EventType[()]] = None,
  123. **props,
  124. ) -> "Links":
  125. """Create the component.
  126. Args:
  127. *children: The children of the component.
  128. style: The style of the component.
  129. key: A unique key for the component.
  130. id: The id for the component.
  131. class_name: The class name for the component.
  132. autofocus: Whether the component should take the focus once the page is loaded
  133. custom_attrs: custom attribute
  134. **props: The props of the component.
  135. Returns:
  136. The component.
  137. """
  138. ...
  139. class ScrollRestoration(ReactRouterLib):
  140. @overload
  141. @classmethod
  142. def create( # type: ignore
  143. cls,
  144. *children,
  145. style: Sequence[Mapping[str, Any]]
  146. | Mapping[str, Any]
  147. | Var[Mapping[str, Any]]
  148. | Breakpoints
  149. | None = None,
  150. key: Any | None = None,
  151. id: Any | None = None,
  152. class_name: Any | None = None,
  153. autofocus: bool | None = None,
  154. custom_attrs: dict[str, Var | Any] | None = None,
  155. on_blur: Optional[EventType[()]] = None,
  156. on_click: Optional[EventType[()]] = None,
  157. on_context_menu: Optional[EventType[()]] = None,
  158. on_double_click: Optional[EventType[()]] = None,
  159. on_focus: Optional[EventType[()]] = None,
  160. on_mount: Optional[EventType[()]] = None,
  161. on_mouse_down: Optional[EventType[()]] = None,
  162. on_mouse_enter: Optional[EventType[()]] = None,
  163. on_mouse_leave: Optional[EventType[()]] = None,
  164. on_mouse_move: Optional[EventType[()]] = None,
  165. on_mouse_out: Optional[EventType[()]] = None,
  166. on_mouse_over: Optional[EventType[()]] = None,
  167. on_mouse_up: Optional[EventType[()]] = None,
  168. on_scroll: Optional[EventType[()]] = None,
  169. on_unmount: Optional[EventType[()]] = None,
  170. **props,
  171. ) -> "ScrollRestoration":
  172. """Create the component.
  173. Args:
  174. *children: The children of the component.
  175. style: The style of the component.
  176. key: A unique key for the component.
  177. id: The id for the component.
  178. class_name: The class name for the component.
  179. autofocus: Whether the component should take the focus once the page is loaded
  180. custom_attrs: custom attribute
  181. **props: The props of the component.
  182. Returns:
  183. The component.
  184. """
  185. ...
  186. class Outlet(ReactRouterLib):
  187. @overload
  188. @classmethod
  189. def create( # type: ignore
  190. cls,
  191. *children,
  192. style: Sequence[Mapping[str, Any]]
  193. | Mapping[str, Any]
  194. | Var[Mapping[str, Any]]
  195. | Breakpoints
  196. | None = None,
  197. key: Any | None = None,
  198. id: Any | None = None,
  199. class_name: Any | None = None,
  200. autofocus: bool | None = None,
  201. custom_attrs: dict[str, Var | Any] | None = None,
  202. on_blur: Optional[EventType[()]] = None,
  203. on_click: Optional[EventType[()]] = None,
  204. on_context_menu: Optional[EventType[()]] = None,
  205. on_double_click: Optional[EventType[()]] = None,
  206. on_focus: Optional[EventType[()]] = None,
  207. on_mount: Optional[EventType[()]] = None,
  208. on_mouse_down: Optional[EventType[()]] = None,
  209. on_mouse_enter: Optional[EventType[()]] = None,
  210. on_mouse_leave: Optional[EventType[()]] = None,
  211. on_mouse_move: Optional[EventType[()]] = None,
  212. on_mouse_out: Optional[EventType[()]] = None,
  213. on_mouse_over: Optional[EventType[()]] = None,
  214. on_mouse_up: Optional[EventType[()]] = None,
  215. on_scroll: Optional[EventType[()]] = None,
  216. on_unmount: Optional[EventType[()]] = None,
  217. **props,
  218. ) -> "Outlet":
  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. """
  232. ...
  233. class Scripts(ReactRouterLib):
  234. @overload
  235. @classmethod
  236. def create( # type: ignore
  237. cls,
  238. *children,
  239. style: Sequence[Mapping[str, Any]]
  240. | Mapping[str, Any]
  241. | Var[Mapping[str, Any]]
  242. | Breakpoints
  243. | None = None,
  244. key: Any | None = None,
  245. id: Any | None = None,
  246. class_name: Any | None = None,
  247. autofocus: bool | None = None,
  248. custom_attrs: dict[str, Var | Any] | None = None,
  249. on_blur: Optional[EventType[()]] = None,
  250. on_click: Optional[EventType[()]] = None,
  251. on_context_menu: Optional[EventType[()]] = None,
  252. on_double_click: Optional[EventType[()]] = None,
  253. on_focus: Optional[EventType[()]] = None,
  254. on_mount: Optional[EventType[()]] = None,
  255. on_mouse_down: Optional[EventType[()]] = None,
  256. on_mouse_enter: Optional[EventType[()]] = None,
  257. on_mouse_leave: Optional[EventType[()]] = None,
  258. on_mouse_move: Optional[EventType[()]] = None,
  259. on_mouse_out: Optional[EventType[()]] = None,
  260. on_mouse_over: Optional[EventType[()]] = None,
  261. on_mouse_up: Optional[EventType[()]] = None,
  262. on_scroll: Optional[EventType[()]] = None,
  263. on_unmount: Optional[EventType[()]] = None,
  264. **props,
  265. ) -> "Scripts":
  266. """Create the component.
  267. Args:
  268. *children: The children of the component.
  269. style: The style of the component.
  270. key: A unique key for the component.
  271. id: The id for the component.
  272. class_name: The class name for the component.
  273. autofocus: Whether the component should take the focus once the page is loaded
  274. custom_attrs: custom attribute
  275. **props: The props of the component.
  276. Returns:
  277. The component.
  278. """
  279. ...