Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
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.
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 the current "checked" state of checkboxes, radio buttons, and other widgets.
Defines the total number of columns in a table, grid, or treegrid.
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
Identifies the element (or elements) whose contents or presence are controlled by the current element.
Indicates the element that represents the current item within a container or set of related elements.
Identifies the element (or elements) that describes the object.
Identifies the element that provides a detailed, extended description for the object.
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Indicates what functions can be performed when a dragged object is released on the drop target.
Identifies the element that provides an error message for the object.
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
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.
Indicates an element's "grabbed" state in a drag-and-drop operation.
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Indicates whether the element is exposed to an accessibility API.
Indicates the entered value does not conform to the format expected by the application.
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Defines a string value that labels the current element.
Identifies the element (or elements) that labels the current element.
Defines the hierarchical level of an element within a structure.
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.
Indicates whether an element is modal when displayed.
Indicates whether a text box accepts multiple lines of input or only a single line.
Indicates that the user may select more than one item from the current selectable descendants.
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
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.
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.
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 the current "pressed" state of toggle buttons.
Indicates that the element is not editable, but is otherwise operable.
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
Indicates that user input is required on the element before a form may be submitted.
Defines a human-readable, author-localized description for the role of an element.
Defines the total number of rows in a table, grid, or treegrid.
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
Indicates the current "selected" state of various widgets.
Defines the number of items 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.
Defines the maximum allowed value for a range widget.
Defines the minimum allowed value for a range widget.
Defines the current value for a range widget.
Defines the human readable text alternative of aria-valuenow for a range widget.
An optional className to apply to the badge since the
className prop is
passed down to the
Button component instead.
An optional id for the badge. Either this prop or the
id prop is required
for a11y when the
badgeChildren is provided to create the
aria-describedby value on the button.
An optional ref for the badge. The main
ref will be forwarded to the
An optional style to apply to the badge since the
style prop is passed
down to the
Button component instead.
The theme to use for the badge.
The content to display within the button since the
children prop is
passed down to the
Badge component instead.
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.
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
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.
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.
Boolean if the badge should still display if the children is set to
null. The default behavior is to render null for these cases since it
isn't extremely helpful to display an "empty" badge.
Boolean if the component should fallback to using the custom pressed class names when ripples are disabled.
Boolean if the ripple component should not be triggered after a
"programmatic" ripple effect. This would be if the
.click() function is
Boolean if the ripple effect should be disabled for all child components that use the Ripple states.
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.
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
disabledPressedFallback are still
The position within the viewport to display the button as a floating action button.
Any additional props to provide the to
FAB container element when the
floating prop is provided
An optional object of event handlers to merge with the required ripple trigger event handlers.
An id to use for the button. Either this prop or the
badgeId are required
for a11y when the
badgeChildren is provided. If the
badgeId is omitted,
the badge's id will be set to
Hints at the type of data that might be entered by the user while editing the element or its contents
Specify that a standard HTML element should behave like a defined custom built-in element
An optional className to apply to the ripple element.
The class names to apply during the different stages for the ripple animation. You probably don't want to use this.
An optional className to apply to the ripple's container element.
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.
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.
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.
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.
Generated using TypeDoc