Skip to content

SideDrawerItem

This is an object representing a navigation item in side drawer

SideDrawerItem Properties

Property Type Required Default
Image Image Optional
OnPress ActionOrRule Optional
PageToOpen Page Optional
ResetIfPressedWhenActive boolean Optional false
Styles object Optional
TextAlignment enum Optional "left"
Title string Required
Visible boolean Optional true
_Name string Required

Image

Image to be displayed for the item. Image will display together with Title if specified.


OnPress

Action/Rule to be triggered when the item is pressed.


PageToOpen

Page to be rendered, references a .page file.


ResetIfPressedWhenActive

Flag to determine whether we need to navigate back to the initial page (PageToOpen) when the selected side drawer item is pressed again

  • type: boolean
  • default: false

Styles

Override styles for the item.

  • type: object with following properties.
Property Type Required Default
SectionItemActive string Optional
SectionItemOnPress string Optional
SectionItemInactive string Optional

SectionItemActive

Use this to style menu item which is currently selected.

SectionItemOnPress

Use this to style menu item when it is touched upon.

SectionItemInactive

Use this to style all the menu items that are not selected.


TextAlignment

Choose one of the options based on how you want the text alignment on your side drawer item to appear.

  • type: enum
  • default: "left"

The value of this property must be equal to one of the known values below.

TextAlignment Known Values

Value Description
left
right
center

Title

A caption label for the item

  • type: string

Visible

A flag to determine if the item is visible

  • type: boolean
  • default: true

_Name

  • type: string