Design
How it works
The main menu is accessible from every pages of the DAM by clicking on the menu icon in the Header.
By default, the main menu is composed of :
Shortcuts
Search for an asset link : Redirects to the search page,
Upload assets link : Redirects to the mass upload page (only visible for Administrators and Contributors)
Shortcuts can be added in the menu through configuration
Footer links :
Legal Notice : redirects on the legal notice page
Terms of use : redirects on the terms of service page
Feedback : opens the feedback’s popup.
Links can be added in the menu through configuration.
Profile picture / First Name / Last Name : redirect to the user profile edition page. The Profile edition can be disabled
Logout link : The user is disconnected from the DAM by clicking on this link
My boards link : Redirects to “My Boards” page
My searches link : Redirects to “My searches” page
Release Number : Automatically set by the DAM, can be removed at project level.
Language drop-down menu with options : French, English, Deutch. It is possible to disable one or more languages through configuration.
Cross, for closing the menu
Standard Configuration
blablabla bla
Expand |
---|
title | Advanced Configuration |
---|
|
Adding shortcuts in the main menu
The shortcuts you want to display must be described in the action-availabled.json file located in the menu directory. It is an Array<Action> with the following settings :
Config Path | Default value | Description |
---|
$.menu.actionAvailabled =
| Code Block |
---|
| [
{
"id": "menu-action-search",
"key": "sidebar.search.title",
"icon": "fal fa-search",
"to": {
"name": "dam-explore",
"params": {
}
},
"descriptionKey": "sidebar.search.description"
},
{
"id": "menu-action-upload",
"key": "nav.upload",
"icon": "fal fa-cloud-upload",
"to": {
"name": "import-jobs",
"params": {
}
},
"descriptionKey": "sidebar.upload.description",
"onlyForUserGroups": [
4, 27
],
"onlyIfAllFeaturesActive": ["upload"]
}
] |
| Shortcut to asset search Shortcut to asset import |
Each Action object has the following structure :
Property | Type | Default | Description |
---|
id
| string
| false
| Unique identifier of your choice for the shortcut | key
| string
| undefined
| I18n key for shortcut label | icon
| string
| undefined
| Font awesome style fa-s/l/r + icon name prefixed with fa- | to
| object
| {}
| A JSON object with a mandatory name property to specify the Vue route to follow on an existing component of your choice. Ex: {
"name": "dam-explore",
"params": {}
}
| descriptionKey
| string
| undefined
| I18n key for shortcut description |
Adding footer links in the main menu
The footer links you want to display must be described in the footer-links.json file located in the menu directory. The links property is an Array<Link> with the following settings :
Config Path | Default value | Description |
---|
$.menu.footerLinks
| Code Block |
---|
{
"links": [
{
"i18n": "page.title.legal",
"routing": {
"to": {
"name": "legal"
}
}
},
{
"i18n": "sidebar.about",
"routing": {
"to": {
"name": "cgu"
}
}
}
]
} |
| Link to legal notice page Link to CGU page |
Each Link object has the following structure :
Property | Type | Default | Description |
---|
i18n
| string
| undefined
| I18n key for link label | routing
| object
| {}
| A JSON to object containing a mandatory name property to specify the Vue route to follow. Ex: { "to": { "name": "legal" } }
|
Adding links in the sidebar menu
The links you want to display in the sidebar menu must described in the links.json file located in the menu directory. It's an Array<Link> with the following settings :
Config Path | Default value | Description |
---|
$.menu.links =
| Code Block |
---|
[
{
"key": "sidebar.links.board",
"suffixIfAnonymous": true,
"to": {
"name": "boards",
},
"descriptionKey": "sidebar.links.boardDescription",
"onlyIfAllFeaturesActive": ["boards"]
},
{
"key": "sidebar.links.searches",
"onlyIfLogged": true,
"to": {
"name": "savedSearches"
},
"descriptionKey": null
}
] |
| Link to the user boards Link to the user stored searches |
Each Link object has the following structure : Property | Type | Mandatory | Default | Description |
---|
key
| string
| true
| undefined
| I18n key for link label | to
| object
| true
| {}
| A JSON object containing a mandatory name property to specify the Vue route to follow. Ex: { "to": { "name": "savedSearches" } }
| descriptionKey
| string
| false
| undefined
| I18n key for shortcut description | suffixIfAnonymous
| boolean
| false
| | | onlyIfAllFeaturesActive
| array
| false
| []
| A list of features required for link activation | onlyIfLogged
| boolean
| false
| true
| Specifies if the link is public or if the user must be logged in for link activation |
Disabling one or more languagesThe list of available languages can be modified from the available-languages.json file located in the language directory. It is an Array<Lang> with the following description :
Config Path | Default value | Description |
---|
$.language.availableLanguages | Code Block |
---|
| [
{
"name": "fr",
"id": 1
},
{
"name": "en",
"id": 2
},
{
"name": "de",
"id": 4
}
] |
| An array of lang objects with 2 entries: |
|
Disabling access to the Profile menu
See Main Menu - User profile
Hiding the Release Number
Add or modify the hide-server-version.json file (located in the menu
directory) and set its content to true (default is false).