Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OverlayProps

Hierarchy

  • OverridableCSSTransitionProps
  • RenderConditionalPortalProps
  • HTMLAttributes<HTMLSpanElement>
    • OverlayProps

Index

Properties

Methods

Properties

Optional about

about: string

Optional accessKey

accessKey: string

Optional appear

appear: boolean

Normally a component is not transitioned if it is shown when the <Transition> component mounts. If you want to transition on the first mount set appear to true, and the component will transition in as soon as the <Transition> mounts. Note: there are no specific "appear" states. appear only adds an additional enter transition.

Optional aria-activedescendant

aria-activedescendant: string

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

Optional aria-atomic

aria-atomic: boolean | "true" | "false"

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.

Optional aria-autocomplete

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.

Optional aria-busy

aria-busy: boolean | "true" | "false"

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.

Optional aria-checked

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

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

see

aria-pressed @see aria-selected.

Optional aria-colcount

aria-colcount: number

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

see

aria-colindex.

Optional 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.

Optional 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.

Optional aria-controls

aria-controls: string

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

see

aria-owns.

Optional aria-current

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.

Optional aria-describedby

aria-describedby: string

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

see

aria-labelledby

Optional aria-details

aria-details: string

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

see

aria-describedby.

Optional aria-disabled

aria-disabled: boolean | "true" | "false"

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

see

aria-hidden @see aria-readonly.

Optional aria-dropeffect

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

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: boolean | "true" | "false"

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: boolean | "true" | "false"

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

deprecated

in ARIA 1.1

Optional aria-haspopup

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.

Optional aria-hidden

aria-hidden: boolean | "true" | "false"

Indicates whether the element is exposed to an accessibility API.

see

aria-disabled.

Optional aria-invalid

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

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: boolean | "true" | "false"

Indicates whether an element is modal when displayed.

Optional aria-multiline

aria-multiline: boolean | "true" | "false"

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

Optional aria-multiselectable

aria-multiselectable: boolean | "true" | "false"

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.

see

aria-setsize.

Optional aria-pressed

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

Indicates the current "pressed" state of toggle buttons.

see

aria-checked @see aria-selected.

Optional aria-readonly

aria-readonly: boolean | "true" | "false"

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

see

aria-disabled.

Optional aria-relevant

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.

see

aria-atomic.

Optional aria-required

aria-required: boolean | "true" | "false"

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

Optional aria-roledescription

aria-roledescription: string

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

Optional aria-rowcount

aria-rowcount: number

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

see

aria-rowindex.

Optional 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.

Optional 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.

Optional aria-selected

aria-selected: boolean | "true" | "false"

Indicates the current "selected" state of various widgets.

see

aria-checked @see aria-pressed.

Optional aria-setsize

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.

Optional aria-sort

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

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

Optional children

children: ReactNode

Optional className

className: string

Optional classNames

classNames: string | CSSTransitionClassNames

The animation classNames applied to the component as it enters or exits. A single name can be provided and it will be suffixed for each stage: e.g.

classNames="fade" applies fade-enter, fade-enter-active, fade-exit, fade-exit-active, fade-appear, and fade-appear-active.

Each individual classNames can also be specified independently like:

classNames={{
  appear: 'my-appear',
  appearActive: 'my-appear-active',
  appearDone: 'my-appear-done',
  enter: 'my-enter',
  enterActive: 'my-enter-active',
  enterDone: 'my-enter-done',
  exit: 'my-exit',
  exitActive: 'my-exit-active',
  exitDone: 'my-exit-done'
}}

Optional clickable

clickable: boolean

Boolean if the overlay should gain the pointer cursor while it's visible. You normally want this enabled by default except when used as a modal's overlay.

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 draggable

draggable: Booleanish

Optional enter

enter: boolean

Enable or disable enter transitions.

Optional exit

exit: boolean

Enable or disable exit transitions.

Optional hidden

hidden: boolean

