ProgressSpinner API

API documentation for ProgressSpinner component

ProgressSpinner#

Props#

Defines valid properties in ProgressSpinner component.

name	type	default	description
ref	Ref<unknown>	null	The reference to the component instance.
pIf	boolean	true	Whether the component should be rendered.
style	CSSProperties \| ((instance?: ProgressSpinnerInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: ProgressSpinnerInstance) => string)	null	The class name to apply to the component.
as	string \| 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.
asChild	boolean	false	Whether the component should be rendered as a child component.
pt	SafeRecord<ProgressSpinnerPassThrough>	null	The pass-through props to pass to the component
ptOptions	PassThroughOptions	null	The pass-through options to pass to the component
unstyled	boolean	null	Whether the component should be rendered without classes.
dt	unknown	null	The design token to use for the component.
styles	StylesOptions<ComponentInstance>	null	The styles to use for the component.
children	ReactNode \| ((instance: ProgressSpinnerInstance) => ReactNode)	null	The children to render.
strokeWidth	string \| number	2	Width of the circle stroke.
fill	string	null	Color for the background of the circle.
animationDuration	string	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#

PassThroughOptions

Defines passthrough(pt) options of ProgressSpinner component.

name	type	default	description
root	ProgressSpinnerPassThroughType<HTMLAttributes<HTMLDivElement>>	null	Used to pass attributes to the root's DOM element.
spin	ProgressSpinnerPassThroughType<HTMLAttributes<SVGElement>>	null	Used to pass attributes to the spin's DOM element.
circle	ProgressSpinnerPassThroughType<HTMLAttributes<SVGCircleElement>>	null	Used to pass attributes to the circle's DOM element.

Types#

Instance

Instance of ProgressSpinner component.

values
ComponentInstance<ProgressSpinnerProps, ProgressSpinnerState, ProgressSpinnerExposes>

useProgressSpinner#

Types#

Instance

Instance of useProgressSpinner headless.

values
HeadlessInstance<useProgressSpinnerProps, useProgressSpinnerState, useProgressSpinnerExposes>