ProgressBar API

API documentation for ProgressBar component

ProgressBarRoot#

Props#

Defines valid properties in ProgressBar 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?: ProgressBarRootInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: ProgressBarRootInstance) => 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<ProgressBarRootPassThrough>	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: ProgressBarRootInstance) => ReactNode)	null	The children to render.
mode	"indeterminate" \| "determinate"	determinate	Defines the mode of the progress
value	number	null	Current value of the progress.
max	number	null	Defines the mode of the progress
min	number	null	Defines the mode of the progress
formatter	(value: number) => string	null	Custom formatter function to format the display value
[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 ProgressBar component.

name	type	default	description
root	ProgressBarRootPassThroughType<HTMLAttributes<HTMLDivElement>>	null	Used to pass attributes to the root's DOM element.
value	ProgressBarRootPassThroughType<HTMLAttributes<HTMLDivElement>>	null	Used to pass attributes to the value's DOM element.

Types#

Instance

Instance of ProgressBar component.

values
ComponentInstance<ProgressBarRootProps, ProgressBarRootState, ProgressBarRootExposes>

ProgressBarLabel#

Props#

Defines valid properties in ProgressBarLabel 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?: ProgressBarLabelInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: ProgressBarLabelInstance) => 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<ProgressBarLabelPassThrough>	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: ProgressBarLabelInstance) => ReactNode)	null	The children to render.
[key: string]	any	null
pt-{optionName}-*	-	null	Pass through attributes for customizing component. For more info, see Pass Through tab.

Exposes#

Defines the methods and properties exposed by ProgressBarLabel component.

name	type	default	description
progressbar	ProgressBarRootInstance	null	The ProgressBar component instance.

Interfaces#

PassThroughOptions

Defines passthrough(pt) options of ProgressBarLabel component.

name	type	default	description
root	ProgressBarLabelPassThroughType<HTMLAttributes<HTMLDivElement>>	null	Used to pass attributes to the root's DOM element.

Types#

Instance

Instance of ProgressBarLabel component.

values
ComponentInstance<ProgressBarLabelProps, ProgressBarLabelState, ProgressBarLabelExposes>

useProgressBar#

Types#

Instance

Instance of useProgressBar headless.

values
HeadlessInstance<useProgressBarProps, useProgressBarState, useProgressBarExposes>