Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UpBranchDefaultOptionsProps

Hierarchy

Index

Properties

Properties

ListItemTextProps: ListItemTextProps<"span", "p">
exitIcon: ReactNode
exitText: string
pathDirection: "up"
pathLabel: string
LinkComponent?: ElementType<any>

The component used to render a link when the href prop is provided.

default

'a'

TooltipProps?: Pick<IndividualTooltipProps, "exit" | "currentPath">
TouchRippleProps?: Partial<TouchRippleProps>

Props applied to the TouchRipple element.

about?: string
accessKey?: string
action?: Ref<ButtonBaseActions>

A ref for imperative actions. It currently only supports focusVisible() action.

alignItems?: "center" | "flex-start"

Defines the align-items style property.

default

'center'

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.

see

aria-pressed @see aria-selected.

aria-colcount?: number

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

see

aria-colindex.

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.

see

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.

see

aria-colindex @see aria-rowspan.

aria-controls?: string

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

see

aria-owns.

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

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.

see

aria-labelledby

aria-details?: string

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

see

aria-describedby.

aria-disabled?: Booleanish

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

see

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.

deprecated

in ARIA 1.1

aria-errormessage?: string

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

see

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.

deprecated

in ARIA 1.1

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

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.

see

aria-disabled.

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

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

see

aria-errormessage.

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.

see

aria-labelledby.

aria-labelledby?: string

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

see

aria-describedby.

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.

see

aria-controls.

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.

see

aria-setsize.

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

Indicates the current "pressed" state of toggle buttons.

see

aria-checked @see aria-selected.

aria-readonly?: Booleanish

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

see

aria-disabled.

aria-relevant?: "text" | "all" | "additions" | "additions removals" | "additions text" | "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.

see

aria-atomic.

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.

see

aria-rowindex.

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.

see

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.

see

aria-rowindex @see aria-colspan.

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

see

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.

see

aria-posinset.

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.

see

aria-valuetext.

aria-valuetext?: string

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

autoCapitalize?: string
autoCorrect?: string
autoFocus?: boolean

If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.

default

false

autoSave?: string
centerRipple?: boolean

If true, the ripples are centered. They won't start at the cursor interaction position.

default

false

className?: string
classes?: Partial<ListItemButtonClasses> & Partial<ClassNameMap<never>>

Override or extend the styles applied to the component.

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

Type declaration

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

If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.

default

false

dir?: string
disableGutters?: boolean

If true, the left and right padding is removed.

default

false

disableRipple?: boolean

If true, the ripple effect is disabled.

⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.

default

false

disableTouchRipple?: boolean

If true, the touch ripple effect is disabled.

default

false

disabled?: boolean

If true, the component is disabled.

default

false

divider?: boolean

If true, a 1px light border is added to the bottom of the list item.

default

false

draggable?: Booleanish
focusRipple?: boolean

If true, the base button will have a keyboard focus ripple.

default

false

focusVisibleClassName?: string

This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.

hidden?: boolean
id?: string
inlist?: any
inputMode?: "text" | "none" | "search" | "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

see

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

is?: string

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

see

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
key?: null | Key
lang?: string
nonce?: string
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>
onFocusVisible?: FocusEventHandler<any>

Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too.

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>
deprecated
onKeyPressCapture?: KeyboardEventHandler<HTMLLIElement>
deprecated
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>
onResize?: ReactEventHandler<HTMLLIElement>
onResizeCapture?: ReactEventHandler<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
property?: string
radioGroup?: string
ref?: null | ((instance: null | HTMLLIElement) => void) | RefObject<HTMLLIElement>
resource?: string
results?: number
role?: AriaRole
security?: string
selected?: boolean

Use to apply selected styling.

default

false

slot?: string
spellCheck?: Booleanish
style?: CSSProperties
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
sx?: SxProps<Theme>

The system prop that allows defining system overrides as well as additional CSS styles.

tabIndex?: number
default

0

title?: string
touchRippleRef?: Ref<TouchRippleActions>

A ref that points to the TouchRipple element.

translate?: "no" | "yes"
typeof?: string
unselectable?: "on" | "off"
value?: string | number | readonly string[]
vocab?: string

Generated using TypeDoc