• Public
  • Public/Protected
  • All

The base props for the Tooltip component. This can be extended when creating custom tooltip implementations.


@since 2.8.0 Supports the RenderConditionalPortalProps


  • HTMLAttributes<HTMLSpanElement>
  • RenderConditionalPortalProps
  • CSSTransitionComponentProps
    • TooltipProps




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 contents of the tooltip to display. This can be any renderable element, but this is normally just text.

If this is placed within a <button> element, make sure that there are no <div> since it is invalid html to have a <div> as a child of a <button>.

className?: string

An optional class name to apply to the tooltip.

classNames?: CSSTransitionClassNames

This ties directly into the CSSTransition classNames prop and is used to generate and apply the correct class names during the tooltip's transition.

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

Type declaration

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

Boolean if the tooltip is using the dense spec. This will reduce the padding, margin and font size for the tooltip and is usually used for desktop displays.

dir?: string
draggable?: Booleanish
hidden?: boolean
id: string

An id for the tooltip. This is required for accessibility and finding an element to attach event listeners to show and hide the tooltip.

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
lineWrap?: boolean

Boolean if the tooltip should allow line wrapping. This is disabled by default since the tooltip will display weirdly when its container element is small in size. It is advised to only enable line wrapping when there are long tooltips or the tooltips are bigger than the container element.

Once line wrapping is enabled, you will most likely need to set some additional padding and widths.

onAbort?: ReactEventHandler<HTMLSpanElement>
onAbortCapture?: ReactEventHandler<HTMLSpanElement>
onAnimationEnd?: AnimationEventHandler<HTMLSpanElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLSpanElement>
onAnimationIteration?: AnimationEventHandler<HTMLSpanElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLSpanElement>
onAnimationStart?: AnimationEventHandler<HTMLSpanElement>
onAnimationStartCapture?: AnimationEventHandler<HTMLSpanElement>
onAuxClick?: MouseEventHandler<HTMLSpanElement>
onAuxClickCapture?: MouseEventHandler<HTMLSpanElement>
onBeforeInput?: FormEventHandler<HTMLSpanElement>
onBeforeInputCapture?: FormEventHandler<HTMLSpanElement>
onBlur?: FocusEventHandler<HTMLSpanElement>
onBlurCapture?: FocusEventHandler<HTMLSpanElement>
onCanPlay?: ReactEventHandler<HTMLSpanElement>
onCanPlayCapture?: ReactEventHandler<HTMLSpanElement>
onCanPlayThrough?: ReactEventHandler<HTMLSpanElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLSpanElement>
onChange?: FormEventHandler<HTMLSpanElement>
onChangeCapture?: FormEventHandler<HTMLSpanElement>
onClick?: MouseEventHandler<HTMLSpanElement>
onClickCapture?: MouseEventHandler<HTMLSpanElement>
onCompositionEnd?: CompositionEventHandler<HTMLSpanElement>
onCompositionEndCapture?: CompositionEventHandler<HTMLSpanElement>
onCompositionStart?: CompositionEventHandler<HTMLSpanElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLSpanElement>
onCompositionUpdate?: CompositionEventHandler<HTMLSpanElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLSpanElement>
onContextMenu?: MouseEventHandler<HTMLSpanElement>
onContextMenuCapture?: MouseEventHandler<HTMLSpanElement>
onCopy?: ClipboardEventHandler<HTMLSpanElement>
onCopyCapture?: ClipboardEventHandler<HTMLSpanElement>
onCut?: ClipboardEventHandler<HTMLSpanElement>
onCutCapture?: ClipboardEventHandler<HTMLSpanElement>
onDoubleClick?: MouseEventHandler<HTMLSpanElement>
onDoubleClickCapture?: MouseEventHandler<HTMLSpanElement>
onDrag?: DragEventHandler<HTMLSpanElement>
onDragCapture?: DragEventHandler<HTMLSpanElement>
onDragEnd?: DragEventHandler<HTMLSpanElement>
onDragEndCapture?: DragEventHandler<HTMLSpanElement>
onDragEnter?: DragEventHandler<HTMLSpanElement>
onDragEnterCapture?: DragEventHandler<HTMLSpanElement>
onDragExit?: DragEventHandler<HTMLSpanElement>
onDragExitCapture?: DragEventHandler<HTMLSpanElement>
onDragLeave?: DragEventHandler<HTMLSpanElement>
onDragLeaveCapture?: DragEventHandler<HTMLSpanElement>
onDragOver?: DragEventHandler<HTMLSpanElement>
onDragOverCapture?: DragEventHandler<HTMLSpanElement>
onDragStart?: DragEventHandler<HTMLSpanElement>
onDragStartCapture?: DragEventHandler<HTMLSpanElement>
onDrop?: DragEventHandler<HTMLSpanElement>
onDropCapture?: DragEventHandler<HTMLSpanElement>
onDurationChange?: ReactEventHandler<HTMLSpanElement>
onDurationChangeCapture?: ReactEventHandler<HTMLSpanElement>
onEmptied?: ReactEventHandler<HTMLSpanElement>
onEmptiedCapture?: ReactEventHandler<HTMLSpanElement>
onEncrypted?: ReactEventHandler<HTMLSpanElement>
onEncryptedCapture?: ReactEventHandler<HTMLSpanElement>
onEnded?: ReactEventHandler<HTMLSpanElement>
onEndedCapture?: ReactEventHandler<HTMLSpanElement>
onEnter?: TransitionEnterHandler

