progress.pyi 18 KB

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