Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BaseSheetProps

Hierarchy

  • AllowedDialogProps
    • BaseSheetProps

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

A label to apply to the dialog. Either this or the aria-labelledby prop are required for accessibility.

Optional aria-labelledby

aria-labelledby: string

An id pointing to an element that is a label for the dialog. Either this or the aria-label prop are required for accessibility.

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 color

color: string

Optional component

component: "div" | "nav"

The component to render the dialog as. This really shouldn't be used outside of the @react-md/layout and @react-md/sheet packages to conditionally render a navigation panel.

Optional containerClassName

containerClassName: string

An optional className to apply to the dialog container when the type is set to "centered" or when the forceContainer prop is enabled. You probably don't want to use this prop in most cases.

Optional containerStyle

containerStyle: CSSProperties

An optional style to apply to the dialog container when the type is set to "centered" or when the forceContainer prop is enabled. You probably don't want to use this prop in most cases.

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 defaultFocus

defaultFocus: string

Either the "first" or "last" string to focus the first or last focusable element within the container or a query selector string to find a focusable element within the container.

Optional defaultValue

defaultValue: string | number | readonly string[]

Optional dir

dir: string

Optional disableEscapeClose

disableEscapeClose: boolean

Boolean if the ability to close the dialog via the escape key should be disabled. You should really not be using this as it breaks accessibility in most cases.

Note: When the modal prop is enabled, this flag will be considered true as well so that the escape keypress no longer closes the dialog.

Optional disableFocusCache

disableFocusCache: boolean

By default, the focus container will try to maintain a cache of the focusable elements that is updated only when this component re-renders. If the children are extremely dynamic and focusable elements can be removed/added without this component updating, you should disable the cache so that the focusable elements are updated each time the tab key is pressed. Disabling the cache will be slightly slower for larger focusable areas, but it might not be too bad.

NOTE: The only important elements are the first and last elements in this list. So if your children aren't changing the first and last elements, there's no need to disable the cache.

Optional disableFocusContainer

disableFocusContainer: boolean

Boolean if the dialog's focus container logic should be disabled. This should normally be kept at the default of false unless implementing a custom dialog that does not require consistent user focus.

Optional disableFocusOnMount

disableFocusOnMount: boolean

The default behavior for the focus container is to focus an element once it is mounted and the disabled prop is not enabled. This behavior can be disabled if this is not wanted for some reason.

Optional disableFocusOnMountScroll

disableFocusOnMountScroll: boolean

Boolean if the element that gets focused on mount should try to not scroll the focused element into view which is the default behavior. This should normally remain false, but it is useful to set to true if the FocusContainer is within a transition that appears offscreen.

Optional disableFocusOnUnmount

disableFocusOnUnmount: boolean

The default behavior for the focus container is to attempt to focus the element that was focused before the focus container was mounted since it is generally used for temporary material. If there are cases where this behavior is not wanted, you can enable this prop.

Optional disableNestedDialogFixes

disableNestedDialogFixes: boolean

The Dialog component will attempt to automatically fix nested dialogs behind the scenes using the NestedDialogContextProvider component. This prop will disable that feature if it does not seem to be working as expected.

Optional disableScrollLock

disableScrollLock: boolean

Boolean if the dialog should no longer add scroll locking to the page when visible. You normally want this prop to stay false, but it is useful when using custom dialogs that are more for popovers and don't require full user attention.

Optional disableTabFocusWrap

disableTabFocusWrap: boolean

Boolean if the focus behavior should be disabled. This should really be used if you are using nested focus containers for temporary material (such as dialogs or menus).

Optional disableTransition

disableTransition: boolean

Boolean if the appear, enter, and exit transitions should be disabled for the dialog. This is just a shortcut so all three of those props don't need to be disabled.

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

Optional horizontalSize

horizontalSize: SheetHorizontalSize

The size to use for sheets that have been positioned left or right. The default supported values are:

  • none - the size is based on content, but is still limited to the viewport width so that the horizontal scrolling will not occur within the page. No limits added to sizing.
  • touch - the min-width is set to be the entire viewport width minus a touchable area and max-width is set to 20rem and is normally recommended for mobile devices.
  • static - the width is set to a static 16rem and generally used for landscape tablets and desktops.
  • media - automatically switches between "touch" and "static" based on css media queries. (this is the default)

id

id: string

An id required for a11y for the dialog.

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<HTMLDivElement>

Optional onAbortCapture

