List Columns

List Columns are column definitions used by lists. These are referred to by the following areas.

• Backend List Controller
• Backend Relation Controller

All list columns are identified as their individual type property.

columns:
    mycolumn:
        type: number
        # ...

# Available Columns

The following list columns are available:

# Column Properties

For each column can specify these properties (where applicable):

# Custom Value Selection

It is possible to change the source and display values for each column. If you want to source the column value from another column, do so with the valueFrom option.

other_name:
    label: Something Great
    valueFrom: name

If you want to keep the source column value but display a different value from the model attribute, use the displayFrom option.

status_code:
    label: Status
    displayFrom: status_label

This is mostly applicable when a model accessor is used to modify the display value. This is useful where you want to display a certain value, but sort and search by a different value.

public function getStatusLabelAttribute()
{
    return title_case($this->status_code);
}

# Nested Column Selection

In some cases it makes sense to retrieve a column value from a nested data structure, such as a model relationship column or a jsonable array. The following example would look for the value in PHP equivalent of $record->content->title or $record->content['title'] respectively.

content[title]:
    name: Title
    sortable: false

The only drawback of doing this is the column cannot use searchable or sortable options. To make the column searchable, and for performance reasons, we recommend duplicating its value on the local database table using model events. Alternatively, you can use the relation property described further below.

# Direct SQL Selection

The select property allows you to create a column using a custom select statement. Any valid SQL SELECT statement works here.

full_name:
    label: Full Name
    select: concat(first_name, ' ', last_name)

# Related Column Selection

The relation property allows you to display related columns as part of the database query, allowing for searching and sorting of that column. The relation is set to the name of the model relationship. In the next example the name value will be translated to the name attribute found in the related model (eg: $model->name).

group_name:
    label: Group
    relation: groups
    select: name

To display a column that shows the number of related records, use the relationCount property.

users_count:
    label: Users
    type: number
    relation: users
    relationCount: true

# Tooltip

The tooltip property enhances list columns by adding an informational icon in the column header. Hovering over this icon displays a tooltip, offering additional context or details about the column. This feature aids in providing users with guidance or clarification for understanding column content.

count:
    label: Count
    type: number
    tooltip: Number of users in the group

In addition to providing a tooltip title, you can also specify the icon (available icons) and the placement (right, bottom, left, default value is top) of the tooltip.

count:
    label: Count
    type: number
    tooltip:
        title: Number of users in the group
        placement: bottom
        icon: icon-users