Methods
# inner container(rawContainer) → {vikiElevateContainer}
vikiElevateContainer Model
Parameters:
| Name | Type | Description |
|---|---|---|
rawContainer |
Object
|
Container |
Container - The vikiElevateContainer representation
vikiElevateContainer
# inner dictionary(key, rawDictionary) → {DictionaryModel}
Creates a Dictionary model, with name, dir, code and entries
Parameters:
| Name | Type | Description |
|---|---|---|
key |
String
|
The Dictionary key, which will be the code |
rawDictionary |
any
|
the non-parsed dictionary |
a Dictionary Model
DictionaryModel
# inner menu(rawMenu) → {VikiElevateMenu}
VikiElevateMenu Model
Parameters:
| Name | Type | Description |
|---|---|---|
rawMenu |
Object
|
Menu |
menu - The VikiElevateMenu representation
VikiElevateMenu
# inner page(rawPage) → {VikiElevatePage}
VikiElevatePage Model
Parameters:
| Name | Type | Description |
|---|---|---|
rawPage |
Object
|
Page |
menu - The VikiElevatePage representation
VikiElevatePage
# inner routeModel(rawRoute) → {Route}
Route Model
Parameters:
| Name | Type | Description |
|---|---|---|
rawRoute |
Object
|
Route |
route - The Route representation
Route
# inner theme(rawTheme) → {VikiElevateTheme}
VikiElevateTheme Model
Parameters:
| Name | Type | Description |
|---|---|---|
rawTheme |
Object
|
Theme |
theme - The VikiElevateTheme representation
VikiElevateTheme
# inner vikiElevateMenuItem(rawItem) → {VikiElevateMenuItem}
Menu items model
Parameters:
| Name | Type | Description |
|---|---|---|
rawItem |
Object
|
Item |
Item - The VikiElevateMenuItem representation
VikiElevateMenuItem
Type Definitions
# DictionaryEntry
Properties:
| Name | Type | Description |
|---|---|---|
key |
Strign
|
key of the entry |
value |
Strign
|
Translated value of the entry |
# DictionaryModel
Properties:
| Name | Type | Description |
|---|---|---|
name |
String
|
Name of the dictionary |
dir |
String.<('lrt'|'rtl')>
|
directionallity between rtl and ltr |
code |
String
|
ISO locale code |
entries |
Array.<DictionaryEntry>
|
directionallity between rtl and ltr |
Object
# Route
This model represents the Page.
Route representation
Properties:
| Name | Type | Description |
|---|---|---|
route |
String
|
route string |
template |
String
|
route template from the list defined in config/constant (PAGE_TEMPLATES) |
id |
String
|
CMD page ID |
Object
# vikiElevateContainer
This model represents the Menu.
vikiElevateContainer representation
Properties:
| Name | Type | Description |
|---|---|---|
title |
String
|
container's title |
id |
String
|
identifier of the current container |
displaytext |
String
|
container text property |
items |
String
|
container items |
query |
String
|
container's query to retrieve items |
template |
String
|
container template |
subtitle |
String
|
container's subtitle |
Object
# VikiElevateMenu
This model represents the Menu.
vikiElevateMenu representation
Properties:
| Name | Type | Description |
|---|---|---|
title |
String
|
title (on CMS) property |
displaytext |
String
|
menu text property |
items |
Array.<VikimapMenuItem>
|
Menu items |
Object
# VikiElevateMenuItem
Properties:
| Name | Type | Description |
|---|---|---|
title |
String
|
title (on CMS) |
displayText |
String
|
menu text |
page |
Page
|
page where to navigate |
route |
String
|
string representing the route |
itemGroup |
String
|
tag to group the icons on |
viaIconLabel |
String
|
svg via 4 icon |
requireauthentication |
Boolean
|
Only shown when auth |
hiddenWhenAuth |
Boolean
|
Hidden when auth |
Object
# VikiElevatePage
This model represents the Page.
vikiElevatePage representation
Properties:
| Name | Type | Description |
|---|---|---|
containers |
Array.<VikiElevateContainer>
|
structure for the page layout |
displaytext |
String
|
page text property |
menu |
VikiElevateMenu
|
custom menu for page |
template |
String
|
page template |
title |
String
|
page's title |
theme |
Array.<VikiElevateTheme>
|
page's theme |
Object
# VikiElevateTheme
This model represents the Theme.
vikiElevateTheme representation
Properties:
| Name | Type | Description |
|---|---|---|
accent |
String
|
focus color |
alternativeBackground |
String
|
skeletons, other backgrounds |
background |
String
|
page background |
colorOnAccent |
String
|
text color on focus |
colorOnBackground |
String
|
main color for regular text |
colorOnAccent |
String
|
error text color |
overlay |
String
|
overlay color |