Design

Default Configuration

Assets filter

Keywords filter

Rights filter

People filter

Category filter

Campaign filter

Language

Configuring the search bar

Resolving the search bar to use for a context

Search bars are configured per cursor and resource, based on the current context chosen by the user. The application falls back to default configuration if no search bar can be found for current context. Config is loaded from first existing configuration from:

• $.dam.explore.filters.<cursorName>.<resourceName>

• $.dam.explore.filters.<cursorName>.defaultResourceConfig

• $.dam.explore.filters.defaultCursorConfig.<resourceName>

• $.dam.explore.filters.defaultCursorConfig.defaultResourceConfig

Exemple: Given user has chosen a context mapping to cursor “activeCursor” and resource “activeResource”, the application will load first existing search bar config from the following paths:

• $.dam.explore.filters.activeCursor.activeResource

• $.dam.explore.filters.activeCursor.defaultResourceConfig

• $.dam.explore.filters.defaultCursorConfig.activeResource

• $.dam.explore.filters.defaultCursorConfig.defaultResourceConfig

Configuring a search bar

From a configuration perspective, a search bar is defined by an object with following properties:

• hideSide: boolean - Defines if a side search should be displayed

• filters: Array<SearchItem> - Defines the items that are used as search entries. Each item will at that level will reflect either:

  • A button in the search bar

  • An entry in the side search (entry must describe a tree field filter)

SearchItem description

A SearchItem can be one of the following:

• A string referencing a NamedFilterConfig

• An ItemFilterConfig

• A GroupFilterConfig

NamedFilterConfig description

NamedFilterConfig are named filters configurations. This allows to define Filters once and to re-use them across different contexts.

NamedFilterConfig are defined in $.common.namedFilters. It can be one of:

• A string reflecting a NamedFilterConfig

• A string reflecting a field name (as defined in the admin structure area)

• An ItemFilterConfig

• A CustomConstraintFilterConfig

• A GroupFilterConfig

ItemFilterConfig description

An ItemFilterConfig reflects a single filter. It can be defined as:

• A string representing the field you want to create a filter from. In such case, default behaviour of this filter will be defined base on the field type. This is equivalent to creating a FieldFilterConfig by only specifying the field property:
  

  "myfieldname"
  // equivalent to
  {
    "field": "myfieldname"
  }

• An FieldFilterConfig describing the filter.

FieldFilterConfig description

An Object representing a filter for a given field.

Common FieldFilterConfig properties

Additional FieldFilterConfig properties for Boolean fields

Additional FieldFilterConfig properties for Date fields

DateConstraint description

See in v0 config $.common.namedFilters.rightsGroupEndRights for examples

Additional FieldFilterConfig properties for Number fields

Additional FieldFilterConfig properties for Relationship fields

Before resolving a relationship filter, the application will by default discover if the field is a tree relationship. It is possible to force the application NOT to use a tree filter for a tree field

It is NOT possible to force the application to use a tree filter for a non-tree relationship.

Additional FieldFilterConfig for non tree Relationship fields

Additional FieldFilterConfig for tree Relationship fields

Additional FieldFilterConfig for tree String fields

CustomConstraintFilterConfig description

CustomConstraintFilterConfig allows to define a filter that relies on filters applying to multiple fields.

GroupFilterConfig description

A GroupFilterConfig allows to group multiple ItemFilterConfig or GroupFilterConfig together.

For easier configuration, a GroupFilterConfig can de defined as a simple Array, where:

• The first item in the array is either:

  • a string (the value is considered to be an i18n key

  • an Array<string> where

    • first item is an i18n key

    • second item is a css selector used for displaying the icon

  • an Object

  • null

• Other items are all of type SearchItem

On such configuration, this array is transformed by the application into a GroupFilterConfig object:

["some.key", "item1", "item2"]

is equivalent to:

{
  "i18n": "some.key",
  "config": ["item1", "item2"]
}

[{...props}, "item1", "item2"]

is equivalent to:

{
  ...props,
  "config": ["item1", "item2"]
}

[["some.key", "far fa-cog"], "item1", "item2"]

is equivalent to:

{
  "i18n": "some.key",
  "icon": "far fa-cog",
  "config": ["item1", "item2"]
}

[null, "item1", "item2"]

is equivalent to:

{
  "config": ["item1", "item2"]
}

GroupFilterConfig properties

GroupTabWrapperadditional properties

A tabs property can be provided to define how to organise , items within the groups.

Passing tabs as an Array

Use the array syntax for static tabs. Each item within the tabs array should be an object with following properties:

Passing tabs as an Object

Use the object syntax if you want to generate the tabs as values of a filter. On such circumstance, tabs should be an object with following properties:

GroupWrapper additional properties