Boolean if the overlay should still be "hidden" from the user while visible. This will just make it so the opacity stays at 0. This is really just helpful if you'd like to create a simple close on outside click feature since you can hook into the onRequestClose prop since the overlay will be clicked.

Optional id

id: string

Optional in

in: boolean

Show the component; triggers the enter or exit states

Optional inlist

inlist: any

Optional inputMode

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

see

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

Optional is

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

Optional itemID

itemID: string

Optional itemProp

itemProp: string

Optional itemRef

itemRef: string

Optional itemScope

itemScope: boolean

Optional itemType

itemType: string

Optional lang

lang: string

Optional mountOnEnter

mountOnEnter: boolean

By default the child component is mounted immediately along with the parent Transition component. If you want to "lazy mount" the component on the first in={true} you can set mountOnEnter. After the first enter transition the component will stay mounted, even on "exited", unless you also specify unmountOnExit.

Optional onAbort

onAbort: ReactEventHandler<HTMLSpanElement>

Optional onAbortCapture

onAbortCapture: ReactEventHandler<HTMLSpanElement>

Optional onAnimationEnd

onAnimationEnd: AnimationEventHandler<HTMLSpanElement>

Optional onAnimationEndCapture

onAnimationEndCapture: AnimationEventHandler<HTMLSpanElement>

Optional onAnimationIteration

onAnimationIteration: AnimationEventHandler<HTMLSpanElement>

Optional onAnimationIterationCapture

onAnimationIterationCapture: AnimationEventHandler<HTMLSpanElement>

Optional onAnimationStart

onAnimationStart: AnimationEventHandler<HTMLSpanElement>

Optional onAnimationStartCapture

onAnimationStartCapture: AnimationEventHandler<HTMLSpanElement>

Optional onAuxClick

onAuxClick: MouseEventHandler<HTMLSpanElement>

Optional onAuxClickCapture

onAuxClickCapture: MouseEventHandler<HTMLSpanElement>

Optional onBeforeInput

onBeforeInput: FormEventHandler<HTMLSpanElement>

Optional onBeforeInputCapture

onBeforeInputCapture: FormEventHandler<HTMLSpanElement>

Optional onBlur

onBlur: FocusEventHandler<HTMLSpanElement>

Optional onBlurCapture

onBlurCapture: FocusEventHandler<HTMLSpanElement>

Optional onCanPlay

onCanPlay: ReactEventHandler<HTMLSpanElement>

Optional onCanPlayCapture

onCanPlayCapture: ReactEventHandler<HTMLSpanElement>

Optional onCanPlayThrough

onCanPlayThrough: ReactEventHandler<HTMLSpanElement>

Optional onCanPlayThroughCapture

onCanPlayThroughCapture: ReactEventHandler<HTMLSpanElement>

Optional onChange

onChange: FormEventHandler<HTMLSpanElement>

Optional onChangeCapture

onChangeCapture: FormEventHandler<HTMLSpanElement>

Optional onClick

onClick: MouseEventHandler<HTMLSpanElement>

Optional onClickCapture

onClickCapture: MouseEventHandler<HTMLSpanElement>

Optional onCompositionEnd

onCompositionEnd: CompositionEventHandler<HTMLSpanElement>

Optional onCompositionEndCapture

onCompositionEndCapture: CompositionEventHandler<HTMLSpanElement>

Optional onCompositionStart

onCompositionStart: CompositionEventHandler<HTMLSpanElement>

Optional onCompositionStartCapture

onCompositionStartCapture: CompositionEventHandler<HTMLSpanElement>

Optional onCompositionUpdate

onCompositionUpdate: CompositionEventHandler<HTMLSpanElement>

Optional onCompositionUpdateCapture

onCompositionUpdateCapture: CompositionEventHandler<HTMLSpanElement>

Optional onContextMenu

onContextMenu: MouseEventHandler<HTMLSpanElement>

Optional onContextMenuCapture

onContextMenuCapture: MouseEventHandler<HTMLSpanElement>

Optional onCopy

