Member Junction
    Preparing search index...

    Interface MentionSuggestion

    One item in a mention-autocomplete list, and the payload an inserted mention carries.

    type is an open string so a host can add its own vocabulary; the shipped producers use 'agent' | 'user' | 'entity' | 'query' | 'skill'. Renderers use it only for cosmetics (chip palette, badge label) and for the plain-text serialization prefix.

    interface MentionSuggestion {
        color?: string;
        data?: Record<string, unknown>;
        description?: string;
        displayName: string;
        icon?: string;
        id: string;
        imageUrl?: string;
        name: string;
        presets?: MentionSuggestionPreset[];
        type: string;
    }
    Index

    Properties

    color? data? description? displayName icon? id imageUrl? name presets? type

    Properties

    color?: string

    Accent colour for the chip/badge (e.g. a skill's own Color metadata).

    data?: Record<string, unknown>

    Producer-defined extra payload; renderers never inspect it.

    description?: string

    Secondary line — an agent's description, a user's email.

    displayName: string

    Name as shown to a person.

    icon?: string

    Font Awesome (or custom) icon class for the row and the chip.

    id: string

    Record id the mention resolves to.

    imageUrl?: string

    Image for the row and the chip (e.g. an agent's LogoURL).

    name: string

    Machine name.

    presets?: MentionSuggestionPreset[]

    Optional presets — 2+ presets warrant a preset picker on the inserted chip.

    type: string

    Open discriminator chosen by the producer.

    Settings

    Member Visibility

    On This Page

    Properties