This function will be called once the TransitionStage has been set to "enter".



onEntered?: TransitionEnterHandler

This function will be called once the TransitionStage has been set to "entering".



onEntering?: TransitionEnterHandler

This function will be called once the TransitionStage has been set to "enter".



onError?: ReactEventHandler<HTMLSpanElement>
onErrorCapture?: ReactEventHandler<HTMLSpanElement>
onExit?: TransitionExitHandler

This function will be called once the TransitionStage has been set to "entered".



onExited?: TransitionExitHandler

This function will be called once the TransitionStage has been set to "exited".



onExiting?: TransitionExitHandler

This function will be called once the TransitionStage has been set to "exiting".



onFocus?: FocusEventHandler<HTMLSpanElement>
onFocusCapture?: FocusEventHandler<HTMLSpanElement>
onGotPointerCapture?: PointerEventHandler<HTMLSpanElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLSpanElement>
onInput?: FormEventHandler<HTMLSpanElement>
onInputCapture?: FormEventHandler<HTMLSpanElement>
onInvalid?: FormEventHandler<HTMLSpanElement>
onInvalidCapture?: FormEventHandler<HTMLSpanElement>
onKeyDown?: KeyboardEventHandler<HTMLSpanElement>
onKeyDownCapture?: KeyboardEventHandler<HTMLSpanElement>
onKeyPress?: KeyboardEventHandler<HTMLSpanElement>
onKeyPressCapture?: KeyboardEventHandler<HTMLSpanElement>
onKeyUp?: KeyboardEventHandler<HTMLSpanElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLSpanElement>
onLoad?: ReactEventHandler<HTMLSpanElement>
onLoadCapture?: ReactEventHandler<HTMLSpanElement>
onLoadStart?: ReactEventHandler<HTMLSpanElement>
onLoadStartCapture?: ReactEventHandler<HTMLSpanElement>
onLoadedData?: ReactEventHandler<HTMLSpanElement>
onLoadedDataCapture?: ReactEventHandler<HTMLSpanElement>
onLoadedMetadata?: ReactEventHandler<HTMLSpanElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLSpanElement>
onLostPointerCapture?: PointerEventHandler<HTMLSpanElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLSpanElement>
onMouseDown?: MouseEventHandler<HTMLSpanElement>
onMouseDownCapture?: MouseEventHandler<HTMLSpanElement>
onMouseEnter?: MouseEventHandler<HTMLSpanElement>
onMouseLeave?: MouseEventHandler<HTMLSpanElement>
onMouseMove?: MouseEventHandler<HTMLSpanElement>
onMouseMoveCapture?: MouseEventHandler<HTMLSpanElement>
onMouseOut?: MouseEventHandler<HTMLSpanElement>
onMouseOutCapture?: MouseEventHandler<HTMLSpanElement>
onMouseOver?: MouseEventHandler<HTMLSpanElement>
onMouseOverCapture?: MouseEventHandler<HTMLSpanElement>
onMouseUp?: MouseEventHandler<HTMLSpanElement>
onMouseUpCapture?: MouseEventHandler<HTMLSpanElement>
onPaste?: ClipboardEventHandler<HTMLSpanElement>
onPasteCapture?: ClipboardEventHandler<HTMLSpanElement>
onPause?: ReactEventHandler<HTMLSpanElement>
onPauseCapture?: ReactEventHandler<HTMLSpanElement>
onPlay?: ReactEventHandler<HTMLSpanElement>
onPlayCapture?: ReactEventHandler<HTMLSpanElement>
onPlaying?: ReactEventHandler<HTMLSpanElement>
onPlayingCapture?: ReactEventHandler<HTMLSpanElement>
onPointerCancel?: PointerEventHandler<HTMLSpanElement>
onPointerCancelCapture?: PointerEventHandler<HTMLSpanElement>
onPointerDown?: PointerEventHandler<HTMLSpanElement>
onPointerDownCapture?: PointerEventHandler<HTMLSpanElement>
onPointerEnter?: PointerEventHandler<HTMLSpanElement>
onPointerEnterCapture?: PointerEventHandler<HTMLSpanElement>
onPointerLeave?: PointerEventHandler<HTMLSpanElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLSpanElement>
onPointerMove?: PointerEventHandler<HTMLSpanElement>
onPointerMoveCapture?: PointerEventHandler<HTMLSpanElement>
onPointerOut?: PointerEventHandler<HTMLSpanElement>
onPointerOutCapture?: PointerEventHandler<HTMLSpanElement>
onPointerOver?: PointerEventHandler<HTMLSpanElement>
onPointerOverCapture?: PointerEventHandler<HTMLSpanElement>
onPointerUp?: PointerEventHandler<HTMLSpanElement>
onPointerUpCapture?: PointerEventHandler<HTMLSpanElement>
onProgress?: ReactEventHandler<HTMLSpanElement>
onProgressCapture?: ReactEventHandler<HTMLSpanElement>
onRateChange?: ReactEventHandler<HTMLSpanElement>
onRateChangeCapture?: ReactEventHandler<HTMLSpanElement>
onReset?: FormEventHandler<HTMLSpanElement>
onResetCapture?: FormEventHandler<HTMLSpanElement>
onScroll?: UIEventHandler<HTMLSpanElement>
onScrollCapture?: UIEventHandler<HTMLSpanElement>
onSeeked?: ReactEventHandler<HTMLSpanElement>
onSeekedCapture?: ReactEventHandler<HTMLSpanElement>
onSeeking?: ReactEventHandler<HTMLSpanElement>
onSeekingCapture?: ReactEventHandler<HTMLSpanElement>
onSelect?: ReactEventHandler<HTMLSpanElement>
onSelectCapture?: ReactEventHandler<HTMLSpanElement>
onStalled?: ReactEventHandler<HTMLSpanElement>
onStalledCapture?: ReactEventHandler<HTMLSpanElement>
onSubmit?: FormEventHandler<HTMLSpanElement>
onSubmitCapture?: FormEventHandler<HTMLSpanElement>
onSuspend?: ReactEventHandler<HTMLSpanElement>
onSuspendCapture?: ReactEventHandler<HTMLSpanElement>
onTimeUpdate?: ReactEventHandler<HTMLSpanElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLSpanElement>
onTouchCancel?: TouchEventHandler<HTMLSpanElement>
onTouchCancelCapture?: TouchEventHandler<HTMLSpanElement>
onTouchEnd?: TouchEventHandler<HTMLSpanElement>
onTouchEndCapture?: TouchEventHandler<HTMLSpanElement>
onTouchMove?: TouchEventHandler<HTMLSpanElement>
onTouchMoveCapture?: TouchEventHandler<HTMLSpanElement>
onTouchStart?: TouchEventHandler<HTMLSpanElement>
onTouchStartCapture?: TouchEventHandler<HTMLSpanElement>
onTransitionEnd?: TransitionEventHandler<HTMLSpanElement>
onTransitionEndCapture?: TransitionEventHandler<HTMLSpanElement>
onVolumeChange?: ReactEventHandler<HTMLSpanElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLSpanElement>
onWaiting?: ReactEventHandler<HTMLSpanElement>
onWaitingCapture?: ReactEventHandler<HTMLSpanElement>
onWheel?: WheelEventHandler<HTMLSpanElement>
onWheelCapture?: WheelEventHandler<HTMLSpanElement>
placeholder?: string
portal?: boolean

Boolean if the portal should be used.

portalInto?: PortalInto
portalIntoId?: string
position?: SimplePosition

This is the position that the tooltip should appear related to its container element as well as updating the animation direction.

prefix?: string
property?: string
radioGroup?: string
resource?: string
results?: number
role?: AriaRole
security?: string
slot?: string
spellCheck?: Booleanish
style?: CSSProperties

An optional style to apply to the tooltip.

suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
temporary?: boolean

{@inheritDoc CSSTransitionHookOptions.temporary}

timeout?: TransitionTimeout

The enter duration in milliseconds for the tooltip to fully animate into view. This should match whatever value is set for $rmd-tooltip-enter-duration. A manual timeout is used instead of onTransitionEnd to handle cancel animations easier.

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

Boolean if the tooltip is visible. This value changing will trigger the different animations.

vocab?: string

Generated using TypeDoc