Constructor
new NavigatorOption(setup, viewNavigator)
Creates an instance of NavigatorOption.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
setup |
Object | The configuration object for the NavigatorOption. Properties
|
||||||||||||||||||||||||||||||
viewNavigator |
function | A function returning the ViewNavigator instance. |
- Source:
Members
defaultData :Object
Data loaded as a parameter when the selected view is loaded.
Type:
- Object
- Source:
description :string
The description displayed as the label of the navigation option.
Type:
- string
- Source:
(readonly) displayName :string
Gets the combined display name of the option, including title and description.
Type:
- string
- Source:
doc :Object
The document to be loaded when type is 'doc-list'.
Type:
- Object
- Source:
(readonly) docUID :string
Gets the unique identifier of the associated document when the option type is 'doc-list'.
Type:
- string
- Source:
index :string
The index that triggers the navigation option on user input.
Type:
- string
- Source:
targetView :string
The path of the view to be opened, e.g., "crud/create".
Type:
- string
- Source:
title :string
The title displayed as the label of the navigation option.
Type:
- string
- Source:
trigger :function
A function triggered when the option is selected.
Type:
- function
- Source:
type :string
The type of the option: 'nav' for navigation or 'doc-list' for document listing.
Type:
- string
- Default Value:
- 'nav'
- Source:
(readonly) viewNavigator :ViewNavigator
Gets the ViewNavigator instance associated with this option.
Type:
- Source:
viewParams :Object
Parameters to be passed when the selected view is loaded.
Type:
- Object
- Source: