Skip to main content

CnTimelineWidget

An object's dated events in time order, on a detail page. Place it with the timeline widget type.

{
  "type": "timeline",
  "content": {
    "title": "Timeline",
    "fields": [
      { "field": "@self.created", "label": "Booking created" },
      { "field": "depositClearedAt", "label": "Deposit cleared" },
      { "field": "confirmationSentAt", "label": "Confirmation mail sent" },
      { "field": "startsAt", "label": "Starts" },
      { "field": "endsAt", "label": "Ends" }
    ],
    "related": [
      { "schema": "payment", "field": "booking", "label": "Payment received", "titleField": "amount" }
    ],
    "auditTrail": true
  }
}

Sources​

All five are optional and end up in one list.

KeyWhat it adds
fieldsThe object's date properties, [{ field, label }]. A dotted path reaches metadata, such as @self.created. A field without a date adds nothing.
relatedRelated objects, [{ schema, field, register?, dateField?, label, titleField?, limit? }]. Rows of schema whose field holds this object's id, each dated by dateField (default @self.created). titleField becomes the line under the label.
auditTrailtrue adds the object's audit trail: "Updated by Ruben".
listsA list held on the object, [{ field, dateField, labelField?, label?, detailField? }], such as a status history. Each entry with a date at dateField becomes one event, labelled by its labelField value (else label), with detailField as the line under it.
timelinetrue adds OpenRegister's timeline of notes, calls and messages.

order: "desc" lists newest first; the default is oldest first.

Props​

PropTypeDefaultDescription
objectObjectnullThe object whose events the widget shows.
titleString''Card title override.
contentObject{}Stored widget content: { title, fields, related, auditTrail, timeline, order }.
apiBaseString'/apps/openregister/api'OpenRegister API base the widget reads related objects, the audit trail and the timeline from.

Behaviour​

  • Labels are authored in English and pass through the app's translation.
  • A calendar date shows as a date, a moment as date and time, in the reader's language.
  • A moment after now shows a hollow dot and the word "Upcoming".
  • Each source loads on its own. When one fails, a warning names it and the rest still show.
  • With no dated facts the widget says "Nothing has happened yet."

The object comes from the detail page, as for audit-trail: explicit register, schema, objectId and object props win, then the page's object context, then content. When only the id is known, the widget fetches the object.