onCopy: ClipboardEventHandler<HTMLSpanElement>

Optional onCopyCapture

onCopyCapture: ClipboardEventHandler<HTMLSpanElement>

Optional onCut

onCut: ClipboardEventHandler<HTMLSpanElement>

Optional onCutCapture

onCutCapture: ClipboardEventHandler<HTMLSpanElement>

Optional onDoubleClick

onDoubleClick: MouseEventHandler<HTMLSpanElement>

Optional onDoubleClickCapture

onDoubleClickCapture: MouseEventHandler<HTMLSpanElement>

Optional onDrag

onDrag: DragEventHandler<HTMLSpanElement>

Optional onDragCapture

onDragCapture: DragEventHandler<HTMLSpanElement>

Optional onDragEnd

onDragEnd: DragEventHandler<HTMLSpanElement>

Optional onDragEndCapture

onDragEndCapture: DragEventHandler<HTMLSpanElement>

Optional onDragEnter

onDragEnter: DragEventHandler<HTMLSpanElement>

Optional onDragEnterCapture

onDragEnterCapture: DragEventHandler<HTMLSpanElement>

Optional onDragExit

onDragExit: DragEventHandler<HTMLSpanElement>

Optional onDragExitCapture

onDragExitCapture: DragEventHandler<HTMLSpanElement>

Optional onDragLeave

onDragLeave: DragEventHandler<HTMLSpanElement>

Optional onDragLeaveCapture

onDragLeaveCapture: DragEventHandler<HTMLSpanElement>

Optional onDragOver

onDragOver: DragEventHandler<HTMLSpanElement>

Optional onDragOverCapture

onDragOverCapture: DragEventHandler<HTMLSpanElement>

Optional onDragStart

onDragStart: DragEventHandler<HTMLSpanElement>

Optional onDragStartCapture

onDragStartCapture: DragEventHandler<HTMLSpanElement>

Optional onDrop

onDrop: DragEventHandler<HTMLSpanElement>

Optional onDropCapture

onDropCapture: DragEventHandler<HTMLSpanElement>

Optional onDurationChange

onDurationChange: ReactEventHandler<HTMLSpanElement>

Optional onDurationChangeCapture

onDurationChangeCapture: ReactEventHandler<HTMLSpanElement>

Optional onEmptied

onEmptied: ReactEventHandler<HTMLSpanElement>

Optional onEmptiedCapture

onEmptiedCapture: ReactEventHandler<HTMLSpanElement>

Optional onEncrypted

onEncrypted: ReactEventHandler<HTMLSpanElement>

Optional onEncryptedCapture

onEncryptedCapture: ReactEventHandler<HTMLSpanElement>

Optional onEnded

onEnded: ReactEventHandler<HTMLSpanElement>

Optional onEndedCapture

onEndedCapture: ReactEventHandler<HTMLSpanElement>

Optional onEnter

onEnter: (node: HTMLElement, isAppearing: boolean) => void

Type declaration

    • (node: HTMLElement, isAppearing: boolean): void

    • Callback fired before the "entering" status is applied. An extra parameter isAppearing is supplied to indicate if the enter stage is occurring on the initial mount

      Parameters

      • node: HTMLElement
      • isAppearing: boolean

      Returns void

Optional onEntered

onEntered: (node: HTMLElement, isAppearing: boolean) => void

Type declaration

    • (node: HTMLElement, isAppearing: boolean): void

    • Callback fired after the "entered" status is applied. An extra parameter isAppearing is supplied to indicate if the enter stage is occurring on the initial mount

      Parameters

      • node: HTMLElement
      • isAppearing: boolean

      Returns void

Optional onEntering

onEntering: (node: HTMLElement, isAppearing: boolean) => void

Type declaration

    • (node: HTMLElement, isAppearing: boolean): void

    • Callback fired after the "entering" status is applied. An extra parameter isAppearing is supplied to indicate if the enter stage is occurring on the initial mount

      Parameters

      • node: HTMLElement
      • isAppearing: boolean

      Returns void

