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.
The main content to display. When the textChildren prop is enabled and
there is child content, it will be treated as primary text and update the
styles automatically.
Boolean if the list item should be updated to use the clickable styles to
the item. This is really just a pass-down value for the main ListItem
component and shouldn't really be used unless you are implementing your own
clickable ListItem component.
Boolean if the menu should no longer close when the page is resized. Instead, it'll automatically update its position within the viewport.
Boolean if the menu should not be closed when the page is scrolled. Instead, it'll automatically update its position within the viewport. You normally don't want to enable this prop as the menu won't close if the menu control element is no longer in the viewport.
Boolean if the menu should be visible immediately once this component mounts.
Boolean if the dropdown icon should be removed from the button. The icon will always be removed for icon buttons.
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.
The default behavior of the dropdown menu is to close when the escape key is pressed. Now that there are multiple nested menus, this will actually close all of them by default. If this is undesired behavior, you can enable this prop which will make sure only the top-level dropdown menu will be closed.
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
called on an element through javascript or some other means.
Boolean if the ripple effect should be disabled for all child components that use the Ripple states.
Boolean if the spacebar should not trigger a click event when using the user pressed spacebar on a focusable element. You normally want the spacebar to also trigger a click event , but there are a few cases where it should not (like custom links).
When this is disabled, it will also make sure that the ripple and pressed effects are not triggered from a spacebar click.
This prop shouldn't really be used other than a pass-down value from the ListItem component.
Boolean if the list item should apply an opacity value while disabled instead of overriding the primary and secondary text colors. Enabling this will allow for the list item addons to also be dimmed.
This is configured by the $rmd-list-item-disabled-opacity variable.
Note: This does nothing if the disabled prop is not enabled.
The icon to show after the children in the button when the buttonType is
not set to "icon".
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
Boolean if the left and/or right addons should be "forcefully" wrapped in a
<span> with the spacing class names applied instead of attempting to
clone it into the provided icon element.
An optional object of event handlers to merge with the required ripple trigger event handlers.
The height to apply to the list item.
Conversions:
Boolean if the menu should be rendered horizontally instead of vertically.
The id to use for the menu button and used to create the id for the menu.
The menu's id will just be ${id}-menu.
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
A function to call for each item in the items list to render a
ReactElement.
A list of menu items to render. Each item will be passed to the
menuItemRenderer function.
An optional addon to display to the left of the primaryText or
children and should be used with the leftAddonType prop to adjust
spacing.
The vertical position the left icon, avatar, media, or large media should be placed.
The type of the addon that appears to the left of the primaryText or
children.
An optional className to pass to the menuRenderer/Menu component.
The label to use for the menu. Either this or the menuLabelledBy props
are required for a11y.
The id for an element to label the menu. Either this or the menuLabel
props are required for a11y. This will be defaulted to the id of the menu
button for convenience since it should normally label the menu but should
be changed if it does not.
A custom menu renderer to use. This defaults to just rendering the Menu
component with the base required props and a generated id from the button
id.
An optional style object to pass to the menuRenderer/Menu component.
Boolean if the portal should be used.
Optional options to pass down to the useFixedPositionin hook styles to
change how the menu is fixed to the MenuButton.
An optional element that should be rendered as the primaryText within the
list item. It is most likely easier to use the children prop instead, but
this allows you to create more complex components with the ListItem since
you can provided children and have the styles for the primaryText still
applied. By default, this will only allow one line of text and add ellipsis
for any text overflow.
An optional addon to display to the right of the primaryText or
children and should be used with the rightAddonType prop to adjust
spacing.
The vertical position the right icon, avatar, media, or large media should be placed.
The type of the addon that appears to the right of the primaryText or
children.
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 current role for the menu item. This will eventually be updated for
some of the other menuitem* widgets.
An optional element that should be rendered as the secondaryText within
the list item. By default, this will only span one line and add ellipsis
for overflow.
An optional className to apply to the <span> that surrounds the
secondaryText within the list item.
The tab index for the menu item. This should always stay at -1.
Boolean if the children should be treated as the primaryText prop. This
will wrap them in an additional class so that they have ellipsis for text
overflow.
If you want to have more "freedom" within the ListItem, you can disable
this prop so that the height will grow depending on content.
NOTE: If the secondaryText prop is provided, this will always be
considered true.
An optional className to apply to the <span> that surrounds the
primaryText and optionally secondaryText within the list item.
Boolean if the list item should be considered "three-lines" in height. This
will update the secondaryText to span 2 lines instead of one, but it will
not correctly applied the trailing ellipsis overflow due to browser
compatibility of line-clamp. If you would still like the ellipsis to
show, it is recommended to use javascript to add them yourself.
An optional function to call when the visibility of the menu changes.
Generated using TypeDoc
The positioning anchor for the menu relative to the button/control that owns the menu. This is used for the positioning logic as well as modifying the animationg slightly to originate from a coordinate. When this is omitted, it will default to: