• Public
  • Public/Protected
  • All

Interface SimpleListItemProps





about?: string
accessKey?: string
aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

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.

aria-autocomplete?: "list" | "none" | "inline" | "both"

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.

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.

aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.


aria-pressed @see aria-selected.

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.



aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.


aria-colcount @see aria-colspan.

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.


aria-colindex @see aria-rowspan.

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.



aria-current?: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

Indicates the element that represents the current item within a container or set of related elements.

aria-describedby?: string

Identifies the element (or elements) that describes the object.



aria-details?: string

Identifies the element that provides a detailed, extended description for the object.



aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.


aria-hidden @see aria-readonly.

aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.


in ARIA 1.1

aria-errormessage?: string

Identifies the element that provides an error message for the object.


aria-invalid @see aria-describedby.

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

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.

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.


in ARIA 1.1

aria-haspopup?: boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.



aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.



aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

aria-label?: string

Defines a string value that labels the current element.



aria-labelledby?: string

Identifies the element (or elements) that labels the current element.



aria-level?: number

Defines the hierarchical level of an element within a structure.

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.

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

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.



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.

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.



aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.


aria-checked @see aria-selected.

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.



aria-relevant?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.



aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.



aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.


aria-rowcount @see aria-rowspan.

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.


aria-rowindex @see aria-colspan.

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.


aria-checked @see aria-pressed.

aria-setsize?: number

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.



aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

aria-valuenow?: number

Defines the current value for a range widget.



aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

autoCapitalize?: string
autoCorrect?: string
autoSave?: string
children?: ReactNode

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.

className?: string
clickable?: boolean

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.

color?: string
contentEditable?: Booleanish | "inherit"
contextMenu?: string
dangerouslySetInnerHTML?: { __html: string }

Type declaration

  • __html: string
datatype?: string
defaultChecked?: boolean
defaultValue?: string | number | readonly string[]
dir?: string
disabled?: boolean

This prop shouldn't really be used other than a pass-down value from the ListItem component.

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.


@since 2.4.3

draggable?: Booleanish
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.

The height to apply to the list item.


  • height !== "auto" -> height
  • secondaryText or left/right addon is media/media-large -> "extra-large"
  • left/right addon is avatar -> "large"
  • left/right addon is icon -> "medium"
  • no addons and no secondary text -> "normal"
hidden?: boolean
id?: string
inlist?: any
inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents



is?: string

Specify that a standard HTML element should behave like a defined custom built-in element



itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
lang?: string
leftAddon?: ReactNode

An optional addon to display to the left of the primaryText or children and should be used with the leftAddonType prop to adjust spacing.

leftAddonPosition?: ListItemAddonPosition

The vertical position the left icon, avatar, media, or large media should be placed.

leftAddonType?: ListItemAddonType

The type of the addon that appears to the left of the primaryText or children.

