Skip to main content
Keel Docs Showcase

Statuses: chips and Open / Closed tabs

What it does

A list with a status field (a select field such as New / In progress / Closed) shows each item's status as a coloured label. It gets status chips to filter by status, and Open / Closed tabs when some statuses count as closed. Editors' view: Lists → Statuses.

Keel does this automatically. It recognises what a status means from its value or label, in English, Croatian and German:

MeaningBuilt-in words (examples)ColourCounts as closed
new / opennew, open, novo, otvoreno, neublue #2563ebno
in progressin progress, pending, u obradi, na čekanju, in Bearbeitungcyan #0891b2no
done / closeddone, closed, resolved, zatvoreno, riješeno, erledigt, sold, sold out, prodano, rasprodano, verkauft, ausgebucht, rented, iznajmljeno, vermietetgrey #52525byes
rejected / cancelledrejected, cancelled, storno, odbijeno, otkazano, abgelehntrose #e11d48yes
anything else–the next colour of palette, in option orderno

A word matches the whole value or label, ignoring case, accents and punctuation (sold-out matches sold out, not sold; both are built in and count as closed).

When no status counts as closed, the list has chips but no tabs.

Which field is the status field

The first of these that exists:

  1. The admin's choice in Customize → Statuses (None means no status field)
  2. collections.<list-key>.status_field in keel.yaml
  3. The class's assignments.classes.<Class>.status_field
  4. A select field that a Pimcore workflow keeps its place in (Workflows)
  5. A select field named status

Options

KeyDefaultWhat it does
collections.<list-key>.status_fieldautomaticThe select field of that list (see above)
statuses.colors.new#2563ebColour of new / open statuses
statuses.colors.progress#0891b2Colour of in-progress statuses
statuses.colors.closed#52525bColour of done / closed statuses
statuses.colors.rejected#e11d48Colour of rejected / cancelled statuses
statuses.palette['#059669', '#4f46e5', '#0d9488', '#475569', '#65a30d']Colours for statuses without a meaning, in option order (1–20 colours)
statuses.words.new[]Your own words meaning new / open
statuses.words.progress[]Your own words meaning in progress
statuses.words.closed[]Your own words meaning done / closed (these move to the closed tab)
statuses.words.rejected[]Your own words meaning rejected (also closed)

Your words are added to the built-in ones. Colours are written as #rrggbb. Give the light theme colour: Keel works out the dark theme shade and a readable text colour itself.

Example

yaml
keel:
    collections:
        property: { status_field: status }
    statuses:
        colors:
            new: '#0e7490'
        words:
            new: [available]
            progress: [reserved, few seats left]
            closed: [archived, sold out]

With this, a property Reserved is cyan and stays in the Open tab; Archived moves to the closed tab.

keel:setup --check warns when a status_field is not a select field of the class.

What admins change in Customize

Customize → 3 · Statuses, per list: the status field, the colour of each status, and which statuses count as closed. More

  • The admin's choice for a list wins over keel.yaml. Lists the admin has not changed follow keel.yaml, also after you change it.
  • A keel.yaml colour that is not one of Customize's swatches shows there as Own colour.
  • Reset to automatic (in the Statuses step) brings the list back to the colours and closed statuses that follow from keel.yaml.

Changing a status from Keel

Editors can change a status from the list (click the pill), in the editor and in bulk. All three save the item like a normal save (new version; status log and activity on lists with assignments). They need the save right, and on a published item the publish right too. In the editor, a published item saved without the publish right is stored as a version only.

A field that a Pimcore workflow uses as its marking field cannot be set directly – not in the editor, not with Set field…. It changes only through the workflow's steps, which Keel runs in the editor, from the pill and in bulk (Workflow steps).