SwipeableDrawerProps

Properties

Link copied to clipboard
abstract var about: String?
Link copied to clipboard
abstract var accessKey: String?
Link copied to clipboard

If set to true, the swipe event will open the drawer even if the user begins the swipe on one of the drawer's children. This can be useful in scenarios where the drawer is partially visible. You can customize it further with a callback that determines which children the user can drag over to open the drawer (for example, to ignore other elements that handle touch move events, like sliders).

Link copied to clipboard
abstract var anchor: DrawerAnchor?

Side from which the drawer will appear.

Link copied to clipboard
abstract var autoCapitalize: String?
Link copied to clipboard
abstract var autoCorrect: String?
Link copied to clipboard
abstract var autoFocus: Boolean?
Link copied to clipboard
abstract var autoSave: String?
Link copied to clipboard

A backdrop component. This prop enables custom backdrop rendering.

Link copied to clipboard

Props applied to the /material-ui/api/backdrop/ element.

Link copied to clipboard
abstract override var children: ReactNode?

The content of the component.

Link copied to clipboard
abstract override var classes: DrawerClasses?

Override or extend the styles applied to the component.

Link copied to clipboard
abstract var className: ClassName?
Link copied to clipboard

When set to true the Modal waits until a nested Transition is completed before closing.

Link copied to clipboard
abstract var component: ElementType<*>?
Link copied to clipboard

The components used for each slot inside.

Link copied to clipboard

The extra props for the slot components. You can override the existing props or add new ones.

Link copied to clipboard
abstract var container: Element?

An HTML element or function that returns one. The container will have the portal children appended to it.

Link copied to clipboard
abstract var content: String?
Link copied to clipboard
abstract var contentEditable: Any?
Link copied to clipboard
abstract var contextMenu: String?
Link copied to clipboard
abstract var datatype: String?
Link copied to clipboard
abstract var defaultChecked: Boolean?
Link copied to clipboard
abstract var defaultValue: Any?
Link copied to clipboard
abstract var dir: String?
Link copied to clipboard
abstract var disableAutoFocus: Boolean?

If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.

Link copied to clipboard

Disable the backdrop transition. This can improve the FPS on low-end devices.

Link copied to clipboard
abstract var disableDiscovery: Boolean?

If true, touching the screen near the edge of the drawer will not slide in the drawer a bit to promote accidental discovery of the swipe gesture.

Link copied to clipboard

If true, the modal will not prevent focus from leaving the modal while open.

Link copied to clipboard

If true, hitting escape will not fire the onClose callback.

Link copied to clipboard
abstract var disablePortal: Boolean?

The children will be under the DOM hierarchy of the parent component.

Link copied to clipboard

If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted.

Link copied to clipboard
abstract var disableScrollLock: Boolean?

Disable the scroll lock behavior.

Link copied to clipboard

If true, swipe to open is disabled. This is useful in browsers where swiping triggers navigation actions. Swipe to open is disabled on iOS browsers by default.

Link copied to clipboard
abstract var draggable: Boolean?
Link copied to clipboard
abstract var elevation: Number?

The elevation of the drawer.

Link copied to clipboard
abstract var enterKeyHint: EnterKeyHint?
Link copied to clipboard
abstract var hidden: Boolean?
Link copied to clipboard
abstract var hideBackdrop: Boolean?

If true, the backdrop is not rendered.

Link copied to clipboard
abstract var hysteresis: Number?

Affects how far the drawer must be opened/closed to change its state. Specified as percent (0-1) of the width of the drawer

Link copied to clipboard
abstract var id: String?
Link copied to clipboard
abstract var inlist: Any?
Link copied to clipboard
abstract var inputMode: InputMode?
Link copied to clipboard
abstract var is: String?
Link copied to clipboard
abstract var itemID: String?
Link copied to clipboard
abstract var itemProp: String?
Link copied to clipboard
abstract var itemRef: String?
Link copied to clipboard
abstract var itemScope: Boolean?
Link copied to clipboard
abstract var itemType: String?
Link copied to clipboard
abstract var keepMounted: Boolean?

Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.

