Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RadSideDrawer

This is the SideDrawer component. It separates your mobile app's screen into a main part and a menu part whereby the menu part is shown upon a swipe gesture using a transition effect.

Hierarchy

  • any

Index

Properties

allowEdgeSwipe

allowEdgeSwipe: boolean

Gets or sets a boolean value that determines if drawer can be opened with edge swipe.

android

android: any

drawerContent

drawerContent: View

Gets or sets the menu screen content for the current SideDrawer instance. The value must be a valid {@link View} instance.

drawerContentSize

drawerContentSize: number

Gets or sets a number which defines either the width or the height of the menu pane depending on the location of the SideDrawer. Top or Bottom - height, Right or Left - width.

drawerLocation

drawerLocation: SideDrawerLocation

Gets or sets the location of the menu pane.

drawerTransition

drawerTransition: DrawerTransitionBase

Gets or sets the transition used to animate the process of showing or hiding the menu pane. Depending on the transition set, the main content can also be part of the animation. This property must be set to an object inheriting from DrawerTransitionBase.

gesturesEnabled

gesturesEnabled: boolean

Gets or sets a boolean value that determines if drawer can be opened or closed with gestures.

ios

ios: any

mainContent

mainContent: View

Gets or sets the main screen content for the current SideDrawer instance. The value must be a valid {@link View} instance.

shadowColor

shadowColor: colorModule.Color

Gets or sets the shadow color. By default it is black with some opacity.

Static drawerClosedEvent

drawerClosedEvent: string

Fired when the drawer has been closed.

Static drawerClosingEvent

drawerClosingEvent: string

Fired when the drawer is about to close.

Static drawerContentProperty

drawerContentProperty: Property<RadSideDrawer, View>

Identifies the drawerContent dependency property.

Static drawerContentSizeProperty

drawerContentSizeProperty: Property<RadSideDrawer, number>

Identifies the drawerContentSize dependency property.

Static drawerLocationProperty

drawerLocationProperty: Property<RadSideDrawer, SideDrawerLocation>

Identifies the drawerLocation dependency property.

Static drawerOpenedEvent

drawerOpenedEvent: string

Fired after the drawer has been opened.

Static drawerOpeningEvent

drawerOpeningEvent: string

Fired when the drawer is about to open.

Static drawerPanEvent

drawerPanEvent: string

Fired when the drawer is being opened by its edge gesture.

Static drawerTransitionProperty

drawerTransitionProperty: Property<RadSideDrawer, DrawerTransitionBase>

Identifies the drawerTransition dependency property.

Static gesturesEnabledProperty

gesturesEnabledProperty: Property<RadSideDrawer, boolean>

Identifies the gesturesEnabled dependency property.

Static mainContentProperty

mainContentProperty: Property<RadSideDrawer, View>

Identifies the mainContent dependency property.

Static shadowColorProperty

shadowColorProperty: Property<RadSideDrawer, colorModule.Color>

Identifies the shadowColor dependency property.

Methods

closeDrawer

  • closeDrawer(): void
  • When called, closes the SideDrawer if it is open.

    Returns void

getIsOpen

  • getIsOpen(): boolean
  • Gets a value that indicates whether the drawer is open.

    Returns boolean

showDrawer

  • showDrawer(): void
  • When called, opens the SideDrawer if it is closed.

    Returns void

toggleDrawerState

  • toggleDrawerState(): void
  • Toggles the current state of the SideDrawer instance.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method