Versions Compared

Old Version 17

changes.mady.by.user Emilie Nucci

Saved on

compared with

New Version Current

changes.mady.by.user Lucas CORSINI

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Design

...

...

Default Behaviour(s) :

...

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 :

  • 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

    • Footer links

  • Legal Notice : the user is redirected on the legal notice page

    • Terms of use : the user is redirected on the

    • 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

    • Language drop-down menu with options : French, English, Deutch. It is possible to disable one or more languages through configuration.

    • My boards link : Redirects to “My Boards” page

    • My searches link : Redirects to “My searches” page

    • Configure DAM link : Opens wedia-config interface in a new window (Only for developers role)

    • Footer links :

      footer-links.pngImage Added

      • Legal Notice : redirects to the legal notice page

      • Terms and conditions : redirects to the terms of service page

      • Feedback : opens the feedback’s popup.

    ...

    Profile picture / First Name / Last Name

    ...

    ...

    My boards link

    ...

    My searches link

    • Release Number

    ...

    Language drop-down menu with options :

    • French, English, Deutch

    ...

    Cross, for closing the menu

    Advanced Configuration

    ...

    • : Automatically set by the DAM, can be removed at project level.

    Standard Configuration

    Since Starter Kit 2023.3, it is now possible to configure the footer links in the menu via the DAM configuration page.

    For more details, see this page.

    Advanced Configuration

    ...

    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
    languagejson
    [
  {
    "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

    ...

    {}

    ...

    {

    "name": "dam-explore",

    "params": {}

    }

    ...

    descriptionKey

    ...

    string

    ...

    undefined

    ...

    I18n key for shortcut description

    ...

    Note

    Deprecated : since Starter-Kit 2023.3.0, use DAM configuration page to setup the footer links

    Expand
    titleSee deprecated method

    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" } }

    ...

    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

    The 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
    languagejson
    [
  {
    "name": "fr",
    "id": 1
  },
  {
    "name": "en",
    "id": 2
  },
  {
    "name": "de",
    "id": 4
  }
]

    An array of lang objects with 2 entries:

    • name: the ISO code

    • id

    ...