document.pyi 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242
  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, Optional, Union, overload
  6. from reflex.components.component import Component
  7. from reflex.event import BASE_STATE, EventType
  8. from reflex.style import Style
  9. from reflex.vars.base 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, Any]]] = None,
  22. on_blur: Optional[EventType[[], BASE_STATE]] = None,
  23. on_click: Optional[EventType[[], BASE_STATE]] = None,
  24. on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
  25. on_double_click: Optional[EventType[[], BASE_STATE]] = None,
  26. on_focus: Optional[EventType[[], BASE_STATE]] = None,
  27. on_mount: Optional[EventType[[], BASE_STATE]] = None,
  28. on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
  29. on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
  30. on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
  31. on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
  32. on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
  33. on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
  34. on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
  35. on_scroll: Optional[EventType[[], BASE_STATE]] = None,
  36. on_unmount: Optional[EventType[[], BASE_STATE]] = None,
  37. **props,
  38. ) -> "NextDocumentLib":
  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 Html(NextDocumentLib):
  54. @overload
  55. @classmethod
  56. def create( # type: ignore
  57. cls,
  58. *children,
  59. lang: Optional[str] = None,
  60. style: Optional[Style] = None,
  61. key: Optional[Any] = None,
  62. id: Optional[Any] = None,
  63. class_name: Optional[Any] = None,
  64. autofocus: Optional[bool] = None,
  65. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  66. on_blur: Optional[EventType[[], BASE_STATE]] = None,
  67. on_click: Optional[EventType[[], BASE_STATE]] = None,
  68. on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
  69. on_double_click: Optional[EventType[[], BASE_STATE]] = None,
  70. on_focus: Optional[EventType[[], BASE_STATE]] = None,
  71. on_mount: Optional[EventType[[], BASE_STATE]] = None,
  72. on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
  73. on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
  74. on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
  75. on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
  76. on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
  77. on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
  78. on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
  79. on_scroll: Optional[EventType[[], BASE_STATE]] = None,
  80. on_unmount: Optional[EventType[[], BASE_STATE]] = None,
  81. **props,
  82. ) -> "Html":
  83. """Create the component.
  84. Args:
  85. *children: The children of the component.
  86. style: The style of the component.
  87. key: A unique key for the component.
  88. id: The id for the component.
  89. class_name: The class name for the component.
  90. autofocus: Whether the component should take the focus once the page is loaded
  91. custom_attrs: custom attribute
  92. **props: The props of the component.
  93. Returns:
  94. The component.
  95. """
  96. ...
  97. class DocumentHead(NextDocumentLib):
  98. @overload
  99. @classmethod
  100. def create( # type: ignore
  101. cls,
  102. *children,
  103. style: Optional[Style] = None,
  104. key: Optional[Any] = None,
  105. id: Optional[Any] = None,
  106. class_name: Optional[Any] = None,
  107. autofocus: Optional[bool] = None,
  108. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  109. on_blur: Optional[EventType[[], BASE_STATE]] = None,
  110. on_click: Optional[EventType[[], BASE_STATE]] = None,
  111. on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
  112. on_double_click: Optional[EventType[[], BASE_STATE]] = None,
  113. on_focus: Optional[EventType[[], BASE_STATE]] = None,
  114. on_mount: Optional[EventType[[], BASE_STATE]] = None,
  115. on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
  116. on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
  117. on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
  118. on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
  119. on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
  120. on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
  121. on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
  122. on_scroll: Optional[EventType[[], BASE_STATE]] = None,
  123. on_unmount: Optional[EventType[[], BASE_STATE]] = None,
  124. **props,
  125. ) -> "DocumentHead":
  126. """Create the component.
  127. Args:
  128. *children: The children of the component.
  129. style: The style of the component.
  130. key: A unique key for the component.
  131. id: The id for the component.
  132. class_name: The class name for the component.
  133. autofocus: Whether the component should take the focus once the page is loaded
  134. custom_attrs: custom attribute
  135. **props: The props of the component.
  136. Returns:
  137. The component.
  138. """
  139. ...
  140. class Main(NextDocumentLib):
  141. @overload
  142. @classmethod
  143. def create( # type: ignore
  144. cls,
  145. *children,
  146. style: Optional[Style] = None,
  147. key: Optional[Any] = None,
  148. id: Optional[Any] = None,
  149. class_name: Optional[Any] = None,
  150. autofocus: Optional[bool] = None,
  151. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  152. on_blur: Optional[EventType[[], BASE_STATE]] = None,
  153. on_click: Optional[EventType[[], BASE_STATE]] = None,
  154. on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
  155. on_double_click: Optional[EventType[[], BASE_STATE]] = None,
  156. on_focus: Optional[EventType[[], BASE_STATE]] = None,
  157. on_mount: Optional[EventType[[], BASE_STATE]] = None,
  158. on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
  159. on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
  160. on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
  161. on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
  162. on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
  163. on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
  164. on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
  165. on_scroll: Optional[EventType[[], BASE_STATE]] = None,
  166. on_unmount: Optional[EventType[[], BASE_STATE]] = None,
  167. **props,
  168. ) -> "Main":
  169. """Create the component.
  170. Args:
  171. *children: The children of the component.
  172. style: The style of the component.
  173. key: A unique key for the component.
  174. id: The id for the component.
  175. class_name: The class name for the component.
  176. autofocus: Whether the component should take the focus once the page is loaded
  177. custom_attrs: custom attribute
  178. **props: The props of the component.
  179. Returns:
  180. The component.
  181. """
  182. ...
  183. class NextScript(NextDocumentLib):
  184. @overload
  185. @classmethod
  186. def create( # type: ignore
  187. cls,
  188. *children,
  189. style: Optional[Style] = None,
  190. key: Optional[Any] = None,
  191. id: Optional[Any] = None,
  192. class_name: Optional[Any] = None,
  193. autofocus: Optional[bool] = None,
  194. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  195. on_blur: Optional[EventType[[], BASE_STATE]] = None,
  196. on_click: Optional[EventType[[], BASE_STATE]] = None,
  197. on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
  198. on_double_click: Optional[EventType[[], BASE_STATE]] = None,
  199. on_focus: Optional[EventType[[], BASE_STATE]] = None,
  200. on_mount: Optional[EventType[[], BASE_STATE]] = None,
  201. on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
  202. on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
  203. on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
  204. on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
  205. on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
  206. on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
  207. on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
  208. on_scroll: Optional[EventType[[], BASE_STATE]] = None,
  209. on_unmount: Optional[EventType[[], BASE_STATE]] = None,
  210. **props,
  211. ) -> "NextScript":
  212. """Create the component.
  213. Args:
  214. *children: The children of the component.
  215. style: The style of the component.
  216. key: A unique key for the component.
  217. id: The id for the component.
  218. class_name: The class name for the component.
  219. autofocus: Whether the component should take the focus once the page is loaded
  220. custom_attrs: custom attribute
  221. **props: The props of the component.
  222. Returns:
  223. The component.
  224. """
  225. ...