useButton API

API reference docs for the useButton hook. Learn about the input parameters and other APIs of this exported module.

Demos

For examples and details on the usage of this React hook, visit the demo pages:

import { useButton } from '@mui/base/ButtonUnstyled';

Name	Type	Default	Description
disabled	boolean	false	If `true`, the component is disabled.
focusableWhenDisabled	boolean	false	If `true`, allows a disabled button to receive focus.
href	string
onFocusVisible	React.FocusEventHandler
ref	React.Ref<any>
tabIndex	NonNullable<React.HTMLAttributes<any>['tabIndex']>
to	string
type	React.ButtonHTMLAttributes<HTMLButtonElement>['type']	'button'	Type attribute applied when the `component` is `button`.

Name	Type	Default	Description
active	boolean	false	If `true`, the component is active (pressed).
disabled	boolean	false	If `true`, the component is disabled.
focusVisible	boolean	false	If `true`, the component is being focused using keyboard.
getRootProps	<TOther extends EventHandlers = {}>(otherHandlers?: TOther) => UseButtonRootSlotProps<TOther>		Resolver for the root slot's props.
setFocusVisible	React.Dispatch<React.SetStateAction<boolean>>		Callback for setting the `focusVisible` param.