heading.pyi 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  1. """Stub file for reflex/components/radix/themes/typography/heading.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.components.core.breakpoints import Breakpoints
  7. from reflex.components.el import elements
  8. from reflex.components.markdown.markdown import MarkdownComponentMap
  9. from reflex.event import BASE_STATE, EventType
  10. from reflex.style import Style
  11. from reflex.vars.base import Var
  12. from ..base import RadixThemesComponent
  13. class Heading(elements.H1, RadixThemesComponent, MarkdownComponentMap):
  14. @overload
  15. @classmethod
  16. def create( # type: ignore
  17. cls,
  18. *children,
  19. as_child: Optional[Union[Var[bool], bool]] = None,
  20. as_: Optional[Union[Var[str], str]] = None,
  21. size: Optional[
  22. Union[
  23. Breakpoints[str, Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"]],
  24. Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"],
  25. Var[
  26. Union[
  27. Breakpoints[
  28. str, Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"]
  29. ],
  30. Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"],
  31. ]
  32. ],
  33. ]
  34. ] = None,
  35. weight: Optional[
  36. Union[
  37. Breakpoints[str, Literal["bold", "light", "medium", "regular"]],
  38. Literal["bold", "light", "medium", "regular"],
  39. Var[
  40. Union[
  41. Breakpoints[str, Literal["bold", "light", "medium", "regular"]],
  42. Literal["bold", "light", "medium", "regular"],
  43. ]
  44. ],
  45. ]
  46. ] = None,
  47. align: Optional[
  48. Union[
  49. Breakpoints[str, Literal["center", "left", "right"]],
  50. Literal["center", "left", "right"],
  51. Var[
  52. Union[
  53. Breakpoints[str, Literal["center", "left", "right"]],
  54. Literal["center", "left", "right"],
  55. ]
  56. ],
  57. ]
  58. ] = None,
  59. trim: Optional[
  60. Union[
  61. Breakpoints[str, Literal["both", "end", "normal", "start"]],
  62. Literal["both", "end", "normal", "start"],
  63. Var[
  64. Union[
  65. Breakpoints[str, Literal["both", "end", "normal", "start"]],
  66. Literal["both", "end", "normal", "start"],
  67. ]
  68. ],
  69. ]
  70. ] = None,
  71. color_scheme: Optional[
  72. Union[
  73. Literal[
  74. "amber",
  75. "blue",
  76. "bronze",
  77. "brown",
  78. "crimson",
  79. "cyan",
  80. "gold",
  81. "grass",
  82. "gray",
  83. "green",
  84. "indigo",
  85. "iris",
  86. "jade",
  87. "lime",
  88. "mint",
  89. "orange",
  90. "pink",
  91. "plum",
  92. "purple",
  93. "red",
  94. "ruby",
  95. "sky",
  96. "teal",
  97. "tomato",
  98. "violet",
  99. "yellow",
  100. ],
  101. Var[
  102. Literal[
  103. "amber",
  104. "blue",
  105. "bronze",
  106. "brown",
  107. "crimson",
  108. "cyan",
  109. "gold",
  110. "grass",
  111. "gray",
  112. "green",
  113. "indigo",
  114. "iris",
  115. "jade",
  116. "lime",
  117. "mint",
  118. "orange",
  119. "pink",
  120. "plum",
  121. "purple",
  122. "red",
  123. "ruby",
  124. "sky",
  125. "teal",
  126. "tomato",
  127. "violet",
  128. "yellow",
  129. ]
  130. ],
  131. ]
  132. ] = None,
  133. high_contrast: Optional[Union[Var[bool], bool]] = None,
  134. access_key: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  135. auto_capitalize: Optional[
  136. Union[Var[Union[bool, int, str]], bool, int, str]
  137. ] = None,
  138. content_editable: Optional[
  139. Union[Var[Union[bool, int, str]], bool, int, str]
  140. ] = None,
  141. context_menu: Optional[
  142. Union[Var[Union[bool, int, str]], bool, int, str]
  143. ] = None,
  144. dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  145. draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  146. enter_key_hint: Optional[
  147. Union[Var[Union[bool, int, str]], bool, int, str]
  148. ] = None,
  149. hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  150. input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  151. item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  152. lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  153. role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  154. slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  155. spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  156. tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  157. title: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  158. style: Optional[Style] = None,
  159. key: Optional[Any] = None,
  160. id: Optional[Any] = None,
  161. class_name: Optional[Any] = None,
  162. autofocus: Optional[bool] = None,
  163. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  164. on_blur: Optional[EventType[[], BASE_STATE]] = None,
  165. on_click: Optional[EventType[[], BASE_STATE]] = None,
  166. on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
  167. on_double_click: Optional[EventType[[], BASE_STATE]] = None,
  168. on_focus: Optional[EventType[[], BASE_STATE]] = None,
  169. on_mount: Optional[EventType[[], BASE_STATE]] = None,
  170. on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
  171. on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
  172. on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
  173. on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
  174. on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
  175. on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
  176. on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
  177. on_scroll: Optional[EventType[[], BASE_STATE]] = None,
  178. on_unmount: Optional[EventType[[], BASE_STATE]] = None,
  179. **props,
  180. ) -> "Heading":
  181. """Create a new component instance.
  182. Will prepend "RadixThemes" to the component tag to avoid conflicts with
  183. other UI libraries for common names, like Text and Button.
  184. Args:
  185. *children: Child components.
  186. as_child: Change the default rendered element for the one passed as a child, merging their props and behavior.
  187. as_: Change the default rendered element into a semantically appropriate alternative (cannot be used with asChild)
  188. size: Text size: "1" - "9"
  189. weight: Thickness of text: "light" | "regular" | "medium" | "bold"
  190. align: Alignment of text in element: "left" | "center" | "right"
  191. trim: Removes the leading trim space: "normal" | "start" | "end" | "both"
  192. color_scheme: Overrides the accent color inherited from the Theme.
  193. high_contrast: Whether to render the text with higher contrast color
  194. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  195. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  196. content_editable: Indicates whether the element's content is editable.
  197. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  198. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  199. draggable: Defines whether the element can be dragged.
  200. enter_key_hint: Hints what media types the media element is able to play.
  201. hidden: Defines whether the element is hidden.
  202. input_mode: Defines the type of the element.
  203. item_prop: Defines the name of the element for metadata purposes.
  204. lang: Defines the language used in the element.
  205. role: Defines the role of the element.
  206. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  207. spell_check: Defines whether the element may be checked for spelling errors.
  208. tab_index: Defines the position of the current element in the tabbing order.
  209. title: Defines a tooltip for the element.
  210. style: The style of the component.
  211. key: A unique key for the component.
  212. id: The id for the component.
  213. class_name: The class name for the component.
  214. autofocus: Whether the component should take the focus once the page is loaded
  215. custom_attrs: custom attribute
  216. **props: Component properties.
  217. Returns:
  218. A new component instance.
  219. """
  220. ...
  221. heading = Heading.create