Skip to content

SideDrawerItem

This is an object representing a navigation item in side drawer

SideDrawerItem Properties

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

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 No
SectionItemOnPress string No
SectionItemInactive string No
SectionItemImage string No

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.

SectionItemImage

The string value is a style class name for image in menu item.


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 one of the known values listed 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