The component used to render a link when the href prop is provided.
default
'a'
Optional TouchRippleProps
TouchRippleProps?:Partial<TouchRippleProps>
Props applied to the TouchRipple element.
Optional about
about?:string
Optional accessKey
accessKey?:string
Optional action
action?:Ref<ButtonBaseActions>
A ref for imperative actions.
It currently only supports focusVisible() action.
Optional aria-activedescendant
aria-activedescendant?:string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Optional aria-atomic
aria-atomic?:Booleanish
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
presented if they are made.
Optional aria-busy
aria-busy?:Booleanish
Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
Indicates what functions can be performed when a dragged object is released on the drop target.
deprecated
in ARIA 1.1
Optional aria-errormessage
aria-errormessage?:string
Identifies the element that provides an error message for the object.
see
aria-invalid @see aria-describedby.
Optional aria-expanded
aria-expanded?:Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Optional aria-flowto
aria-flowto?:string
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
allows assistive technology to override the general default of reading in document source order.
Optional aria-grabbed
aria-grabbed?:Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
Indicates the entered value does not conform to the format expected by the application.
see
aria-errormessage.
Optional aria-keyshortcuts
aria-keyshortcuts?:string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Optional aria-label
aria-label?:string
Defines a string value that labels the current element.
see
aria-labelledby.
Optional aria-labelledby
aria-labelledby?:string
Identifies the element (or elements) that labels the current element.
see
aria-describedby.
Optional aria-level
aria-level?:number
Defines the hierarchical level of an element within a structure.
Optional aria-live
aria-live?:"off" | "assertive" | "polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
Optional aria-modal
aria-modal?:Booleanish
Indicates whether an element is modal when displayed.
Optional aria-multiline
aria-multiline?:Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
Optional aria-multiselectable
aria-multiselectable?:Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
Optional aria-orientation
aria-orientation?:"horizontal" | "vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Optional aria-owns
aria-owns?:string
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
see
aria-controls.
Optional aria-placeholder
aria-placeholder?:string
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
A hint could be a sample value or a brief description of the expected format.
Optional aria-posinset
aria-posinset?:number
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
The color of the component.
It supports both default and custom theme colors, which can be added as shown in the
palette customization guide.
default
'primary'
Optional contentEditable
contentEditable?:Booleanish | "inherit"
Optional contextMenu
contextMenu?:string
Optional dangerouslySetInnerHTML
dangerouslySetInnerHTML?:{ __html: string }
Type declaration
__html: string
Optional datatype
datatype?:string
Optional defaultChecked
defaultChecked?:boolean
Optional defaultValue
defaultValue?:string | number | readonly string[]
Optional dir
dir?:string
Optional disableElevation
disableElevation?:boolean
If true, no elevation is used.
default
false
Optional disableFocusRipple
disableFocusRipple?:boolean
If true, the keyboard focus ripple is disabled.
default
false
Optional disableRipple
disableRipple?:boolean
If true, the ripple effect is disabled.
⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure
to highlight the element by applying separate styles with the .Mui-focusVisible class.
default
false
Optional disableTouchRipple
disableTouchRipple?:boolean
If true, the touch ripple effect is disabled.
default
false
Optional disabled
disabled?:boolean
If true, the component is disabled.
default
false
Optional draggable
draggable?:Booleanish
Optional endIcon
endIcon?:ReactNode
Element placed after the children.
Optional focusRipple
focusRipple?:boolean
If true, the base button will have a keyboard focus ripple.
default
false
Optional focusVisibleClassName
focusVisibleClassName?:string
This prop can help identify which element has keyboard focus.
The class name will be applied when the element gains the focus through keyboard interaction.
It's a polyfill for the CSS :focus-visible selector.
The rationale for using this feature is explained here.
A polyfill can be used to apply a focus-visible class to other components
if needed.
Optional form
form?:string
Optional formAction
formAction?:string
Optional formEncType
formEncType?:string
Optional formMethod
formMethod?:string
Optional formNoValidate
formNoValidate?:boolean
Optional formTarget
formTarget?:string
Optional fullWidth
fullWidth?:boolean
If true, the button will take up the full width of its container.
default
false
Optional hidden
hidden?:boolean
Optional href
href?:string
The URL to link to when the button is clicked.
If defined, an a element will be used as the root node.
Interface for the button properties used when creating a new button