An optional ListItem addon to display on the opposite side of the
icon. So if the iconAfter prop is false, the addon will appear to
the right while setting iconAfter to true will render the addon to
the left instead.
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.
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 autoSave
autoSave?:string
checked
checked:boolean
Boolean if the element is currently checked.
Optional children
children?:ReactNode
Optional className
className?:string
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 disabled
disabled?:boolean
Boolean if the element should be disabled.
Optional disabledOpacity
disabledOpacity?:boolean
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.
remarks
@since 2.4.3
Optional draggable
draggable?:Booleanish
Optional forceAddonWrap
forceAddonWrap?:boolean
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.
Optional height
height?:ListItemHeight
The height to apply to the list item.
Conversions:
height !== "auto" -> height
secondaryText or left/right addon is media/media-large -> "extra-large"
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.
Optional property
property?:string
Optional radioGroup
radioGroup?:string
Optional resource
resource?:string
Optional results
results?:number
Optional role
role?:AriaRole
Optional secondaryText
secondaryText?:ReactNode
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.
Optional secondaryTextClassName
secondaryTextClassName?:string
An optional className to apply to the <span> that surrounds the
secondaryText within the list item.
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 textChildren
textChildren?:boolean
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.
Optional textClassName
textClassName?:string
An optional className to apply to the <span> that surrounds the
primaryText and optionally secondaryText within the list item.
Optional threeLines
threeLines?:boolean
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.
@since 2.8.0