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

Yamada UI progress components

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

interface CircleProgressOptions {
    /**
     * The CSS `box-size` property.
     *
     * @default '6rem'
     * @deprecated Use `boxSize` instead.
     */
    size?: CSSUIProps["boxSize"];
    /**
     * The CSS `color` property.
     *
     * @default 'primary'
     */
    color?: CSSUIProps["color"];
    /**
     * If `true`, the cap of the progress indicator will be rounded.
     *
     * @default false
     */
    fullRounded?: 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`, the cap of the progress indicator will be rounded.
     *
     * @default false
     *
     * @deprecated Use `fullRounded` instead.
     */
    isRounded?: 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, 2s]'
     */
    speed?: [number | string, number | string];
    /**
     * The CSS `width` property.
     *
     * @default '0.625ewm'
     */
    thickness?: CSSUIProps["width"];
    /**
     * The CSS `color` property.
     *
     * @default 'border'
     */
    trackColor?: CSSUIProps["color"];
    /**
     * The value of the progress.
     *
     * @default 0
     */
    value?: number;
}
interface CircleProgressProps extends Omit<HTMLUIProps, "color">, Omit<ThemeProps<"CircleProgress">, "size">, CircleProgressOptions {
}
/**
 * `CircleProgress` is a component that displays progress in a circular progress bar.
 *
 * @see Docs https://yamada-ui.com/components/feedback/circle-progress
 */
declare const CircleProgress: _yamada_ui_core.Component<"div", CircleProgressProps>;
declare const CircleProgressLabel: _yamada_ui_core.UIComponent<"span", {}>;

export { CircleProgress, CircleProgressLabel, type CircleProgressProps };