Progress ring

Exports

Import these components from @mbsw/ui.

ProgressRing

Props

The tables list common props for each component. See the full types for supported prop combinations and inherited HTML and Radix props.

ProgressRing

ProgressRing props
Prop	Type	Requirement
`aria-label`	`string`	Conditional
`aria-labelledby`	`string`	Conditional
`value`	`number`	Required

Type reference

Show full types

Full TypeScript definitions, including prop combinations and inherited props.

import { type ComponentPropsWithoutRef } from 'react';

type DataAttributes = {
    [key: `data-${string}`]: boolean | number | string | undefined;
};

type SvgProps = ComponentPropsWithoutRef<'svg'> & DataAttributes;

type ProgressRingAccessibleName = {
    'aria-label': string;
    'aria-labelledby'?: string;
} | {
    'aria-label'?: never;
    'aria-labelledby': string;
};

type ProgressRingOwnedSvgProp = 'aria-hidden' | 'aria-label' | 'aria-labelledby' | 'aria-valuemax' | 'aria-valuemin' | 'aria-valuenow' | 'children' | 'color' | 'dangerouslySetInnerHTML' | 'fill' | 'focusable' | 'height' | 'pathLength' | 'role' | 'stroke' | 'strokeDasharray' | 'strokeDashoffset' | 'strokeLinecap' | 'strokeWidth' | 'tabIndex' | 'transform' | 'viewBox' | 'width';

export type ProgressRingProps = Omit<SvgProps, ProgressRingOwnedSvgProp> & ProgressRingAccessibleName & {
    value: number;
};

export declare const ProgressRing: import("react").ForwardRefExoticComponent<ProgressRingProps & import("react").RefAttributes<SVGSVGElement>>;