HistoryEntries

type

The type should correspond to a valid HistoryEntryType, such as

• CUSTOMER_REGISTERED
• ORDER_STATE_TRANSITION
• some custom type - see the HistoryService docs for a guide on how to define custom history entry types.

component

The component which is used to render the timeline entry. It should use the HistoryEntry component and pass the appropriate props to configure how it will be displayed.

The entity prop will be a subset of the Order object for Order history entries, or a subset of the Customer object for customer history entries.

id

type

The HistoryEntryType, such as ORDER_STATE_TRANSITION.

createdAt

isPublic

Whether this entry is visible to customers via the Shop API

administrator

If an Administrator created this entry, their details will be available here.

data

The entry payload data. This will be an object, which is different for each type of history entry.

For example, the CUSTOMER_ADDED_TO_GROUP data looks like this:

{  groupName: 'Some Group',}

and the ORDER_STATE_TRANSITION data looks like this:

{  from: 'ArrangingPayment',  to: 'PaymentSettled',}

entry

The entry itself, which will get passed down to your custom component

title

The title of the entry

timelineIcon

An icon which is used to represent the entry. Note that this will only display if isPrimary is true.

timelineIconClassName

Optional tailwind classes to apply to the icon. Prefer the subtle tone slots so the timeline reads as a calm status surface rather than a row of full-strength fills. For instance

const success = 'bg-success-subtle text-success-subtle-foreground';const destructive = 'bg-destructive-subtle text-destructive-subtle-foreground';

actorName

The name to display of "who did the action". For instance:

const getActorName = (entry: HistoryEntryItem) => {    if (entry.administrator) {        return `${entry.administrator.firstName} ${entry.administrator.lastName}`;    } else if (entity?.customer) {        return `${entity.customer.firstName} ${entity.customer.lastName}`;    }    return '';};

children

isPrimary

When set to true, the timeline entry will feature the specified icon and will not be collapsible.