progress.pyi 16 KB

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