Interface RenderActivityFeedOptions<TItem>

Options accepted by renderActivityFeed.

interface RenderActivityFeedOptions<
    TItem extends ActivityFeedItem = ActivityFeedItem,
> {
    characters?: ActivityFeedCharacters;
    emptyText?: string;
    height: number;
    items: readonly TItem[];
    offset?: number;
    showTimestamp?: boolean;
    width: number;
}

Type Parameters

TItem extends ActivityFeedItem = ActivityFeedItem

Index

Properties

characters? emptyText? height items offset? showTimestamp? width

Properties

`Optional`characters

characters?: ActivityFeedCharacters

Character tokens used to communicate tone without color.

`Optional`emptyText

emptyText?: string

Text returned when items is empty.

height

height: number

Maximum rendered rows.

items

items: readonly TItem[]

Ordered activity events. Caller-owned data is never mutated.

`Optional`offset

offset?: number

First rendered event index.

`Optional`showTimestamp

showTimestamp?: boolean

Whether timestamps are rendered when present.

width

width: number

Maximum terminal-cell width of each row.