Button API

API documentation for Button component

Button#

Props#

Defines valid properties in Button 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?: ButtonInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: ButtonInstance) => 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<ButtonPassThrough>	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: ButtonInstance) => ReactNode)	null	The children to render.
size	"small" \| "large" \| "normal"	null	Size of the Button.
severity	string & {} \| "secondary" \| "info" \| "success" \| "warn" \| "danger" \| "contrast" \| "help"	null	Severity type of the Button.
variant	"link" \| "text" \| "outlined"	null	Variant of the Button.
plain	boolean	null	Whether to show the Button with a plain style.
rounded	boolean	null	Whether to show the Button with a rounded style.
raised	boolean	null	Whether to show the Button with a raised style.
iconOnly	boolean	null	Whether to show the Button with a borderless style.
fluid	boolean	null	Whether to show the Button with a fluid width.
[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 Button component.

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

Types#

Instance

Instance of Button component.

values
ComponentInstance<ButtonProps, ButtonState, ButtonExposes>

ButtonGroup#

Props#

Defines valid properties in ButtonGroup 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?: ButtonGroupInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: ButtonGroupInstance) => 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<ButtonGroupPassThrough>	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: ButtonGroupInstance) => 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.

Interfaces#

PassThroughOptions

Defines passthrough(pt) options of Button component.

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

Types#

Instance

Instance of ButtonGroup component.

values
ComponentInstance<ButtonGroupProps, ButtonGroupState, ButtonGroupExposes>

useButton#

Types#

Instance

Instance of useButton headless.

values
HeadlessInstance<useButtonProps, useButtonState, useButtonExposes>