onAbort?: ReactEventHandler<HTMLLIElement>
onAbortCapture?: ReactEventHandler<HTMLLIElement>
onAnimationEnd?: AnimationEventHandler<HTMLLIElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLLIElement>
onAnimationIteration?: AnimationEventHandler<HTMLLIElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLLIElement>
onAnimationStart?: AnimationEventHandler<HTMLLIElement>
onAnimationStartCapture?: AnimationEventHandler<HTMLLIElement>
onAuxClick?: MouseEventHandler<HTMLLIElement>
onAuxClickCapture?: MouseEventHandler<HTMLLIElement>
onBeforeInput?: FormEventHandler<HTMLLIElement>
onBeforeInputCapture?: FormEventHandler<HTMLLIElement>
onBlur?: FocusEventHandler<HTMLLIElement>
onBlurCapture?: FocusEventHandler<HTMLLIElement>
onCanPlay?: ReactEventHandler<HTMLLIElement>
onCanPlayCapture?: ReactEventHandler<HTMLLIElement>
onCanPlayThrough?: ReactEventHandler<HTMLLIElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLLIElement>
onChange?: FormEventHandler<HTMLLIElement>
onChangeCapture?: FormEventHandler<HTMLLIElement>
onClick?: MouseEventHandler<HTMLLIElement>
onClickCapture?: MouseEventHandler<HTMLLIElement>
onCompositionEnd?: CompositionEventHandler<HTMLLIElement>
onCompositionEndCapture?: CompositionEventHandler<HTMLLIElement>
onCompositionStart?: CompositionEventHandler<HTMLLIElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLLIElement>
onCompositionUpdate?: CompositionEventHandler<HTMLLIElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLLIElement>
onContextMenu?: MouseEventHandler<HTMLLIElement>
onContextMenuCapture?: MouseEventHandler<HTMLLIElement>
onCopy?: ClipboardEventHandler<HTMLLIElement>
onCopyCapture?: ClipboardEventHandler<HTMLLIElement>
onCut?: ClipboardEventHandler<HTMLLIElement>
onCutCapture?: ClipboardEventHandler<HTMLLIElement>
onDoubleClick?: MouseEventHandler<HTMLLIElement>
onDoubleClickCapture?: MouseEventHandler<HTMLLIElement>
onDrag?: DragEventHandler<HTMLLIElement>
onDragCapture?: DragEventHandler<HTMLLIElement>
onDragEnd?: DragEventHandler<HTMLLIElement>
onDragEndCapture?: DragEventHandler<HTMLLIElement>
onDragEnter?: DragEventHandler<HTMLLIElement>
onDragEnterCapture?: DragEventHandler<HTMLLIElement>
onDragExit?: DragEventHandler<HTMLLIElement>
onDragExitCapture?: DragEventHandler<HTMLLIElement>
onDragLeave?: DragEventHandler<HTMLLIElement>
onDragLeaveCapture?: DragEventHandler<HTMLLIElement>
onDragOver?: DragEventHandler<HTMLLIElement>
onDragOverCapture?: DragEventHandler<HTMLLIElement>
onDragStart?: DragEventHandler<HTMLLIElement>
onDragStartCapture?: DragEventHandler<HTMLLIElement>
onDrop?: DragEventHandler<HTMLLIElement>
onDropCapture?: DragEventHandler<HTMLLIElement>
onDurationChange?: ReactEventHandler<HTMLLIElement>
onDurationChangeCapture?: ReactEventHandler<HTMLLIElement>
onEmptied?: ReactEventHandler<HTMLLIElement>
onEmptiedCapture?: ReactEventHandler<HTMLLIElement>
onEncrypted?: ReactEventHandler<HTMLLIElement>
onEncryptedCapture?: ReactEventHandler<HTMLLIElement>
onEnded?: ReactEventHandler<HTMLLIElement>
onEndedCapture?: ReactEventHandler<HTMLLIElement>
onError?: ReactEventHandler<HTMLLIElement>
onErrorCapture?: ReactEventHandler<HTMLLIElement>
onFocus?: FocusEventHandler<HTMLLIElement>
onFocusCapture?: FocusEventHandler<HTMLLIElement>
onGotPointerCapture?: PointerEventHandler<HTMLLIElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLLIElement>
onInput?: FormEventHandler<HTMLLIElement>
onInputCapture?: FormEventHandler<HTMLLIElement>
onInvalid?: FormEventHandler<HTMLLIElement>
onInvalidCapture?: FormEventHandler<HTMLLIElement>
onKeyDown?: KeyboardEventHandler<HTMLLIElement>
onKeyDownCapture?: KeyboardEventHandler<HTMLLIElement>
onKeyPress?: KeyboardEventHandler<HTMLLIElement>
onKeyPressCapture?: KeyboardEventHandler<HTMLLIElement>
onKeyUp?: KeyboardEventHandler<HTMLLIElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLLIElement>
onLoad?: ReactEventHandler<HTMLLIElement>
onLoadCapture?: ReactEventHandler<HTMLLIElement>
onLoadStart?: ReactEventHandler<HTMLLIElement>
onLoadStartCapture?: ReactEventHandler<HTMLLIElement>
onLoadedData?: ReactEventHandler<HTMLLIElement>
onLoadedDataCapture?: ReactEventHandler<HTMLLIElement>
onLoadedMetadata?: ReactEventHandler<HTMLLIElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLLIElement>
onLostPointerCapture?: PointerEventHandler<HTMLLIElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLLIElement>
onMouseDown?: MouseEventHandler<HTMLLIElement>
onMouseDownCapture?: MouseEventHandler<HTMLLIElement>
onMouseEnter?: MouseEventHandler<HTMLLIElement>
onMouseLeave?: MouseEventHandler<HTMLLIElement>
onMouseMove?: MouseEventHandler<HTMLLIElement>
onMouseMoveCapture?: MouseEventHandler<HTMLLIElement>
onMouseOut?: MouseEventHandler<HTMLLIElement>
onMouseOutCapture?: MouseEventHandler<HTMLLIElement>
onMouseOver?: MouseEventHandler<HTMLLIElement>
onMouseOverCapture?: MouseEventHandler<HTMLLIElement>
onMouseUp?: MouseEventHandler<HTMLLIElement>
onMouseUpCapture?: MouseEventHandler<HTMLLIElement>
onPaste?: ClipboardEventHandler<HTMLLIElement>
onPasteCapture?: ClipboardEventHandler<HTMLLIElement>
onPause?: ReactEventHandler<HTMLLIElement>
onPauseCapture?: ReactEventHandler<HTMLLIElement>
onPlay?: ReactEventHandler<HTMLLIElement>
onPlayCapture?: ReactEventHandler<HTMLLIElement>
onPlaying?: ReactEventHandler<HTMLLIElement>
onPlayingCapture?: ReactEventHandler<HTMLLIElement>
onPointerCancel?: PointerEventHandler<HTMLLIElement>
onPointerCancelCapture?: PointerEventHandler<HTMLLIElement>
onPointerDown?: PointerEventHandler<HTMLLIElement>
onPointerDownCapture?: PointerEventHandler<HTMLLIElement>
onPointerEnter?: PointerEventHandler<HTMLLIElement>
onPointerEnterCapture?: PointerEventHandler<HTMLLIElement>
onPointerLeave?: PointerEventHandler<HTMLLIElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLLIElement>
onPointerMove?: PointerEventHandler<HTMLLIElement>
onPointerMoveCapture?: PointerEventHandler<HTMLLIElement>
onPointerOut?: PointerEventHandler<HTMLLIElement>
onPointerOutCapture?: PointerEventHandler<HTMLLIElement>
onPointerOver?: PointerEventHandler<HTMLLIElement>
onPointerOverCapture?: PointerEventHandler<HTMLLIElement>
onPointerUp?: PointerEventHandler<HTMLLIElement>
onPointerUpCapture?: PointerEventHandler<HTMLLIElement>
onProgress?: ReactEventHandler<HTMLLIElement>
onProgressCapture?: ReactEventHandler<HTMLLIElement>
onRateChange?: ReactEventHandler<HTMLLIElement>
onRateChangeCapture?: ReactEventHandler<HTMLLIElement>
onReset?: FormEventHandler<HTMLLIElement>
onResetCapture?: FormEventHandler<HTMLLIElement>
onScroll?: UIEventHandler<HTMLLIElement>
onScrollCapture?: UIEventHandler<HTMLLIElement>
onSeeked?: ReactEventHandler<HTMLLIElement>
onSeekedCapture?: ReactEventHandler<HTMLLIElement>
onSeeking?: ReactEventHandler<HTMLLIElement>
onSeekingCapture?: ReactEventHandler<HTMLLIElement>
onSelect?: ReactEventHandler<HTMLLIElement>
onSelectCapture?: ReactEventHandler<HTMLLIElement>
onStalled?: ReactEventHandler<HTMLLIElement>
onStalledCapture?: ReactEventHandler<HTMLLIElement>
onSubmit?: FormEventHandler<HTMLLIElement>
onSubmitCapture?: FormEventHandler<HTMLLIElement>
onSuspend?: ReactEventHandler<HTMLLIElement>
onSuspendCapture?: ReactEventHandler<HTMLLIElement>
onTimeUpdate?: ReactEventHandler<HTMLLIElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLLIElement>
onTouchCancel?: TouchEventHandler<HTMLLIElement>
onTouchCancelCapture?: TouchEventHandler<HTMLLIElement>
onTouchEnd?: TouchEventHandler<HTMLLIElement>
onTouchEndCapture?: TouchEventHandler<HTMLLIElement>
onTouchMove?: TouchEventHandler<HTMLLIElement>
onTouchMoveCapture?: TouchEventHandler<HTMLLIElement>
onTouchStart?: TouchEventHandler<HTMLLIElement>
onTouchStartCapture?: TouchEventHandler<HTMLLIElement>
onTransitionEnd?: TransitionEventHandler<HTMLLIElement>
onTransitionEndCapture?: TransitionEventHandler<HTMLLIElement>
onVolumeChange?: ReactEventHandler<HTMLLIElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLLIElement>
onWaiting?: ReactEventHandler<HTMLLIElement>
onWaitingCapture?: ReactEventHandler<HTMLLIElement>
onWheel?: WheelEventHandler<HTMLLIElement>
onWheelCapture?: WheelEventHandler<HTMLLIElement>
placeholder?: string
prefix?: string
primaryText?: ReactNode

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.

property?: string
radioGroup?: string
resource?: string
results?: number
rightAddon?: ReactNode

An optional addon to display to the right of the primaryText or children and should be used with the rightAddonType prop to adjust spacing.

rightAddonPosition?: ListItemAddonPosition

The vertical position the right icon, avatar, media, or large media should be placed.

rightAddonType?: ListItemAddonType

The type of the addon that appears to the right of the primaryText or children.

role?: AriaRole
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.

secondaryTextClassName?: string

An optional className to apply to the <span> that surrounds the secondaryText within the list item.

security?: string
slot?: string
spellCheck?: Booleanish
style?: CSSProperties
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
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.

textClassName?: string

An optional className to apply to the <span> that surrounds the primaryText and optionally secondaryText within the list item.

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.

title?: string
translate?: "yes" | "no"
typeof?: string
unselectable?: "on" | "off"
vocab?: string

Generated using TypeDoc