Design
Line layout | Column layout |
List layout | Square layout |
Small Square | Table |
Default Configuration
Default Behaviour(s) :
#00 : Display modes component is used in two different pages :
Search results page
on the main page
with each cursor
Boards page
on the main page
when looking at assets in a board
#02 : On the search page, 4 of the 6 display modes are displayed on the main page as well as within each cursor:
Line layout
Column layout
List layout
Square layout
#03 : On the boards page, 2 of the 6 display modes are displayed on the main page:
Line layout
Square layout
Whereas looking at assets in a board, 4 of the 6 display modes are displayed:
Line layout
Column layout
List layout
Square layout
#04 : The default layout selected is mostly the Square Layout except when looking at assets in a board where the default layout will be the Column Layout.
#05 : For the List layout the metadata displayed on each tile are :
On the search results main page and the cursors:
Name
Caption
Keywords
When looking at assets in a board:
Name
Photograph
Caption
#06 : 2 additionnal modes are available, but not displayed by default :
Small square : No metadata overlay can be displayed on the tiles in that mode. The only action available is selection. Can be setup at the JSON configuration level.
Table : The metadata displayed as columns can be setup at the JSON configuration level.
Advanced Configuration
Activating/deactivating every display mode for a cursor
To hide the display modes for a cursor, you just have to change it’s configuration in the config path $.dam.explore.layouts.<cursorName>.defaultResourceConfig.hideLayout.json
to true
.
<cursorName>
can be replaced with defaultCursorConfig
for the default cursor display or all-videos
for the "All videos" cursor.
Activating/deactivating every display mode for the main Board page
To hide the display modes for the main board page, you just have to change it’s configuration in the config path $.board.boardsView.layout.hideLayout.json
to true
.
Activating/deactivating every display mode when looking at assets in a board
To hide the display modes for the main board page, you just have to change it’s configuration in the config path $.board.explore.layout.hideLayout.json
to true
.
Configuring default display mode for a cursor
<cursorName>
can be replaced with defaultCursorConfig
for the default cursor display or all-videos
for the "All videos" cursor.
Config path | Default value | Description |
---|---|---|
Translation i18n key: | Line layout | tooltip |
Translation i18n key: | Column layout | tooltip |
Translation i18n key: | List layout | tooltip |
Translation i18n key: | Square layout | tooltip |
| [ { "key": "row", "i18n": "layout.line", "icon": "cw-svg-h-bricks", "aliases": ["line", "rows"] }, { "key": "col", "i18n": "layout.column", "icon": "cw-svg-v-bricks", "aliases": ["cols", "columns", "column"] }, { "key": "list", "i18n": "layout.list", "class": "fas fa-list-ul" }, { "key": "square", "i18n": "layout.square", "class": "fas fa-grip-horizontal" } ] | In this configuration file, each object represents a layout that will be displayed in the display mode. |
| "square" | Defines the default layout that will be selected |
| true | By default, hides the label: To show the label, put this value to |
| false | By default, will show the display mode: If this value is set to |
Configuring metadata displayed in the list layout of the dam explorer
This is an example of the default display of an asset in the dam explore page, when the layout is selected as list:
This is it’s configuration:
Config path | Default value | Description |
---|---|---|
| [ { "field": "description", "withoutLabel": true }, { "field": "keywords", "clickable": true, "showIfEmpty": true, "badge": true, "withoutLabel": false } ] | The
If we still want to display a field even if it’s empty, set The When set to true, the keywords will display as a button-like way. If set to false, the keywords will display as a simple text. |
| [ { "field": "duration", "withoutLabel": true } ] | |
| { "namedVariation": "small" } | |
| [ "defaultListItemTitleName" ] |
Configuration for boards
The following configuration is for the main page of the boards.
Config path | Default value | Description |
---|---|---|
Translation i18n key: | List layout | |
Translation i18n key: | Square layout | |
| [{ "key": "list", "i18n": "layout.list", "class": "fas fa-list-ul" }, { "key": "square", "i18n": "layout.square", "class": "fas fa-grip-horizontal" }] | Here is determined which layout display will be shown. |
| "square" | Default layout that will be selected unless the user has already selected a layout at least once. |
| false | |
| "board" |
Configuring metadata displayed in the list layout of the boards page
Config path | Default value | Description |
---|---|---|
| Photo by | |
| { "col": "assetTile", "list": "assetBoardList", "mobile": "assetMobile", "row": "assetTile", "square": "assetTile", "table": "assetTableRow" } | |
| [ { "field": "description", "withoutLabel": true } ] | |
| [ { "field": "duration", "withoutLabel": true } ] | |
| { "namedVariation": "small" } | |
| [ { "clickable": true, "field": "photograph", "i18n": "asset.photo.by", "inline": true } ] | |
| [ { "field": "name", "withoutLabel": true } ] |
Configuration for other non-default layouts
Config path | Default value | Description |
---|---|---|
| { "key": "squareSmall", "i18n": "layout.squareSmall", "class": "fal fa-grip-horizontal" } | Add this code in the config path to display the Small square in the searsh result page |
| { "key": "table", "i18n": "layout.table", "class": "fal fa-table" } | Add this code in the config path to display the Table layout when looking at assets in a board |
| { | |
| [ | This configuration allows to set the metadata in the columns and the size of them in the table layout. |