onAbortCapture: ReactEventHandler<HTMLDivElement>

Optional onAnimationEnd

onAnimationEnd: AnimationEventHandler<HTMLDivElement>

Optional onAnimationEndCapture

onAnimationEndCapture: AnimationEventHandler<HTMLDivElement>

Optional onAnimationIteration

onAnimationIteration: AnimationEventHandler<HTMLDivElement>

Optional onAnimationIterationCapture

onAnimationIterationCapture: AnimationEventHandler<HTMLDivElement>

Optional onAnimationStart

onAnimationStart: AnimationEventHandler<HTMLDivElement>

Optional onAnimationStartCapture

onAnimationStartCapture: AnimationEventHandler<HTMLDivElement>

Optional onAuxClick

onAuxClick: MouseEventHandler<HTMLDivElement>

Optional onAuxClickCapture

onAuxClickCapture: MouseEventHandler<HTMLDivElement>

Optional onBeforeInput

onBeforeInput: FormEventHandler<HTMLDivElement>

Optional onBeforeInputCapture

onBeforeInputCapture: FormEventHandler<HTMLDivElement>

Optional onBlur

onBlur: FocusEventHandler<HTMLDivElement>

Optional onBlurCapture

onBlurCapture: FocusEventHandler<HTMLDivElement>

Optional onCanPlay

onCanPlay: ReactEventHandler<HTMLDivElement>

Optional onCanPlayCapture

onCanPlayCapture: ReactEventHandler<HTMLDivElement>

Optional onCanPlayThrough

onCanPlayThrough: ReactEventHandler<HTMLDivElement>

Optional onCanPlayThroughCapture

onCanPlayThroughCapture: ReactEventHandler<HTMLDivElement>

Optional onChange

onChange: FormEventHandler<HTMLDivElement>

Optional onChangeCapture

onChangeCapture: FormEventHandler<HTMLDivElement>

Optional onClick

onClick: MouseEventHandler<HTMLDivElement>

Optional onClickCapture

onClickCapture: MouseEventHandler<HTMLDivElement>

Optional onCompositionEnd

onCompositionEnd: CompositionEventHandler<HTMLDivElement>

Optional onCompositionEndCapture

onCompositionEndCapture: CompositionEventHandler<HTMLDivElement>

Optional onCompositionStart

onCompositionStart: CompositionEventHandler<HTMLDivElement>

Optional onCompositionStartCapture

onCompositionStartCapture: CompositionEventHandler<HTMLDivElement>

Optional onCompositionUpdate

onCompositionUpdate: CompositionEventHandler<HTMLDivElement>

Optional onCompositionUpdateCapture

onCompositionUpdateCapture: CompositionEventHandler<HTMLDivElement>

Optional onContextMenu

onContextMenu: MouseEventHandler<HTMLDivElement>

Optional onContextMenuCapture

onContextMenuCapture: MouseEventHandler<HTMLDivElement>

Optional onCopy

onCopy: ClipboardEventHandler<HTMLDivElement>

Optional onCopyCapture

onCopyCapture: ClipboardEventHandler<HTMLDivElement>

Optional onCut

onCut: ClipboardEventHandler<HTMLDivElement>

Optional onCutCapture

onCutCapture: ClipboardEventHandler<HTMLDivElement>

Optional onDoubleClick

onDoubleClick: MouseEventHandler<HTMLDivElement>

Optional onDoubleClickCapture

onDoubleClickCapture: MouseEventHandler<HTMLDivElement>

Optional onDrag

onDrag: DragEventHandler<HTMLDivElement>

Optional onDragCapture

onDragCapture: DragEventHandler<HTMLDivElement>

Optional onDragEnd

onDragEnd: DragEventHandler<HTMLDivElement>

Optional onDragEndCapture

onDragEndCapture: DragEventHandler<HTMLDivElement>

Optional onDragEnter

onDragEnter: DragEventHandler<HTMLDivElement>

Optional onDragEnterCapture

onDragEnterCapture: DragEventHandler<HTMLDivElement>

Optional onDragExit

onDragExit: DragEventHandler<HTMLDivElement>

Optional onDragExitCapture

onDragExitCapture: DragEventHandler<HTMLDivElement>

Optional onDragLeave

onDragLeave: DragEventHandler<HTMLDivElement>

Optional onDragLeaveCapture

onDragLeaveCapture: DragEventHandler<HTMLDivElement>

Optional onDragOver

