/** * * ProgressSpinner is a process status indicator. * * [Live Demo](https://www.primevue.dev/progressspinner) * * @module progressspinner * */ import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { PassThroughOptions } from 'primevue/passthrough'; import type { VNode } from 'vue'; export declare type ProgressSpinnerPassThroughOptionType = ProgressSpinnerPassThroughAttributes | ((options: ProgressSpinnerPassThroughMethodOptions) => ProgressSpinnerPassThroughAttributes | string) | string | null | undefined; /** * Custom passthrough(pt) option method. */ export interface ProgressSpinnerPassThroughMethodOptions { /** * Defines instance. */ instance: any; /** * Defines valid properties. */ props: ProgressSpinnerProps; /** * Defines valid attributes. */ attrs: any; /** * Defines parent options. */ parent: any; /** * Defines passthrough(pt) options in global config. */ global: object | undefined; } /** * Custom passthrough(pt) options. * @see {@link ProgressSpinnerProps.pt} */ export interface ProgressSpinnerPassThroughOptions { /** * Used to pass attributes to the root's DOM element. */ root?: ProgressSpinnerPassThroughOptionType; /** * Used to pass attributes to the circle SVG element. */ circle?: ProgressSpinnerPassThroughOptionType; /** * Used to pass attributes to the circle track element. */ circleTrack?: ProgressSpinnerPassThroughOptionType; /** * Used to pass attributes to the circle range element. */ circleRange?: ProgressSpinnerPassThroughOptionType; /** * Used to pass attributes to the value text element. */ value?: ProgressSpinnerPassThroughOptionType; /** * Used to manage all lifecycle hooks. * @see {@link BaseComponent.ComponentHooks} */ hooks?: ComponentHooks; } /** * Custom passthrough attributes for each DOM elements */ export interface ProgressSpinnerPassThroughAttributes { [key: string]: any; } /** * Defines valid properties in ProgressSpinner component. */ export interface ProgressSpinnerProps { /** * Current progress value. When null, the component is in indeterminate mode. * @defaultValue null */ value?: number | null | undefined; /** * Minimum value of the progress. * @defaultValue 0 */ min?: number | undefined; /** * Maximum value of the progress. * @defaultValue 100 */ max?: number | undefined; /** * Width of the circle stroke. * @defaultValue 4 */ strokeWidth?: number | undefined; /** * Duration of the rotate animation. * @defaultValue '2s' */ animationDuration?: string | undefined; /** * It generates scoped CSS variables using design tokens for the component. */ dt?: DesignToken; /** * Used to pass attributes to DOM elements inside the component. * @type {ProgressSpinnerPassThroughOptions} */ pt?: PassThrough; /** * Used to configure passthrough(pt) options of the component. * @type {PassThroughOptions} */ ptOptions?: PassThroughOptions; /** * When enabled, it removes component related styles in the core. * @defaultValue false */ unstyled?: boolean; } /** * Defines valid slots in ProgressSpinner component. */ export interface ProgressSpinnerSlots { /** * Default slot to override the value text in determinate mode. * @param {Object} scope - default slot's params. */ default(scope: { /** * Current clamped value. */ value: number; /** * Rounded percent value (0-100). */ percent: number; }): VNode[]; } /** * Defines valid emits in ProgressSpinner component. */ export interface ProgressSpinnerEmitsOptions {} export declare type ProgressSpinnerEmits = EmitFn; /** * **PrimeVue - ProgressSpinner** * * _ProgressSpinner is a process status indicator._ * * [Live Demo](https://www.primevue.dev/progressspinner/) * --- --- * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png) * * @group Component * */ declare const ProgressSpinner: DefineComponent; declare module 'vue' { export interface GlobalComponents { ProgressSpinner: DefineComponent; } } export default ProgressSpinner;