Optional onError

onError: ReactEventHandler<HTMLSpanElement>

Optional onErrorCapture

onErrorCapture: ReactEventHandler<HTMLSpanElement>

Optional onExit

onExit: (node: HTMLElement) => void

Type declaration

    • (node: HTMLElement): void

    • Callback fired before the "exiting" status is applied.

      Parameters

      • node: HTMLElement

      Returns void

Optional onExited

onExited: (node: HTMLElement) => void

Type declaration

    • (node: HTMLElement): void

    • Callback fired after the "exited" status is applied.

      Parameters

      • node: HTMLElement

      Returns void

Optional onExiting

onExiting: (node: HTMLElement) => void

Type declaration

    • (node: HTMLElement): void

    • Callback fired after the "exiting" status is applied.

      Parameters

      • node: HTMLElement

      Returns void

Optional onFocus

onFocus: FocusEventHandler<HTMLSpanElement>

Optional onFocusCapture

onFocusCapture: FocusEventHandler<HTMLSpanElement>

Optional onGotPointerCapture

onGotPointerCapture: PointerEventHandler<HTMLSpanElement>

Optional onGotPointerCaptureCapture

onGotPointerCaptureCapture: PointerEventHandler<HTMLSpanElement>

Optional onInput

onInput: FormEventHandler<HTMLSpanElement>

Optional onInputCapture

onInputCapture: FormEventHandler<HTMLSpanElement>

Optional onInvalid

onInvalid: FormEventHandler<HTMLSpanElement>

Optional onInvalidCapture

onInvalidCapture: FormEventHandler<HTMLSpanElement>

Optional onKeyDown

onKeyDown: KeyboardEventHandler<HTMLSpanElement>

Optional onKeyDownCapture

onKeyDownCapture: KeyboardEventHandler<HTMLSpanElement>

Optional onKeyPress

onKeyPress: KeyboardEventHandler<HTMLSpanElement>

Optional onKeyPressCapture

onKeyPressCapture: KeyboardEventHandler<HTMLSpanElement>

Optional onKeyUp

onKeyUp: KeyboardEventHandler<HTMLSpanElement>

Optional onKeyUpCapture

onKeyUpCapture: KeyboardEventHandler<HTMLSpanElement>

Optional onLoad

onLoad: ReactEventHandler<HTMLSpanElement>

Optional onLoadCapture

onLoadCapture: ReactEventHandler<HTMLSpanElement>

Optional onLoadStart

onLoadStart: ReactEventHandler<HTMLSpanElement>

Optional onLoadStartCapture

onLoadStartCapture: ReactEventHandler<HTMLSpanElement>

Optional onLoadedData

onLoadedData: ReactEventHandler<HTMLSpanElement>

Optional onLoadedDataCapture

onLoadedDataCapture: ReactEventHandler<HTMLSpanElement>

Optional onLoadedMetadata

onLoadedMetadata: ReactEventHandler<HTMLSpanElement>

Optional onLoadedMetadataCapture

onLoadedMetadataCapture: ReactEventHandler<HTMLSpanElement>

Optional onLostPointerCapture

onLostPointerCapture: PointerEventHandler<HTMLSpanElement>

Optional onLostPointerCaptureCapture

onLostPointerCaptureCapture: PointerEventHandler<HTMLSpanElement>

Optional onMouseDown

onMouseDown: MouseEventHandler<HTMLSpanElement>

Optional onMouseDownCapture

onMouseDownCapture: MouseEventHandler<HTMLSpanElement>

Optional onMouseEnter

onMouseEnter: MouseEventHandler<HTMLSpanElement>

Optional onMouseLeave

onMouseLeave: MouseEventHandler<HTMLSpanElement>

Optional onMouseMove

onMouseMove: MouseEventHandler<HTMLSpanElement>

Optional onMouseMoveCapture

onMouseMoveCapture: MouseEventHandler<HTMLSpanElement>

Optional onMouseOut

