Versions Compared

Version Old Version 3 New Version 4
Changes made by

Emilie Nucci

Guillaume LEPICARD

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Config path

Default value

Description

Image 1 - Board

Image 2 - Board

Image 3 - Board

Advanced Configuration

Search bar area

Search bar can be configured as a simple “google like” search or with a “fill-in the gaps sentence”. Default configuration uses the “google like” search.

The background sliding images can be configured as a dedicated contribution of images or as the result of a predefined query on any dam content inside the DAM. Default configuration uses a dedicated contribution.

“google like” search

Config path

Default value

Description

$.home.displaySearchBar

true

Enables the google like search

$.home.headerNavHomeBarSearches

Code Block
[
  {
    "translationKey": "home.searchBar.allmedia"
  },
  {
    "translationKey": "home.searchBar.video",
    "targetCursorName": "allVideos"
  }
]

Defines the different values available in the left drop-down menu.

Each entry in the array is an object accepting 2 properties:

  • translationKey (mandatory), the i18n key for the dropdown item

  • targetCursorName name of the cursor the search should lead to (default: allAssets)

$.home.hideCursorNameIfAlone

true

When set to true, will hide the cursor name, if only one available

i18n home.button.search

Search

i18n key for the search button

fill-in the gaps sentence

Config path

Default value

Description

$.home.displayNaturalSearch

false

Enables the fill-in the gaps sentence

$.home.headerNavNaturalSearches

undefined

Accepts an array of sentence description.

Each entry in this array is an object allowing following properties:

  • translationKey: String, i18n key for the search

  • cursor: Objecta cursor description

  • suggestedDisplayFields: Array<String> list of fields to be used for auto-complete when filling-in text in the free search field

  • enabledFields: Array<String> list of fields enabled for selecting values

  • fieldsConfig: Objectallows to configure how enabledFields should be displayed. Each entry in this object should match an item of enabledFields. Each value provides options for configuring the field.

i18n key:

naturalsearch.loading

Searching…

Button text when the search is running

i18n key:

naturalsearch.noResults

Sorry, no results for your search

Button text when search returns no result

i18n key:

naturalsearch.viewNresults

View {0} results

Button text when search returned results

Note

If both $.home.displaySearchBar and $.home.displayNaturalSearch are set to true, the system will show both search options.

Common config to both searches

Config path

Default value

Description

$.home.hideFulltextModeOption

true

When set to false, adds a checkbox to enable “reference searches”. By checking this box, the system will permform searches using an “OR” operator between words instead of using an “AND” this is usefull to search for multiple product references: results will only need to match one reference instead of all references

i18n key: common.search.fulltextoption.allterms

Search by reference

i18n for the checkbox label: common.search.fulltextoption.allterms

background sliding images as a dedicated contribution

Contributing sliding images is a 2 steps process from the backend interface:

  1. Upload and describe images Administration > Manage Portal > Manage Home carousel images.

  2. Create a home widget Administration > Manage Portal > Home Widgets of type carousel and assign it the images you want

background sliding images as a predefined query

Defining the images displayed in the slider can be done by defining a cursor and referencing it in the config entry point $.home.homeHeaderCarousel.

The default value for this config entry point is homeHeaderCarousel, however, no cursor has been defined.

By defining such a cursor, the system will load matching data and use the result to display images.

Note

background sliding images as a predefined query has precedence over background sliding images as a dedicated contribution. As soon as the cursor matching the $.home.homeHeaderCarousel config entry point exists, contributed images will not be used anymore.

Widgets area

Widgets are contributed from the back-end interface. Administration > Manage Portal > Home Widgets. You can sort the widgets from the backend interface.

Based on the widget type you select, the form will adapt itself to let you choose one, two, three or four public carts.

From a portal perspective, widgets are loaded by retrieving the list of contributed home widgets.

Analytics widget

Analytics widget cannot be configured ; it is activated through 2 conditions:

  1. There is a carousel widget configured in backend

  2. The config entry point $.home.displayTopMedias is not set to false

Footer area

A footer of links can be displayed on the home page.

To activate it, set config entry point $.home.displayFooter to true

Links displayed are configured through $.home.footer (Array)

Each item in the array is an object containing following properties:

  • icon?: String|Object|Array classes for displaying an icon. Defaults to fal fa-external-link-square

  • i18n: String i18n key of the link label.

  • action?: Object store action to dispatch.

    • type: name of the action to dispatch

    • payload?: payload to pass to the action

  • routing?: An object for routing (same props than what a b-link would accept)