Function: progressList()

function progressList(props: UiProgressListProps): Element;

Defined in: src/UI/blocks/progressList.tsx:41

Parameters

Parameter	Type	Description
props	UiProgressListProps	Configuration object

Returns

Element

Deprecated

Use the equivalent block from @matterway/sdk/UI instead. This block targets the old showUI path and will be removed when src/UI/ is dropped.

Progress list component for displaying multiple status messages with different types.

Examples

Basic usage

progressList({
 items: [
   { label: 'Data fetched successfully.', value: 'done' },
   { label: 'Data sorting', value: 'failed' },
   { label: 'Data filtering', value: 'in-progress' },
 ],
});

Usage with optional sub label

progressList({
 items: [
   { label: 'Data fetched successfully.', value: 'done' },
   { label: 'Data sorting', value: 'failed' },
   { label: 'Data filtering', value: 'in-progress', subLabel: '7/10' },
 ],
});