Page Comparison

...

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

• hideSide: Boolean 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)

...

A SearchItem can be one of the following:

• A String reflecting string referencing a NamedFilterConfig

• An ItemFilterConfiguration ItemFilterConfig

• A GroupFilterConfiguration GroupFilterConfig

NamedFilterConfig description

...

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

• A String string reflecting a NamedFilterConfig

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

• An ItemFilterConfiguration ItemFilterConfig

• A CustomConstraintFilterConfig

• A GroupFilterConfiguration GroupFilterConfig

...

ItemFilterConfig description

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

• A String 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:
  

  Code Block
  language json
  "myfieldname" // equivalent to { "field": "myfieldname" }

• An FieldFilterConfig describing the filter.

...

...

...

Boolean filter when inline is false or undefined

...

Boolean property when inline is true

Additional FieldFilterConfig properties for Date fields

...

...

...

...

...

Tree relationship with folder layout

Image Removed

Tree relationship with empty layout

...

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