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
An optional aria-label to provide to the nav toggle button that can be
used instead of the aria-labelledby prop to describe the button for
screen readers. When this and the aria-labelledby props are undefined, it
will default to:
"Show Navigation" for temporary layouts so that it will be read as
"Show Navigation Button" by screen readers
"Navigation" for toggleable layouts so that it will be read as
"Navigation Toggle Button" by screen readers
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.
Indicates if items in a table or grid are sorted in ascending or descending order.
Optional aria-valuemax
aria-valuemax?:number
Defines the maximum allowed value for a range widget.
Optional aria-valuemin
aria-valuemin?:number
Defines the minimum allowed value for a range widget.
Optional aria-valuenow
aria-valuenow?:number
Defines the current value for a range widget.
see
aria-valuetext.
Optional aria-valuetext
aria-valuetext?:string
Defines the human readable text alternative of aria-valuenow for a range widget.
Optional autoCapitalize
autoCapitalize?:string
Optional autoCorrect
autoCorrect?:string
Optional autoFocus
autoFocus?:boolean
Optional autoSave
autoSave?:string
Optional buttonType
buttonType?:ButtonType
This is the specific material design button type to use. This can either be
set to "text" or "icon". When this is set to "text", the styles applied
will make buttons with just text or text with icons render nicely. When
this is set to "icon", the styles applied will make icon only buttons
render nicely.
Optional children
children?:ReactNode
Any children to render within the button. This will normally just be text
or an icon.
Please note that it is considered invalid html to have a <div> as a
descendant of a <button>.
Optional className
className?:string
An optional className to also apply to the button for additional theming
and styling. This will be merged with the Button.theme class name styles.
Optional classNames
classNames?:CSSTransitionClassNames
The transition classnames to use for the toggleable LayoutNavigation
either comes into view or expands from mini to full-width.
Optional color
color?:string
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 disableEnterClick
disableEnterClick?:boolean
Boolean if the enter keyboard click polyfill should be completely disabled.
This is generally used if the keyboard functionality is already built-in to
the element like buttons or labels.
Optional disablePressedFallback
disablePressedFallback?:boolean
Boolean if the component should fallback to using the custom pressed class
names when ripples are disabled.
defaultvalue
false
Optional disableProgrammaticRipple
disableProgrammaticRipple?:boolean
Boolean if the ripple component should not be triggered after a
"programmatic" ripple effect. This would be if the .click() function is
called on an element through javascript or some other means.
Optional disableRipple
disableRipple?:boolean
Boolean if the ripple effect should be disabled for all child components
that use the Ripple states.
Optional disabled
disabled?:boolean
Enabling this prop will apply the disabled styles to a Button. When this
is also applied to the button component, the button will be updated so that
it can no longer be interacted with.
Optional draggable
draggable?:Booleanish
Optional enablePressedAndRipple
enablePressedAndRipple?:boolean
Boolean if the element should be able to gain both the ripple effect and
the pressed states changes. This will only be enabled if both the
disableRipple and disabledPressedFallback are still false
Optional floating
floating?:FABPosition
The position within the viewport to display the button as a floating action
button.
An optional object of event handlers to merge with the required
ripple trigger event handlers.
Optional hidden
hidden?:boolean
Optional id
id?:string
Optional inheritColor
inheritColor?:boolean
Boolean if this component should inherit the base color provided by the
AppBar. When this value is omitted, this will be enabled when the theme
is not "clear" and not "default"
Boolean if the button should offset the rest of the components in the
AppBar by the current size of the navigation panel. When this is
undefined, it will be true when a toggleable layout is visible.
Boolean if this component should be rendered. When this is undefined, it
will not be rendered for temporary layouts as well as when the toggleable
navigation panel is not visible.
Optional resource
resource?:string
Optional results
results?:number
Optional rippleClassName
rippleClassName?:string
An optional className to apply to the ripple element.
Optional rippleClassNames
rippleClassNames?:CSSTransitionClassNames
The class names to apply during the different stages for the ripple
animation. You probably don't want to use this.
Optional rippleContainerClassName
rippleContainerClassName?:string
An optional className to apply to the ripple's container element.
Optional rippleTimeout
rippleTimeout?:TransitionTimeout
The amount of time before a ripple finishes its animation. You probably
don't want to change this value unless you updated the duration in scss or
changed the different class names for the ripple animation.
Optional role
role?:AriaRole
Optional security
security?:string
Optional slot
slot?:string
Optional spellCheck
spellCheck?:Booleanish
Optional style
style?:CSSProperties
Optional suppressContentEditableWarning
suppressContentEditableWarning?:boolean
Optional suppressHydrationWarning
suppressHydrationWarning?:boolean
Optional tabIndex
tabIndex?:number
Optional theme
theme?:ButtonTheme
The material design theme to apply to the button. The theme prop will
update the look and feel of the button by applying different background
and/or foreground colors.
Optional themeType
themeType?:ButtonThemeType
The material design theme type to apply. The themeTYpe prop will update the
look and feel of the button by applying different border or box shadow.
Optional timeout
timeout?:TransitionTimeout
The transition timeout to use for the toggleable LayoutNavigation either
comes into view or expands from mini to full-width. The transition can be
disabled by setting this value to 0.
Optional title
title?:string
Optional translate
translate?:"yes" | "no"
Optional type
type?:"button" | "reset" | "submit"
The button's type attribute. This is set to "button" by default so that
forms are not accidentally submitted when this prop is omitted since
buttons without a type attribute work as submit by default.
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.