progress.pyi 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459
  1. """Stub file for reflex/components/radix/primitives/progress.py"""
  2. # ------------------- DO NOT EDIT ----------------------
  3. # This file was generated by `reflex/utils/pyi_generator.py`!
  4. # ------------------------------------------------------
  5. from typing import Any, Literal, Optional, overload
  6. from reflex.components.component import ComponentNamespace
  7. from reflex.components.radix.primitives.base import RadixPrimitiveComponentWithClassName
  8. from reflex.event import EventType
  9. from reflex.style import Style
  10. from reflex.vars.base import Var
  11. class ProgressComponent(RadixPrimitiveComponentWithClassName):
  12. @overload
  13. @classmethod
  14. def create( # type: ignore
  15. cls,
  16. *children,
  17. as_child: Var[bool] | bool | None = None,
  18. style: Style | None = None,
  19. key: Any | None = None,
  20. id: Any | None = None,
  21. class_name: Any | None = None,
  22. autofocus: bool | None = None,
  23. custom_attrs: dict[str, Var | Any] | None = None,
  24. on_blur: Optional[EventType[()]] = None,
  25. on_click: Optional[EventType[()]] = None,
  26. on_context_menu: Optional[EventType[()]] = None,
  27. on_double_click: Optional[EventType[()]] = None,
  28. on_focus: Optional[EventType[()]] = None,
  29. on_mount: Optional[EventType[()]] = None,
  30. on_mouse_down: Optional[EventType[()]] = None,
  31. on_mouse_enter: Optional[EventType[()]] = None,
  32. on_mouse_leave: Optional[EventType[()]] = None,
  33. on_mouse_move: Optional[EventType[()]] = None,
  34. on_mouse_out: Optional[EventType[()]] = None,
  35. on_mouse_over: Optional[EventType[()]] = None,
  36. on_mouse_up: Optional[EventType[()]] = None,
  37. on_scroll: Optional[EventType[()]] = None,
  38. on_unmount: Optional[EventType[()]] = None,
  39. **props,
  40. ) -> "ProgressComponent":
  41. """Create the component.
  42. Args:
  43. *children: The children of the component.
  44. as_child: Change the default rendered element for the one passed as a child.
  45. style: The style of the component.
  46. key: A unique key for the component.
  47. id: The id for the component.
  48. class_name: The class name for the component.
  49. autofocus: Whether the component should take the focus once the page is loaded
  50. custom_attrs: custom attribute
  51. **props: The props of the component.
  52. Returns:
  53. The component.
  54. """
  55. ...
  56. class ProgressRoot(ProgressComponent):
  57. def add_style(self) -> dict[str, Any] | None: ...
  58. @overload
  59. @classmethod
  60. def create( # type: ignore
  61. cls,
  62. *children,
  63. radius: Literal["full", "large", "medium", "none", "small"]
  64. | Var[Literal["full", "large", "medium", "none", "small"]]
  65. | None = None,
  66. as_child: Var[bool] | bool | None = None,
  67. style: Style | None = None,
  68. key: Any | None = None,
  69. id: Any | None = None,
  70. class_name: Any | None = None,
  71. autofocus: bool | None = None,
  72. custom_attrs: dict[str, Var | Any] | None = None,
  73. on_blur: Optional[EventType[()]] = None,
  74. on_click: Optional[EventType[()]] = None,
  75. on_context_menu: Optional[EventType[()]] = None,
  76. on_double_click: Optional[EventType[()]] = None,
  77. on_focus: Optional[EventType[()]] = None,
  78. on_mount: Optional[EventType[()]] = None,
  79. on_mouse_down: Optional[EventType[()]] = None,
  80. on_mouse_enter: Optional[EventType[()]] = None,
  81. on_mouse_leave: Optional[EventType[()]] = None,
  82. on_mouse_move: Optional[EventType[()]] = None,
  83. on_mouse_out: Optional[EventType[()]] = None,
  84. on_mouse_over: Optional[EventType[()]] = None,
  85. on_mouse_up: Optional[EventType[()]] = None,
  86. on_scroll: Optional[EventType[()]] = None,
  87. on_unmount: Optional[EventType[()]] = None,
  88. **props,
  89. ) -> "ProgressRoot":
  90. """Create the component.
  91. Args:
  92. *children: The children of the component.
  93. radius: Override theme radius for progress bar: "none" | "small" | "medium" | "large" | "full"
  94. as_child: Change the default rendered element for the one passed as a child.
  95. style: The style of the component.
  96. key: A unique key for the component.
  97. id: The id for the component.
  98. class_name: The class name for the component.
  99. autofocus: Whether the component should take the focus once the page is loaded
  100. custom_attrs: custom attribute
  101. **props: The props of the component.
  102. Returns:
  103. The component.
  104. """
  105. ...
  106. class ProgressIndicator(ProgressComponent):
  107. def add_style(self) -> dict[str, Any] | None: ...
  108. @overload
  109. @classmethod
  110. def create( # type: ignore
  111. cls,
  112. *children,
  113. value: Var[int | None] | int | None = None,
  114. max: Var[int | None] | int | None = None,
  115. color_scheme: Literal[
  116. "amber",
  117. "blue",
  118. "bronze",
  119. "brown",
  120. "crimson",
  121. "cyan",
  122. "gold",
  123. "grass",
  124. "gray",
  125. "green",
  126. "indigo",
  127. "iris",
  128. "jade",
  129. "lime",
  130. "mint",
  131. "orange",
  132. "pink",
  133. "plum",
  134. "purple",
  135. "red",
  136. "ruby",
  137. "sky",
  138. "teal",
  139. "tomato",
  140. "violet",
  141. "yellow",
  142. ]
  143. | Var[
  144. Literal[
  145. "amber",
  146. "blue",
  147. "bronze",
  148. "brown",
  149. "crimson",
  150. "cyan",
  151. "gold",
  152. "grass",
  153. "gray",
  154. "green",
  155. "indigo",
  156. "iris",
  157. "jade",
  158. "lime",
  159. "mint",
  160. "orange",
  161. "pink",
  162. "plum",
  163. "purple",
  164. "red",
  165. "ruby",
  166. "sky",
  167. "teal",
  168. "tomato",
  169. "violet",
  170. "yellow",
  171. ]
  172. ]
  173. | None = None,
  174. as_child: Var[bool] | bool | None = None,
  175. style: Style | None = None,
  176. key: Any | None = None,
  177. id: Any | None = None,
  178. class_name: Any | None = None,
  179. autofocus: bool | None = None,
  180. custom_attrs: dict[str, Var | Any] | None = None,
  181. on_blur: Optional[EventType[()]] = None,
  182. on_click: Optional[EventType[()]] = None,
  183. on_context_menu: Optional[EventType[()]] = None,
  184. on_double_click: Optional[EventType[()]] = None,
  185. on_focus: Optional[EventType[()]] = None,
  186. on_mount: Optional[EventType[()]] = None,
  187. on_mouse_down: Optional[EventType[()]] = None,
  188. on_mouse_enter: Optional[EventType[()]] = None,
  189. on_mouse_leave: Optional[EventType[()]] = None,
  190. on_mouse_move: Optional[EventType[()]] = None,
  191. on_mouse_out: Optional[EventType[()]] = None,
  192. on_mouse_over: Optional[EventType[()]] = None,
  193. on_mouse_up: Optional[EventType[()]] = None,
  194. on_scroll: Optional[EventType[()]] = None,
  195. on_unmount: Optional[EventType[()]] = None,
  196. **props,
  197. ) -> "ProgressIndicator":
  198. """Create the component.
  199. Args:
  200. *children: The children of the component.
  201. value: The current progress value.
  202. max: The maximum progress value.
  203. color_scheme: The color scheme of the progress indicator.
  204. as_child: Change the default rendered element for the one passed as a child.
  205. style: The style of the component.
  206. key: A unique key for the component.
  207. id: The id for the component.
  208. class_name: The class name for the component.
  209. autofocus: Whether the component should take the focus once the page is loaded
  210. custom_attrs: custom attribute
  211. **props: The props of the component.
  212. Returns:
  213. The component.
  214. """
  215. ...
  216. class Progress(ProgressRoot):
  217. @overload
  218. @classmethod
  219. def create( # type: ignore
  220. cls,
  221. *children,
  222. color_scheme: Literal[
  223. "amber",
  224. "blue",
  225. "bronze",
  226. "brown",
  227. "crimson",
  228. "cyan",
  229. "gold",
  230. "grass",
  231. "gray",
  232. "green",
  233. "indigo",
  234. "iris",
  235. "jade",
  236. "lime",
  237. "mint",
  238. "orange",
  239. "pink",
  240. "plum",
  241. "purple",
  242. "red",
  243. "ruby",
  244. "sky",
  245. "teal",
  246. "tomato",
  247. "violet",
  248. "yellow",
  249. ]
  250. | Var[
  251. Literal[
  252. "amber",
  253. "blue",
  254. "bronze",
  255. "brown",
  256. "crimson",
  257. "cyan",
  258. "gold",
  259. "grass",
  260. "gray",
  261. "green",
  262. "indigo",
  263. "iris",
  264. "jade",
  265. "lime",
  266. "mint",
  267. "orange",
  268. "pink",
  269. "plum",
  270. "purple",
  271. "red",
  272. "ruby",
  273. "sky",
  274. "teal",
  275. "tomato",
  276. "violet",
  277. "yellow",
  278. ]
  279. ]
  280. | None = None,
  281. value: Var[int | None] | int | None = None,
  282. max: Var[int | None] | int | None = None,
  283. radius: Literal["full", "large", "medium", "none", "small"]
  284. | Var[Literal["full", "large", "medium", "none", "small"]]
  285. | None = None,
  286. as_child: Var[bool] | bool | None = None,
  287. style: Style | None = None,
  288. key: Any | None = None,
  289. id: Any | None = None,
  290. class_name: Any | None = None,
  291. autofocus: bool | None = None,
  292. custom_attrs: dict[str, Var | Any] | None = None,
  293. on_blur: Optional[EventType[()]] = None,
  294. on_click: Optional[EventType[()]] = None,
  295. on_context_menu: Optional[EventType[()]] = None,
  296. on_double_click: Optional[EventType[()]] = None,
  297. on_focus: Optional[EventType[()]] = None,
  298. on_mount: Optional[EventType[()]] = None,
  299. on_mouse_down: Optional[EventType[()]] = None,
  300. on_mouse_enter: Optional[EventType[()]] = None,
  301. on_mouse_leave: Optional[EventType[()]] = None,
  302. on_mouse_move: Optional[EventType[()]] = None,
  303. on_mouse_out: Optional[EventType[()]] = None,
  304. on_mouse_over: Optional[EventType[()]] = None,
  305. on_mouse_up: Optional[EventType[()]] = None,
  306. on_scroll: Optional[EventType[()]] = None,
  307. on_unmount: Optional[EventType[()]] = None,
  308. **props,
  309. ) -> "Progress":
  310. """High-level API for progress bar.
  311. Args:
  312. color_scheme: Override theme color for progress bar indicator
  313. value: The current progress value.
  314. max: The maximum progress value.
  315. radius: Override theme radius for progress bar: "none" | "small" | "medium" | "large" | "full"
  316. as_child: Change the default rendered element for the one passed as a child.
  317. style: The style of the component.
  318. key: A unique key for the component.
  319. id: The id for the component.
  320. class_name: The class name for the component.
  321. autofocus: Whether the component should take the focus once the page is loaded
  322. custom_attrs: custom attribute
  323. **props: The props of the progress bar.
  324. Returns:
  325. The progress bar.
  326. """
  327. ...
  328. class ProgressNamespace(ComponentNamespace):
  329. root = staticmethod(ProgressRoot.create)
  330. indicator = staticmethod(ProgressIndicator.create)
  331. @staticmethod
  332. def __call__(
  333. *children,
  334. color_scheme: Literal[
  335. "amber",
  336. "blue",
  337. "bronze",
  338. "brown",
  339. "crimson",
  340. "cyan",
  341. "gold",
  342. "grass",
  343. "gray",
  344. "green",
  345. "indigo",
  346. "iris",
  347. "jade",
  348. "lime",
  349. "mint",
  350. "orange",
  351. "pink",
  352. "plum",
  353. "purple",
  354. "red",
  355. "ruby",
  356. "sky",
  357. "teal",
  358. "tomato",
  359. "violet",
  360. "yellow",
  361. ]
  362. | Var[
  363. Literal[
  364. "amber",
  365. "blue",
  366. "bronze",
  367. "brown",
  368. "crimson",
  369. "cyan",
  370. "gold",
  371. "grass",
  372. "gray",
  373. "green",
  374. "indigo",
  375. "iris",
  376. "jade",
  377. "lime",
  378. "mint",
  379. "orange",
  380. "pink",
  381. "plum",
  382. "purple",
  383. "red",
  384. "ruby",
  385. "sky",
  386. "teal",
  387. "tomato",
  388. "violet",
  389. "yellow",
  390. ]
  391. ]
  392. | None = None,
  393. value: Var[int | None] | int | None = None,
  394. max: Var[int | None] | int | None = None,
  395. radius: Literal["full", "large", "medium", "none", "small"]
  396. | Var[Literal["full", "large", "medium", "none", "small"]]
  397. | None = None,
  398. as_child: Var[bool] | bool | None = None,
  399. style: Style | None = None,
  400. key: Any | None = None,
  401. id: Any | None = None,
  402. class_name: Any | None = None,
  403. autofocus: bool | None = None,
  404. custom_attrs: dict[str, Var | Any] | None = None,
  405. on_blur: Optional[EventType[()]] = None,
  406. on_click: Optional[EventType[()]] = None,
  407. on_context_menu: Optional[EventType[()]] = None,
  408. on_double_click: Optional[EventType[()]] = None,
  409. on_focus: Optional[EventType[()]] = None,
  410. on_mount: Optional[EventType[()]] = None,
  411. on_mouse_down: Optional[EventType[()]] = None,
  412. on_mouse_enter: Optional[EventType[()]] = None,
  413. on_mouse_leave: Optional[EventType[()]] = None,
  414. on_mouse_move: Optional[EventType[()]] = None,
  415. on_mouse_out: Optional[EventType[()]] = None,
  416. on_mouse_over: Optional[EventType[()]] = None,
  417. on_mouse_up: Optional[EventType[()]] = None,
  418. on_scroll: Optional[EventType[()]] = None,
  419. on_unmount: Optional[EventType[()]] = None,
  420. **props,
  421. ) -> "Progress":
  422. """High-level API for progress bar.
  423. Args:
  424. color_scheme: Override theme color for progress bar indicator
  425. value: The current progress value.
  426. max: The maximum progress value.
  427. radius: Override theme radius for progress bar: "none" | "small" | "medium" | "large" | "full"
  428. as_child: Change the default rendered element for the one passed as a child.
  429. style: The style of the component.
  430. key: A unique key for the component.
  431. id: The id for the component.
  432. class_name: The class name for the component.
  433. autofocus: Whether the component should take the focus once the page is loaded
  434. custom_attrs: custom attribute
  435. **props: The props of the progress bar.
  436. Returns:
  437. The progress bar.
  438. """
  439. ...
  440. progress = ProgressNamespace()