Activity message¶

Usage¶

Use activity messages to make multi-step AI activity transparent without exposing every internal event. Show one message for each user-relevant step or phase and arrange related messages in execution order.

• Use a concise label that describes the activity.
• Set state to running, completed, or failed to communicate its current status.
• Set icon to customize the completed activity marker. It defaults to element-record-filled.
• Project optional details such as Markdown, metadata, or tool output into the component. Users can expand and collapse this content from the activity header.
• Use expanded to control the initial disclosure state or to synchronize it with application state.

Avoid using activity messages for low-level implementation details that do not help users understand the AI's progress or result.

Activity trace¶

Use si-activity-trace to group multiple related activity messages under a shared, collapsible heading.

Activity message¶

Use si-activity-message for an individual activity. It has a heading, an optional icon, and collapsible content, and can communicate running and failed states. Content can be added directly or organized into parts.

Activity messages can be used without a trace. They can also contain other activity messages when a step has its own intermediate activities.

Activity message part¶

Use si-activity-message-part to divide an activity into multiple titled parts, such as input and output. Parts are optional and can be made collapsible independently.

When parts are used, provide at least two so that the subdivision adds meaningful structure.

Code¶

SiActivityTraceComponent API Documentation¶

Collapsible container for grouping multiple activity messages.

Input Properties¶

Name	Type	Default	Description
expanded ¶	boolean	false	Whether the trace content is expanded.
heading ¶	TranslatableString		Trace heading.

Output Properties¶

SiActivityMessageComponent API Documentation¶

Collapsible activity message for displaying progress and intermediate steps in a chat.

Input Properties¶

Name	Type	Default	Description
expanded ¶	boolean	false	Whether the activity details are expanded.
heading ¶	TranslatableString		Activity heading.
icon ¶	string		Activity icon.
state ¶	("failed" | "running")		Current state of the activity.

Output Properties¶

SiActivityMessagePartComponent API Documentation¶

Titled content part for use inside an activity message.

Input Properties¶

Name	Type	Default	Description
collapsible ¶	boolean	false	Whether the part can be collapsed and expanded.
expanded ¶	boolean	true	Whether collapsible content is expanded.
heading ¶	TranslatableString		Part heading.

Output Properties¶