onMouseOut: MouseEventHandler<HTMLSpanElement>

Optional onMouseOutCapture

onMouseOutCapture: MouseEventHandler<HTMLSpanElement>

Optional onMouseOver

onMouseOver: MouseEventHandler<HTMLSpanElement>

Optional onMouseOverCapture

onMouseOverCapture: MouseEventHandler<HTMLSpanElement>

Optional onMouseUp

onMouseUp: MouseEventHandler<HTMLSpanElement>

Optional onMouseUpCapture

onMouseUpCapture: MouseEventHandler<HTMLSpanElement>

Optional onPaste

onPaste: ClipboardEventHandler<HTMLSpanElement>

Optional onPasteCapture

onPasteCapture: ClipboardEventHandler<HTMLSpanElement>

Optional onPause

onPause: ReactEventHandler<HTMLSpanElement>

Optional onPauseCapture

onPauseCapture: ReactEventHandler<HTMLSpanElement>

Optional onPlay

onPlay: ReactEventHandler<HTMLSpanElement>

Optional onPlayCapture

onPlayCapture: ReactEventHandler<HTMLSpanElement>

Optional onPlaying

onPlaying: ReactEventHandler<HTMLSpanElement>

Optional onPlayingCapture

onPlayingCapture: ReactEventHandler<HTMLSpanElement>

Optional onPointerCancel

onPointerCancel: PointerEventHandler<HTMLSpanElement>

Optional onPointerCancelCapture

onPointerCancelCapture: PointerEventHandler<HTMLSpanElement>

Optional onPointerDown

onPointerDown: PointerEventHandler<HTMLSpanElement>

Optional onPointerDownCapture

onPointerDownCapture: PointerEventHandler<HTMLSpanElement>

Optional onPointerEnter

onPointerEnter: PointerEventHandler<HTMLSpanElement>

Optional onPointerEnterCapture

onPointerEnterCapture: PointerEventHandler<HTMLSpanElement>

Optional onPointerLeave

onPointerLeave: PointerEventHandler<HTMLSpanElement>

Optional onPointerLeaveCapture

onPointerLeaveCapture: PointerEventHandler<HTMLSpanElement>

Optional onPointerMove

onPointerMove: PointerEventHandler<HTMLSpanElement>

Optional onPointerMoveCapture

onPointerMoveCapture: PointerEventHandler<HTMLSpanElement>

Optional onPointerOut

onPointerOut: PointerEventHandler<HTMLSpanElement>

Optional onPointerOutCapture

onPointerOutCapture: PointerEventHandler<HTMLSpanElement>

Optional onPointerOver

onPointerOver: PointerEventHandler<HTMLSpanElement>

Optional onPointerOverCapture

onPointerOverCapture: PointerEventHandler<HTMLSpanElement>

Optional onPointerUp

onPointerUp: PointerEventHandler<HTMLSpanElement>

Optional onPointerUpCapture

onPointerUpCapture: PointerEventHandler<HTMLSpanElement>

Optional onProgress

onProgress: ReactEventHandler<HTMLSpanElement>

Optional onProgressCapture

onProgressCapture: ReactEventHandler<HTMLSpanElement>

Optional onRateChange

onRateChange: ReactEventHandler<HTMLSpanElement>

Optional onRateChangeCapture

onRateChangeCapture: ReactEventHandler<HTMLSpanElement>

Optional onReset

onReset: FormEventHandler<HTMLSpanElement>

Optional onResetCapture

onResetCapture: FormEventHandler<HTMLSpanElement>

Optional onScroll

onScroll: UIEventHandler<HTMLSpanElement>

Optional onScrollCapture

onScrollCapture: UIEventHandler<HTMLSpanElement>

Optional onSeeked

onSeeked: ReactEventHandler<HTMLSpanElement>

Optional onSeekedCapture

onSeekedCapture: ReactEventHandler<HTMLSpanElement>

Optional onSeeking

onSeeking: ReactEventHandler<HTMLSpanElement>

