builder-list.md

List builder configuration

go back to Table of contents

---

The list builder is used to configured the list view. It can takes the following configuration:

builders:
  list:
    params:
      title: ~
      filters: ~
      filtersMode: ~
      filtersModalSize: ~
      fields: ~
      display: ~
      sort: ~
      actions: ~
      object_actions: ~
      batch_actions: ~

Title

title default: {basekey}.title type: string

Used to set the title of the page. By default, it is filled with {admingeneratorprefix}.title.

Filters

filters default: ~ type: array filtersMode default: default type: string filtersModalSize default: medium type: string

By default, all filterable fields are available as filter. If you want to specify which filters (and in which order) you want to display, simply fill the filters array:

list:
  params:
    filters: [ name, gender ]

If you want to adjust the rendering of the filter field, please refer to the field configuration documentation. Several filter related configuration parameters are described there.

More information about the filtersMode and filtersModalSize can be found in the filter documentation.

Fields

filters default: ~ type: array See the field configuration documentation.

Note: The field and filter parameters have the same effect in the list view. However note that the filter parameters overwrite the form parameters, if any.

Display

display default: ~ type: array

With the display parameter you can specify the fields that need to be displayed. Works the same as the filters parameter.

Sort

sort default: ~ type: array

With this parameter you can define default sort column and sort order. First element of array is column, while sort order is optional second element of array and default is ASC. Example:

sort: [ column_name, 'ASC' ]

Actions

Actions can be enabled by simply specifying them here with the value ~. The following example will render the new action on the right below the list, the batch delete action on the left below the list and the edit action for every object:

edit:
  params:
    actions:
        new: ~
        object_actions:
        edit: ~
    batch_actions:
        delete: ~

You can also use self-defined actions from your global generator parameters, or overwrite specific part of the actions. Check the action documentation for more information.