onDragOver: DragEventHandler<HTMLDivElement>

Optional onDragOverCapture

onDragOverCapture: DragEventHandler<HTMLDivElement>

Optional onDragStart

onDragStart: DragEventHandler<HTMLDivElement>

Optional onDragStartCapture

onDragStartCapture: DragEventHandler<HTMLDivElement>

Optional onDrop

onDrop: DragEventHandler<HTMLDivElement>

Optional onDropCapture

onDropCapture: DragEventHandler<HTMLDivElement>

Optional onDurationChange

onDurationChange: ReactEventHandler<HTMLDivElement>

Optional onDurationChangeCapture

onDurationChangeCapture: ReactEventHandler<HTMLDivElement>

Optional onEmptied

onEmptied: ReactEventHandler<HTMLDivElement>

Optional onEmptiedCapture

onEmptiedCapture: ReactEventHandler<HTMLDivElement>

Optional onEncrypted

onEncrypted: ReactEventHandler<HTMLDivElement>

Optional onEncryptedCapture

onEncryptedCapture: ReactEventHandler<HTMLDivElement>

Optional onEnded

onEnded: ReactEventHandler<HTMLDivElement>

Optional onEndedCapture

onEndedCapture: ReactEventHandler<HTMLDivElement>

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<HTMLDivElement>

Optional onErrorCapture

onErrorCapture: ReactEventHandler<HTMLDivElement>

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<HTMLDivElement>

Optional onFocusCapture

onFocusCapture: FocusEventHandler<HTMLDivElement>

Optional onGotPointerCapture

onGotPointerCapture: PointerEventHandler<HTMLDivElement>

Optional onGotPointerCaptureCapture

onGotPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

Optional onInput

onInput: FormEventHandler<HTMLDivElement>

Optional onInputCapture

onInputCapture: FormEventHandler<HTMLDivElement>

Optional onInvalid

onInvalid: FormEventHandler<HTMLDivElement>

Optional onInvalidCapture

onInvalidCapture: FormEventHandler<HTMLDivElement>

Optional onKeyDown

onKeyDown: KeyboardEventHandler<HTMLDivElement>

Optional onKeyDownCapture

onKeyDownCapture: KeyboardEventHandler<HTMLDivElement>

Optional onKeyPress

onKeyPress: KeyboardEventHandler<HTMLDivElement>

Optional onKeyPressCapture

onKeyPressCapture: KeyboardEventHandler<HTMLDivElement>

Optional onKeyUp

onKeyUp: KeyboardEventHandler<HTMLDivElement>

Optional onKeyUpCapture

onKeyUpCapture: KeyboardEventHandler<HTMLDivElement>

Optional onLoad

onLoad: ReactEventHandler<HTMLDivElement>

Optional onLoadCapture

onLoadCapture: ReactEventHandler<HTMLDivElement>

Optional onLoadStart

onLoadStart: ReactEventHandler<HTMLDivElement>

Optional onLoadStartCapture

onLoadStartCapture: ReactEventHandler<HTMLDivElement>

Optional onLoadedData

onLoadedData: ReactEventHandler<HTMLDivElement>

Optional onLoadedDataCapture

onLoadedDataCapture: ReactEventHandler<HTMLDivElement>

Optional onLoadedMetadata

onLoadedMetadata: ReactEventHandler<HTMLDivElement>

Optional onLoadedMetadataCapture

onLoadedMetadataCapture: ReactEventHandler<HTMLDivElement>

Optional onLostPointerCapture

onLostPointerCapture: PointerEventHandler<HTMLDivElement>

Optional onLostPointerCaptureCapture

onLostPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

Optional onMouseDown

onMouseDown: MouseEventHandler<HTMLDivElement>

Optional onMouseDownCapture

onMouseDownCapture: MouseEventHandler<HTMLDivElement>

Optional onMouseEnter

onMouseEnter: MouseEventHandler<HTMLDivElement>

Optional onMouseLeave

onMouseLeave: MouseEventHandler<HTMLDivElement>

Optional onMouseMove

onMouseMove: MouseEventHandler<HTMLDivElement>

Optional onMouseMoveCapture

onMouseMoveCapture: MouseEventHandler<HTMLDivElement>

Optional onMouseOut

onMouseOut: MouseEventHandler<HTMLDivElement>

Optional onMouseOutCapture

onMouseOutCapture: MouseEventHandler<HTMLDivElement>

