sticky.pyi 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449
  1. """Stub file for reflex/components/core/sticky.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.component import ComponentNamespace
  7. from reflex.components.core.breakpoints import Breakpoints
  8. from reflex.components.el.elements.inline import A
  9. from reflex.components.el.elements.media import Svg
  10. from reflex.components.radix.themes.typography.text import Text
  11. from reflex.event import EventType
  12. from reflex.style import Style
  13. from reflex.vars.base import Var
  14. class StickyLogo(Svg):
  15. @overload
  16. @classmethod
  17. def create( # type: ignore
  18. cls,
  19. *children,
  20. width: Optional[Union[Var[Union[int, str]], int, str]] = None,
  21. height: Optional[Union[Var[Union[int, str]], int, str]] = None,
  22. xmlns: Optional[Union[Var[str], str]] = None,
  23. access_key: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  24. auto_capitalize: Optional[
  25. Union[Var[Union[bool, int, str]], bool, int, str]
  26. ] = None,
  27. content_editable: Optional[
  28. Union[Var[Union[bool, int, str]], bool, int, str]
  29. ] = None,
  30. context_menu: Optional[
  31. Union[Var[Union[bool, int, str]], bool, int, str]
  32. ] = None,
  33. dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  34. draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  35. enter_key_hint: Optional[
  36. Union[Var[Union[bool, int, str]], bool, int, str]
  37. ] = None,
  38. hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  39. input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  40. item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  41. lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  42. role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  43. slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  44. spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  45. tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  46. title: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  47. style: Optional[Style] = None,
  48. key: Optional[Any] = None,
  49. id: Optional[Any] = None,
  50. class_name: Optional[Any] = None,
  51. autofocus: Optional[bool] = None,
  52. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  53. on_blur: Optional[EventType[()]] = None,
  54. on_click: Optional[EventType[()]] = None,
  55. on_context_menu: Optional[EventType[()]] = None,
  56. on_double_click: Optional[EventType[()]] = None,
  57. on_focus: Optional[EventType[()]] = None,
  58. on_mount: Optional[EventType[()]] = None,
  59. on_mouse_down: Optional[EventType[()]] = None,
  60. on_mouse_enter: Optional[EventType[()]] = None,
  61. on_mouse_leave: Optional[EventType[()]] = None,
  62. on_mouse_move: Optional[EventType[()]] = None,
  63. on_mouse_out: Optional[EventType[()]] = None,
  64. on_mouse_over: Optional[EventType[()]] = None,
  65. on_mouse_up: Optional[EventType[()]] = None,
  66. on_scroll: Optional[EventType[()]] = None,
  67. on_unmount: Optional[EventType[()]] = None,
  68. **props,
  69. ) -> "StickyLogo":
  70. """Create the simple Reflex logo SVG.
  71. Returns:
  72. The simple Reflex logo SVG.
  73. """
  74. ...
  75. def add_style(self): ...
  76. class StickyLabel(Text):
  77. @overload
  78. @classmethod
  79. def create( # type: ignore
  80. cls,
  81. *children,
  82. as_child: Optional[Union[Var[bool], bool]] = None,
  83. as_: Optional[
  84. Union[
  85. Literal[
  86. "abbr",
  87. "b",
  88. "cite",
  89. "del",
  90. "div",
  91. "em",
  92. "i",
  93. "ins",
  94. "kbd",
  95. "label",
  96. "mark",
  97. "p",
  98. "s",
  99. "samp",
  100. "span",
  101. "sub",
  102. "sup",
  103. "u",
  104. ],
  105. Var[
  106. Literal[
  107. "abbr",
  108. "b",
  109. "cite",
  110. "del",
  111. "div",
  112. "em",
  113. "i",
  114. "ins",
  115. "kbd",
  116. "label",
  117. "mark",
  118. "p",
  119. "s",
  120. "samp",
  121. "span",
  122. "sub",
  123. "sup",
  124. "u",
  125. ]
  126. ],
  127. ]
  128. ] = None,
  129. size: Optional[
  130. Union[
  131. Breakpoints[str, Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"]],
  132. Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"],
  133. Var[
  134. Union[
  135. Breakpoints[
  136. str, Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"]
  137. ],
  138. Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"],
  139. ]
  140. ],
  141. ]
  142. ] = None,
  143. weight: Optional[
  144. Union[
  145. Breakpoints[str, Literal["bold", "light", "medium", "regular"]],
  146. Literal["bold", "light", "medium", "regular"],
  147. Var[
  148. Union[
  149. Breakpoints[str, Literal["bold", "light", "medium", "regular"]],
  150. Literal["bold", "light", "medium", "regular"],
  151. ]
  152. ],
  153. ]
  154. ] = None,
  155. align: Optional[
  156. Union[
  157. Breakpoints[str, Literal["center", "left", "right"]],
  158. Literal["center", "left", "right"],
  159. Var[
  160. Union[
  161. Breakpoints[str, Literal["center", "left", "right"]],
  162. Literal["center", "left", "right"],
  163. ]
  164. ],
  165. ]
  166. ] = None,
  167. trim: Optional[
  168. Union[
  169. Breakpoints[str, Literal["both", "end", "normal", "start"]],
  170. Literal["both", "end", "normal", "start"],
  171. Var[
  172. Union[
  173. Breakpoints[str, Literal["both", "end", "normal", "start"]],
  174. Literal["both", "end", "normal", "start"],
  175. ]
  176. ],
  177. ]
  178. ] = None,
  179. color_scheme: Optional[
  180. Union[
  181. Literal[
  182. "amber",
  183. "blue",
  184. "bronze",
  185. "brown",
  186. "crimson",
  187. "cyan",
  188. "gold",
  189. "grass",
  190. "gray",
  191. "green",
  192. "indigo",
  193. "iris",
  194. "jade",
  195. "lime",
  196. "mint",
  197. "orange",
  198. "pink",
  199. "plum",
  200. "purple",
  201. "red",
  202. "ruby",
  203. "sky",
  204. "teal",
  205. "tomato",
  206. "violet",
  207. "yellow",
  208. ],
  209. Var[
  210. Literal[
  211. "amber",
  212. "blue",
  213. "bronze",
  214. "brown",
  215. "crimson",
  216. "cyan",
  217. "gold",
  218. "grass",
  219. "gray",
  220. "green",
  221. "indigo",
  222. "iris",
  223. "jade",
  224. "lime",
  225. "mint",
  226. "orange",
  227. "pink",
  228. "plum",
  229. "purple",
  230. "red",
  231. "ruby",
  232. "sky",
  233. "teal",
  234. "tomato",
  235. "violet",
  236. "yellow",
  237. ]
  238. ],
  239. ]
  240. ] = None,
  241. high_contrast: Optional[Union[Var[bool], bool]] = None,
  242. access_key: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  243. auto_capitalize: Optional[
  244. Union[Var[Union[bool, int, str]], bool, int, str]
  245. ] = None,
  246. content_editable: Optional[
  247. Union[Var[Union[bool, int, str]], bool, int, str]
  248. ] = None,
  249. context_menu: Optional[
  250. Union[Var[Union[bool, int, str]], bool, int, str]
  251. ] = None,
  252. dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  253. draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  254. enter_key_hint: Optional[
  255. Union[Var[Union[bool, int, str]], bool, int, str]
  256. ] = None,
  257. hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  258. input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  259. item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  260. lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  261. role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  262. slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  263. spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  264. tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  265. title: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  266. style: Optional[Style] = None,
  267. key: Optional[Any] = None,
  268. id: Optional[Any] = None,
  269. class_name: Optional[Any] = None,
  270. autofocus: Optional[bool] = None,
  271. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  272. on_blur: Optional[EventType[()]] = None,
  273. on_click: Optional[EventType[()]] = None,
  274. on_context_menu: Optional[EventType[()]] = None,
  275. on_double_click: Optional[EventType[()]] = None,
  276. on_focus: Optional[EventType[()]] = None,
  277. on_mount: Optional[EventType[()]] = None,
  278. on_mouse_down: Optional[EventType[()]] = None,
  279. on_mouse_enter: Optional[EventType[()]] = None,
  280. on_mouse_leave: Optional[EventType[()]] = None,
  281. on_mouse_move: Optional[EventType[()]] = None,
  282. on_mouse_out: Optional[EventType[()]] = None,
  283. on_mouse_over: Optional[EventType[()]] = None,
  284. on_mouse_up: Optional[EventType[()]] = None,
  285. on_scroll: Optional[EventType[()]] = None,
  286. on_unmount: Optional[EventType[()]] = None,
  287. **props,
  288. ) -> "StickyLabel":
  289. """Create the sticky label.
  290. Returns:
  291. The sticky label.
  292. """
  293. ...
  294. def add_style(self): ...
  295. class StickyBadge(A):
  296. @overload
  297. @classmethod
  298. def create( # type: ignore
  299. cls,
  300. *children,
  301. download: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  302. href: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  303. href_lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  304. media: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  305. ping: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  306. referrer_policy: Optional[
  307. Union[Var[Union[bool, int, str]], bool, int, str]
  308. ] = None,
  309. rel: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  310. shape: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  311. target: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  312. access_key: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  313. auto_capitalize: Optional[
  314. Union[Var[Union[bool, int, str]], bool, int, str]
  315. ] = None,
  316. content_editable: Optional[
  317. Union[Var[Union[bool, int, str]], bool, int, str]
  318. ] = None,
  319. context_menu: Optional[
  320. Union[Var[Union[bool, int, str]], bool, int, str]
  321. ] = None,
  322. dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  323. draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  324. enter_key_hint: Optional[
  325. Union[Var[Union[bool, int, str]], bool, int, str]
  326. ] = None,
  327. hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  328. input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  329. item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  330. lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  331. role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  332. slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  333. spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  334. tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  335. title: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  336. style: Optional[Style] = None,
  337. key: Optional[Any] = None,
  338. id: Optional[Any] = None,
  339. class_name: Optional[Any] = None,
  340. autofocus: Optional[bool] = None,
  341. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  342. on_blur: Optional[EventType[()]] = None,
  343. on_click: Optional[EventType[()]] = None,
  344. on_context_menu: Optional[EventType[()]] = None,
  345. on_double_click: Optional[EventType[()]] = None,
  346. on_focus: Optional[EventType[()]] = None,
  347. on_mount: Optional[EventType[()]] = None,
  348. on_mouse_down: Optional[EventType[()]] = None,
  349. on_mouse_enter: Optional[EventType[()]] = None,
  350. on_mouse_leave: Optional[EventType[()]] = None,
  351. on_mouse_move: Optional[EventType[()]] = None,
  352. on_mouse_out: Optional[EventType[()]] = None,
  353. on_mouse_over: Optional[EventType[()]] = None,
  354. on_mouse_up: Optional[EventType[()]] = None,
  355. on_scroll: Optional[EventType[()]] = None,
  356. on_unmount: Optional[EventType[()]] = None,
  357. **props,
  358. ) -> "StickyBadge":
  359. """Create the sticky badge.
  360. Returns:
  361. The sticky badge.
  362. """
  363. ...
  364. def add_style(self): ...
  365. class StickyNamespace(ComponentNamespace):
  366. label = staticmethod(StickyLabel.create)
  367. logo = staticmethod(StickyLogo.create)
  368. @staticmethod
  369. def __call__(
  370. *children,
  371. download: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  372. href: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  373. href_lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  374. media: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  375. ping: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  376. referrer_policy: Optional[
  377. Union[Var[Union[bool, int, str]], bool, int, str]
  378. ] = None,
  379. rel: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  380. shape: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  381. target: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  382. access_key: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  383. auto_capitalize: Optional[
  384. Union[Var[Union[bool, int, str]], bool, int, str]
  385. ] = None,
  386. content_editable: Optional[
  387. Union[Var[Union[bool, int, str]], bool, int, str]
  388. ] = None,
  389. context_menu: Optional[
  390. Union[Var[Union[bool, int, str]], bool, int, str]
  391. ] = None,
  392. dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  393. draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  394. enter_key_hint: Optional[
  395. Union[Var[Union[bool, int, str]], bool, int, str]
  396. ] = None,
  397. hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  398. input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  399. item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  400. lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  401. role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  402. slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  403. spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  404. tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  405. title: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  406. style: Optional[Style] = None,
  407. key: Optional[Any] = None,
  408. id: Optional[Any] = None,
  409. class_name: Optional[Any] = None,
  410. autofocus: Optional[bool] = None,
  411. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  412. on_blur: Optional[EventType[()]] = None,
  413. on_click: Optional[EventType[()]] = None,
  414. on_context_menu: Optional[EventType[()]] = None,
  415. on_double_click: Optional[EventType[()]] = None,
  416. on_focus: Optional[EventType[()]] = None,
  417. on_mount: Optional[EventType[()]] = None,
  418. on_mouse_down: Optional[EventType[()]] = None,
  419. on_mouse_enter: Optional[EventType[()]] = None,
  420. on_mouse_leave: Optional[EventType[()]] = None,
  421. on_mouse_move: Optional[EventType[()]] = None,
  422. on_mouse_out: Optional[EventType[()]] = None,
  423. on_mouse_over: Optional[EventType[()]] = None,
  424. on_mouse_up: Optional[EventType[()]] = None,
  425. on_scroll: Optional[EventType[()]] = None,
  426. on_unmount: Optional[EventType[()]] = None,
  427. **props,
  428. ) -> "StickyBadge":
  429. """Create the sticky badge.
  430. Returns:
  431. The sticky badge.
  432. """
  433. ...
  434. sticky = StickyNamespace()