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.
- type: Image
OnPress¶
Action/Rule to be triggered when the item is pressed.
- type: ActionOrRule
- Formatter and Binding are not supported
PageToOpen¶
Page to be rendered, references a .page file.
- type: Page
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:
objectwith following properties.
| Property | Type | Required | Default |
|---|---|---|---|
SectionItemActive |
string | Optional | |
SectionItemOnPress |
string | Optional | |
SectionItemInactive |
string | Optional | |
| SectionItemImage | 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.
SectionItemImage¶
The string value is a style class name for image in menu item. It is applicable only to SAP icon or font icon types (Supported CSS properties are font-size and color).
- Image style class
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