Optional onSeekingCapture

onSeekingCapture: ReactEventHandler<HTMLSpanElement>

Optional onSelect

onSelect: ReactEventHandler<HTMLSpanElement>

Optional onSelectCapture

onSelectCapture: ReactEventHandler<HTMLSpanElement>

Optional onStalled

onStalled: ReactEventHandler<HTMLSpanElement>

Optional onStalledCapture

onStalledCapture: ReactEventHandler<HTMLSpanElement>

Optional onSubmit

onSubmit: FormEventHandler<HTMLSpanElement>

Optional onSubmitCapture

onSubmitCapture: FormEventHandler<HTMLSpanElement>

Optional onSuspend

onSuspend: ReactEventHandler<HTMLSpanElement>

Optional onSuspendCapture

onSuspendCapture: ReactEventHandler<HTMLSpanElement>

Optional onTimeUpdate

onTimeUpdate: ReactEventHandler<HTMLSpanElement>

Optional onTimeUpdateCapture

onTimeUpdateCapture: ReactEventHandler<HTMLSpanElement>

Optional onTouchCancel

onTouchCancel: TouchEventHandler<HTMLSpanElement>

Optional onTouchCancelCapture

onTouchCancelCapture: TouchEventHandler<HTMLSpanElement>

Optional onTouchEnd

onTouchEnd: TouchEventHandler<HTMLSpanElement>

Optional onTouchEndCapture

onTouchEndCapture: TouchEventHandler<HTMLSpanElement>

Optional onTouchMove

onTouchMove: TouchEventHandler<HTMLSpanElement>

Optional onTouchMoveCapture

onTouchMoveCapture: TouchEventHandler<HTMLSpanElement>

Optional onTouchStart

onTouchStart: TouchEventHandler<HTMLSpanElement>

Optional onTouchStartCapture

onTouchStartCapture: TouchEventHandler<HTMLSpanElement>

Optional onTransitionEnd

onTransitionEnd: TransitionEventHandler<HTMLSpanElement>

Optional onTransitionEndCapture

onTransitionEndCapture: TransitionEventHandler<HTMLSpanElement>

Optional onVolumeChange

onVolumeChange: ReactEventHandler<HTMLSpanElement>

Optional onVolumeChangeCapture

onVolumeChangeCapture: ReactEventHandler<HTMLSpanElement>

Optional onWaiting

onWaiting: ReactEventHandler<HTMLSpanElement>

Optional onWaitingCapture

onWaitingCapture: ReactEventHandler<HTMLSpanElement>

Optional onWheel

onWheel: WheelEventHandler<HTMLSpanElement>

Optional onWheelCapture

onWheelCapture: WheelEventHandler<HTMLSpanElement>

Optional placeholder

placeholder: string

Optional portal

portal: boolean

Boolean if the portal should be used.

Optional portalInto

portalInto: PortalInto
see

PortalProps.into

Optional portalIntoId

portalIntoId: string
see

PortalProps.intoId

Optional prefix

prefix: string

Optional property

property: string

Optional radioGroup

radioGroup: string

Optional resource

resource: string

Optional results

results: number

Optional role

role: AriaRole

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 timeout

timeout: number | { appear?: number; enter?: number; exit?: number } | { appear?: number; enter?: number; exit?: number }

Optional title

title: string

Optional translate

translate: "yes" | "no"

Optional typeof

typeof: string

Optional unmountOnExit

unmountOnExit: boolean

By default the child component stays mounted after it reaches the 'exited' state. Set unmountOnExit if you'd prefer to unmount the component after it finishes exiting.

Optional unselectable

unselectable: "on" | "off"

visible

visible: boolean

Boolean if the overlay is currently visible. When this prop changes, the overlay will enter/exit with an opacity transition.

Optional vocab

vocab: string

Methods

onRequestClose

  • onRequestClose(): void

  • A function that should change the visible prop to false. This is used so that clicking the overlay can hide the overlay.

    Returns void

Generated using TypeDoc