@yamada-ui/progress/dist/progress.d.ts

Yamada UI progress components

import * as _yamada_ui_core from '@yamada-ui/core';
import { HTMLUIProps, ThemeProps, ColorModeToken, CSS } from '@yamada-ui/core';

interface ProgressOptions {
    /**
     * The CSS `color` property.
     */
    filledTrackColor?: ColorModeToken<CSS.Property.Color, "colors">;
    /**
     * If `true`, the progress bar will show stripe.
     *
     * @default false
     */
    hasStripe?: boolean;
    /**
     * If `true`, the progress will be indeterminate and the `value` prop will be ignored.
     *
     * @default false
     *
     * @deprecated It will be deprecated in version 2.0.
     */
    isAnimation?: boolean;
    /**
     * If `true`, and hasStripe is `true`, the stripes will be animated.
     *
     * @default false
     *
     * @deprecated It will be deprecated in version 2.0.
     */
    isStripeAnimation?: boolean;
    /**
     * The maximum value of the progress.
     *
     * @default 100
     */
    max?: number;
    /**
     * The minimum value of the progress.
     *
     * @default 0
     */
    min?: number;
    /**
     * The animation speed in seconds.
     *
     * @default '1.4s'
     */
    speed?: number | string;
    /**
     * The value of the progress.
     *
     * @default 0
     */
    value?: number;
}
interface ProgressProps extends HTMLUIProps, ThemeProps<"Progress">, ProgressOptions {
}
/**
 * `Progress` is a component for visually indicating progress.
 *
 * @see Docs https://yamada-ui.com/components/feedback/progress
 */
declare const Progress: _yamada_ui_core.Component<"div", ProgressProps>;

export { Progress, type ProgressProps };