@yamada-ui/progress 0.2.6 → 0.3.1

package/dist/circle-progress.d.ts

@@ -2,15 +2,65 @@ import * as _yamada_ui_core from '@yamada-ui/core';
 import { HTMLUIProps, CSSUIProps } from '@yamada-ui/core';
 
 type CircleProgressOptions = {
+    /**
+     * The CSS `box-size` property.
+     *
+     * @default '6rem'
+     */
     size?: CSSUIProps['boxSize'];
+    /**
+     * The CSS `width` property.
+     *
+     * @default '0.625ewm'
+     */
     thickness?: CSSUIProps['width'];
+    /**
+     * The CSS `color` property.
+     *
+     * @default 'primary'
+     */
     color?: CSSUIProps['color'];
+    /**
+     * The CSS `color` property.
+     *
+     * @default 'border'
+     */
     trackColor?: CSSUIProps['color'];
+    /**
+     * The value of the progress.
+     *
+     * @default 0
+     */
     value?: number;
+    /**
+     * The minimum value of the progress.
+     *
+     * @default 0
+     */
     min?: number;
+    /**
+     * The maximum value of the progress.
+     *
+     * @default 100
+     */
     max?: number;
+    /**
+     * If `true`, the cap of the progress indicator will be rounded.
+     *
+     * @default false
+     */
     isRounded?: boolean;
+    /**
+     * If `true`, the progress will be indeterminate and the `value` prop will be ignored.
+     *
+     * @default false
+     */
     isAnimation?: boolean;
+    /**
+     * The animation speed in seconds.
+     *
+     * @default '[1.4s, 2s]'
+     */
     speed?: [string | number, string | number];
 };
 type CircleProgressProps = Omit<HTMLUIProps<'div'>, 'color'> & CircleProgressOptions;

package/dist/progress.d.ts

@@ -2,13 +2,51 @@ import * as _yamada_ui_core from '@yamada-ui/core';
 import { HTMLUIProps, ThemeProps, CSSUIProps } from '@yamada-ui/core';
 
 type ProgressOptions = {
+    /**
+     * The value of the progress.
+     *
+     * @default 0
+     */
     value?: number;
+    /**
+     * The minimum value of the progress.
+     *
+     * @default 0
+     */
     min?: number;
+    /**
+     * The maximum value of the progress.
+     *
+     * @default 100
+     */
     max?: number;
+    /**
+     * If `true`, the progress bar will show stripe.
+     *
+     * @default false
+     */
     hasStripe?: boolean;
+    /**
+     * If `true`, and hasStripe is `true`, the stripes will be animated.
+     *
+     * @default false
+     */
     isStripeAnimation?: boolean;
+    /**
+     * If `true`, the progress will be indeterminate and the `value` prop will be ignored.
+     *
+     * @default false
+     */
     isAnimation?: boolean;
+    /**
+     * The animation speed in seconds.
+     *
+     * @default '1.4s'
+     */
     speed?: string | number;
+    /**
+     * The CSS `color` property.
+     */
     filledTrackColor?: CSSUIProps<'unResponsive'>['color'];
 };
 type ProgressProps = HTMLUIProps<'div'> & ThemeProps<'Progress'> & ProgressOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yamada-ui/progress",
-  "version": "0.2.6",
+  "version": "0.3.1",
   "description": "Yamada UI progress components",
   "keywords": [
     "yamada",
@@ -35,11 +35,11 @@
     "url": "https://github.com/hirotomoyamada/yamada-ui/issues"
   },
   "dependencies": {
-    "@yamada-ui/core": "0.3.0",
+    "@yamada-ui/core": "0.4.0",
     "@yamada-ui/utils": "0.1.1",
-    "@yamada-ui/use-value": "0.1.11",
-    "@yamada-ui/use-token": "0.1.11",
-    "@yamada-ui/use-animation": "0.1.11"
+    "@yamada-ui/use-value": "0.1.13",
+    "@yamada-ui/use-token": "0.1.13",
+    "@yamada-ui/use-animation": "0.1.13"
   },
   "devDependencies": {
     "react": "^18.0.0",
@@ -73,6 +73,6 @@
     "build:fast": "tsup src",
     "clean": "rimraf dist .turbo",
     "typecheck": "tsc --noEmit",
-    "gen:types": "tsx ../../../scripts/generate-types"
+    "gen:docs": "tsx ../../../scripts/generate-docs"
   }
 }