@dxos/app-toolkit - v0.16.0
    Preparing search index...

    Type Alias ArticleData<Subject, Props, CompanionTo>

    ArticleData: {
        attendableId: string;
        extrinsic?: boolean;
        nodeId?: string;
        path?: string[];
        popoverAnchorId?: string;
        properties?: Record<string, any>;
        subject: Subject;
        variant?: string;
    } & (
        unknown extends CompanionTo
            ? { companionTo?: CompanionTo }
            : { companionTo: CompanionTo }
    ) & Props

    Surface data for article role (from PlankComponent).

    Type Parameters

    • Subject = unknown
    • Props extends {} = {}
    • CompanionTo = unknown

    Type declaration

    • attendableId: string
    • Optionalextrinsic?: boolean

      Set when the surface is sized by its container (e.g. a user-resized embed) rather than its intrinsic content, so the surface can fit its content to the box instead of sizing to it.

    • OptionalnodeId?: string

      The graph node this surface renders, which is what its contributed actions are filed under.

      Distinct from attendableId: a companion shares its host plank's attention id, so the two are the same for a primary plank and differ for a companion. A surface that reads its own actions from attendableId therefore renders the host's toolbar when it is a companion.

    • Optionalpath?: string[]
    • OptionalpopoverAnchorId?: string
    • Optionalproperties?: Record<string, any>
    • subject: Subject
    • Optionalvariant?: string

    Settings

    Member Visibility