Props

io.github.nafg.scalajs.facades.mui.SwipeableDrawer.Props
class Props extends WithChildren[VdomNode]

Attributes

Graph
Supertypes
trait WithChildren[VdomNode]
trait PropTypes
class Object
trait Matchable
class Any

Members list

Type members

Inherited classlikes

object dyn extends Dynamic

Attributes

Inherited from:
PropTypes
Supertypes
trait Dynamic
class Object
trait Matchable
class Any

Value members

Concrete methods

def SwipeAreaProps: Prop[Object]

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

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

Attributes

def allowSwipeInChildren: Prop[Any => Any | Boolean]

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

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

Value parameters

{HTMLDivElement}

paper The drawer's paper element

{TouchEvent}

event The 'touchstart' event

Attributes

def children: Prop[VdomNode]

The content of the component.

The content of the component.

Attributes

def disableBackdropTransition: Prop[Boolean]

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

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

Attributes

def disableDiscovery: Prop[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.

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.

Attributes

def disableSwipeToOpen: Prop[Boolean]

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.

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.

Attributes

def hysteresis: Prop[Double]

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

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

Attributes

def minFlingVelocity: Prop[Double]

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

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

Attributes

def onClick: Prop[ReactMouseEventFromHtml => Callback]
def onClose: Prop[Any => Any]

Callback fired when the component requests to be closed.

Callback fired when the component requests to be closed.

Value parameters

{React.SyntheticEvent<{}>}

event The event source of the callback.

Attributes

def onOpen: Prop[Any => Any]

Callback fired when the component requests to be opened.

Callback fired when the component requests to be opened.

Value parameters

{React.SyntheticEvent<{}>}

event The event source of the callback.

Attributes

def open: Prop[Boolean]

If true, the component is shown.

If true, the component is shown.

Attributes

def style: Prop[Object]
def swipeAreaWidth: Prop[Double]

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

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

Attributes

def transitionDuration: Prop[Double | Object]

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

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

Attributes

Inherited methods

def of[A : Writer](implicit evidence$1: Writer[A], name: Name): Prop[A]

Attributes

Inherited from:
PropTypes

Inherited fields

val key: Prop[Key]

Attributes

Inherited from:
PropTypes