Link copied to clipboard
abstract var key: Key?
Link copied to clipboard
abstract var lang: String?
Link copied to clipboard
abstract var minFlingVelocity: Number?

Defines, from which (average) velocity on, the swipe is defined as complete although hysteresis isn't reached. Good threshold is between 250 - 1000 px/s

Link copied to clipboard
abstract var ModalProps: ModalProps?

Props applied to the /material-ui/api/modal/ element.

Link copied to clipboard
abstract var nonce: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Callback fired when the backdrop is clicked.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract override var onClose: ReactEventHandler<*>

Callback fired when the component requests to be closed.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract var onOpen: ReactEventHandler<*>

Callback fired when the component requests to be opened.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract var onTransitionEnter: () -> Unit?

A function called when a transition enters.

Link copied to clipboard
abstract var onTransitionExited: () -> Unit?

A function called when a transition has exited.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract override var open: Boolean?

If true, the component is shown.

Link copied to clipboard
abstract var PaperProps: PaperProps?

Props applied to the /material-ui/api/paper/ element.

Link copied to clipboard
abstract var prefix: String?
Link copied to clipboard
abstract var property: String?
Link copied to clipboard
abstract var radioGroup: String?
Link copied to clipboard
abstract var ref: Ref<HTMLDivElement>?
Link copied to clipboard
abstract var rel: String?
Link copied to clipboard
abstract var resource: String?
Link copied to clipboard
abstract var results: String?
Link copied to clipboard
abstract var rev: String?
Link copied to clipboard
abstract var role: AriaRole?
Link copied to clipboard
abstract var security: String?
Link copied to clipboard
abstract var SlideProps: SlideProps?

Props applied to the /material-ui/api/slide/ element.

Link copied to clipboard
abstract var slot: String?
Link copied to clipboard

The props used for each slot inside the Modal.

Link copied to clipboard
abstract var slots: ModalSlots?

The components used for each slot inside the Modal. Either a string to use a HTML element or a component.

Link copied to clipboard
abstract var spellCheck: Boolean?
Link copied to clipboard
abstract var style: CSSProperties?
Link copied to clipboard
Link copied to clipboard
abstract var SwipeAreaProps: Any?

The element is used to intercept the touch events on the edge.

Link copied to clipboard
abstract var swipeAreaWidth: Number?

The width of the left most (or right most) area in px that the drawer can be swiped open from.

Link copied to clipboard
abstract override var sx: SxProps<Theme>?

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

Link copied to clipboard
abstract var tabIndex: Int?
Link copied to clipboard
abstract var title: String?
Link copied to clipboard
abstract var transitionDuration: Any?

The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.

Link copied to clipboard
abstract var translate: Translate?
Link copied to clipboard
abstract var typeof: String?
Link copied to clipboard
abstract var unselectable: Unselectable?
Link copied to clipboard
abstract var variant: DrawerVariant?

The variant to use.

Link copied to clipboard
abstract var vocab: String?

Functions

Link copied to clipboard
open inline fun <P : Props> child(type: ElementType<P>, props: P)
Link copied to clipboard
open inline operator fun <P : Props> ElementType<P>.invoke()
open inline operator fun <T> ContextType<T>.invoke(noinline block: ProviderProps<T>.() -> Unit)
open inline operator fun <P : Props> ElementType<P>.invoke(noinline block: P.() -> Unit)
open inline operator fun <T> ContextType<T>.invoke(value: T, noinline block: ChildrenBuilder.() -> Unit)
open inline operator fun <T> Provider<T>.invoke(value: T, noinline block: ChildrenBuilder.() -> Unit)
Link copied to clipboard
open inline operator fun Char.unaryPlus()
open inline operator fun String?.unaryPlus()
open inline operator fun ReactNode?.unaryPlus()
open inline operator fun Props?.unaryPlus()