Optional onMouseOver

onMouseOver: MouseEventHandler<HTMLDivElement>

Optional onMouseOverCapture

onMouseOverCapture: MouseEventHandler<HTMLDivElement>

Optional onMouseUp

onMouseUp: MouseEventHandler<HTMLDivElement>

Optional onMouseUpCapture

onMouseUpCapture: MouseEventHandler<HTMLDivElement>

Optional onPaste

onPaste: ClipboardEventHandler<HTMLDivElement>

Optional onPasteCapture

onPasteCapture: ClipboardEventHandler<HTMLDivElement>

Optional onPause

onPause: ReactEventHandler<HTMLDivElement>

Optional onPauseCapture

onPauseCapture: ReactEventHandler<HTMLDivElement>

Optional onPlay

onPlay: ReactEventHandler<HTMLDivElement>

Optional onPlayCapture

onPlayCapture: ReactEventHandler<HTMLDivElement>

Optional onPlaying

onPlaying: ReactEventHandler<HTMLDivElement>

Optional onPlayingCapture

onPlayingCapture: ReactEventHandler<HTMLDivElement>

Optional onPointerCancel

onPointerCancel: PointerEventHandler<HTMLDivElement>

Optional onPointerCancelCapture

onPointerCancelCapture: PointerEventHandler<HTMLDivElement>

Optional onPointerDown

onPointerDown: PointerEventHandler<HTMLDivElement>

Optional onPointerDownCapture

onPointerDownCapture: PointerEventHandler<HTMLDivElement>

Optional onPointerEnter

onPointerEnter: PointerEventHandler<HTMLDivElement>

Optional onPointerEnterCapture

onPointerEnterCapture: PointerEventHandler<HTMLDivElement>

Optional onPointerLeave

onPointerLeave: PointerEventHandler<HTMLDivElement>

Optional onPointerLeaveCapture

onPointerLeaveCapture: PointerEventHandler<HTMLDivElement>

Optional onPointerMove

onPointerMove: PointerEventHandler<HTMLDivElement>

Optional onPointerMoveCapture

onPointerMoveCapture: PointerEventHandler<HTMLDivElement>

Optional onPointerOut

onPointerOut: PointerEventHandler<HTMLDivElement>

Optional onPointerOutCapture

onPointerOutCapture: PointerEventHandler<HTMLDivElement>

Optional onPointerOver

onPointerOver: PointerEventHandler<HTMLDivElement>

Optional onPointerOverCapture

onPointerOverCapture: PointerEventHandler<HTMLDivElement>

Optional onPointerUp

onPointerUp: PointerEventHandler<HTMLDivElement>

Optional onPointerUpCapture

onPointerUpCapture: PointerEventHandler<HTMLDivElement>

Optional onProgress

onProgress: ReactEventHandler<HTMLDivElement>

Optional onProgressCapture

onProgressCapture: ReactEventHandler<HTMLDivElement>

Optional onRateChange

onRateChange: ReactEventHandler<HTMLDivElement>

Optional onRateChangeCapture

onRateChangeCapture: ReactEventHandler<HTMLDivElement>

Optional onReset

onReset: FormEventHandler<HTMLDivElement>

Optional onResetCapture

onResetCapture: FormEventHandler<HTMLDivElement>

Optional onScroll

onScroll: UIEventHandler<HTMLDivElement>

Optional onScrollCapture

onScrollCapture: UIEventHandler<HTMLDivElement>

Optional onSeeked

onSeeked: ReactEventHandler<HTMLDivElement>

Optional onSeekedCapture

onSeekedCapture: ReactEventHandler<HTMLDivElement>

Optional onSeeking

onSeeking: ReactEventHandler<HTMLDivElement>

Optional onSeekingCapture

onSeekingCapture: ReactEventHandler<HTMLDivElement>

Optional onSelect

onSelect: ReactEventHandler<HTMLDivElement>

Optional onSelectCapture

onSelectCapture: ReactEventHandler<HTMLDivElement>

Optional onStalled

onStalled: ReactEventHandler<HTMLDivElement>

Optional onStalledCapture

onStalledCapture: ReactEventHandler<HTMLDivElement>

Optional onSubmit

onSubmit: FormEventHandler<HTMLDivElement>

Optional onSubmitCapture

onSubmitCapture: FormEventHandler<HTMLDivElement>

Optional onSuspend

onSuspend: ReactEventHandler<HTMLDivElement>

