Creating Plot Twists
    Preparing search index...

    Type Alias LinkTypeConfig

    Describes a link type that a connector creates. Used for display in the UI (icons, labels).

    type LinkTypeConfig = {
        type: string;
        label: string;
        logo?: string;
        logoDark?: string;
        logoMono?: string;
        statuses?: {
            status: string;
            label: string;
            tag?: Tag;
            done?: boolean;
            todo?: boolean;
            createDefault?: boolean;
        }[];
        supportsAssignee?: boolean;
        defaultCreateThreads?: string;
    }
    Index

    Properties

    type label logo? logoDark? logoMono? statuses? supportsAssignee? defaultCreateThreads?

    Properties

    type: string

    Machine-readable type identifier (e.g., "issue", "pull_request")

    label: string

    Human-readable label (e.g., "Issue", "Pull Request")

    logo?: string

    URL to an icon for this link type (light mode). Prefer Iconify logos/* URLs.

    logoDark?: string

    URL to an icon for dark mode. Use when the default logo is invisible on dark backgrounds (e.g., Iconify simple-icons/* with ?color=).

    logoMono?: string

    URL to a monochrome icon (uses currentColor). Prefer Iconify simple-icons/* URLs without a ?color= param.

    statuses?: {
        status: string;
        label: string;
        tag?: Tag;
        done?: boolean;
        todo?: boolean;
        createDefault?: boolean;
    }[]

    Possible status values for this type

    Type Declaration

    • status: string

      Machine-readable status (e.g., "open", "done")

    • label: string

      Human-readable label (e.g., "Open", "Done")

    • Optionaltag?: Tag

      Tag to propagate to thread when this status is active (e.g., Tag.Done)

    • Optionaldone?: boolean

      Whether this status represents completion (done, closed, merged, cancelled, etc.)

    • Optionaltodo?: boolean

      Whether this status represents the connector's "to-do" / active state. When a user adds a thread to Plot's agenda, done-status links flip to the status marked todo: true (e.g., Gmail's "starred", Linear's "todo") so the link widget and thread tags reflect the active state. At most one status per type should set this.

    • OptionalcreateDefault?: boolean

      Default status applied when Plot asks the connector to create a new item of this type via Connector.onCreateLink. Declaring at least one status with createDefault: true is how a link type opts in to Plot-initiated creation. At most one status per type should set this.

    supportsAssignee?: boolean

    Whether this link type supports displaying and changing the assignee

    defaultCreateThreads?: string

    Default thread creation mode for this link type: 'all' | 'actionable' | 'manual'

    Settings

    Member Visibility

    On This Page

    Properties