ProgressSpinner API

API documentation for ProgressSpinner component

ProgressSpinner#

Props#

Defines valid properties in ProgressSpinner component.

nametypedefaultdescription
refRef<unknown>
null
The reference to the component instance.
pIfboolean
true
Whether the component should be rendered.
styleCSSProperties | ((instance?: ProgressSpinnerInstance) => CSSProperties)
null
The style to apply to the component.
classNamestring | ((instance?: ProgressSpinnerInstance) => string)
null
The class name to apply to the component.
asstring | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>
null
The component type to render.
asChildboolean
false
Whether the component should be rendered as a child component.
ptSafeRecord<ProgressSpinnerPassThrough>
null
The pass-through props to pass to the component
ptOptionsPassThroughOptions
null
The pass-through options to pass to the component
unstyledboolean
null
Whether the component should be rendered without classes.
dtunknown
null
The design token to use for the component.
stylesStylesOptions<ComponentInstance>
null
The styles to use for the component.
childrenReactNode | ((instance: ProgressSpinnerInstance) => ReactNode)
null
The children to render.
strokeWidthstring | number
2
Width of the circle stroke.
fillstring
null
Color for the background of the circle.
animationDurationstring
2s
Duration of the rotate animation.
[key: string]any
null
pt-{optionName}-*-
null
Pass through attributes for customizing component. For more info, see Pass Through tab.

Interfaces#

Defines passthrough(pt) options of ProgressSpinner component.

nametypedefaultdescription
rootProgressSpinnerPassThroughType<HTMLAttributes<HTMLDivElement>>
null
Used to pass attributes to the root's DOM element.
spinProgressSpinnerPassThroughType<HTMLAttributes<SVGElement>>
null
Used to pass attributes to the spin's DOM element.
circleProgressSpinnerPassThroughType<HTMLAttributes<SVGCircleElement>>
null
Used to pass attributes to the circle's DOM element.

Types#

Instance of ProgressSpinner component.

values
ComponentInstance<ProgressSpinnerProps, ProgressSpinnerState, ProgressSpinnerExposes>

useProgressSpinner#

Types#

Instance of useProgressSpinner headless.

values
HeadlessInstance<useProgressSpinnerProps, useProgressSpinnerState, useProgressSpinnerExposes>