Optional onSuspendCapture

onSuspendCapture: ReactEventHandler<HTMLDivElement>

Optional onTimeUpdate

onTimeUpdate: ReactEventHandler<HTMLDivElement>

Optional onTimeUpdateCapture

onTimeUpdateCapture: ReactEventHandler<HTMLDivElement>

Optional onTouchCancel

onTouchCancel: TouchEventHandler<HTMLDivElement>

Optional onTouchCancelCapture

onTouchCancelCapture: TouchEventHandler<HTMLDivElement>

Optional onTouchEnd

onTouchEnd: TouchEventHandler<HTMLDivElement>

Optional onTouchEndCapture

onTouchEndCapture: TouchEventHandler<HTMLDivElement>

Optional onTouchMove

onTouchMove: TouchEventHandler<HTMLDivElement>

Optional onTouchMoveCapture

onTouchMoveCapture: TouchEventHandler<HTMLDivElement>

Optional onTouchStart

onTouchStart: TouchEventHandler<HTMLDivElement>

Optional onTouchStartCapture

onTouchStartCapture: TouchEventHandler<HTMLDivElement>

Optional onTransitionEnd

onTransitionEnd: TransitionEventHandler<HTMLDivElement>

Optional onTransitionEndCapture

onTransitionEndCapture: TransitionEventHandler<HTMLDivElement>

Optional onVolumeChange

onVolumeChange: ReactEventHandler<HTMLDivElement>

Optional onVolumeChangeCapture

onVolumeChangeCapture: ReactEventHandler<HTMLDivElement>

Optional onWaiting

onWaiting: ReactEventHandler<HTMLDivElement>

Optional onWaitingCapture

onWaitingCapture: ReactEventHandler<HTMLDivElement>

Optional onWheel

onWheel: WheelEventHandler<HTMLDivElement>

Optional onWheelCapture

onWheelCapture: WheelEventHandler<HTMLDivElement>

Optional overlay

overlay: boolean

Boolean if there should be an overlay displayed with the sheet. This is recommended/required on mobile devices.

Optional overlayClassName

overlayClassName: string

An optional className to apply to the overlay.

Optional overlayHidden

overlayHidden: boolean

Boolean if the overlay should be "hidden" from the user once it's visible be keeping the opacity set to 0. This is really only used for custom dialogs like the FixedDialog.

Optional overlayStyle

overlayStyle: CSSProperties

An optional style to apply to the overlay.

Optional placeholder

placeholder: string

Optional portal

portal: boolean

Boolean if the portal should be used.

Optional portalInto

portalInto: PortalInto

Optional portalIntoId

portalIntoId: string

Optional position

position: SheetPosition

The location that the sheet should be located within the viewport.

Optional prefix

prefix: string

Optional property

property: string

Optional radioGroup

radioGroup: string

Optional resource

resource: string

Optional results

results: number

Optional role

role: "dialog" | "menu" | "none"

The role that the sheet should be rendered as. You'll normally want to keep this as the default of "dialog" unless you are implementing a mobile sheet menu.

Note: Setting this to "menu" will not provide the menu keyboard accessibility automatically.

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

The tab index for the sheet. This should normally stay at -1.

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 unmountFocusFallback

unmountFocusFallback: FocusFallback

When the focus container unmounts, it will attempt to re-focus the element that was focused before the focus container was mounted unless the disableFocusOnUnmount prop is enabled. There might be cases where unmounting the focus container causes the page to re-render and the previous element no longer exists. When this happens keyboard users might have a problem navigating through the page again depending on how the browser implemented the native tab behavior so this prop allows you to ensure that a specific element is focused in these cases.

This can either be a query selector string, a specific HTMLElement, or a function that finds a specific HTMLElement to focus.

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"

Optional verticalSize

verticalSize: SheetVerticalSize

The size to use for sheets that have been positioned top or bottom. The supported sizes are:

  • none - the size is based on content and is limited to the viewport height.
  • touch - the size is based on content and is limited to the viewport height with a touchable area to close the sheet.
  • recommended - the material design recommended sizing that forces a max-height of 50vh and min-height of 3.5rem

visible

visible: boolean

Boolean if the dialog is currently visible.

Optional vocab

vocab: string

Methods

onRequestClose

  • onRequestClose(): void
  • A function used to close the dialog when the overlay is clicked or the escape key is pressed when the modal prop is not enabled.

    Returns void

Generated using TypeDoc