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

    Function makeDeckCompanion

    • Build a deck-level (workspace-wide) companion panel node, returned from a root extension with companion.

      Type Parameters

      • TData = any

      Parameters

      • __namedParameters: {
            badge?: Atom<undefined | number>;
            data: TData;
            icon: string;
            id: string;
            joyride?: string;
            label:
                | string
                | [
                    string,
                    { count?: number; defaultValue?: string; ns: string
                    | readonly string[] },
                ];
            mount?: DeckCompanionMount;
            position?: number;
        }
        • Optionalbadge?: Atom<undefined | number>

          Count shown on the companion's rail tab while greater than zero (e.g. unread items).

        • data: TData
        • icon: string
        • id: string
        • Optionaljoyride?: string
        • label:
              | string
              | [
                  string,
                  { count?: number; defaultValue?: string; ns: string
                  | readonly string[] },
              ]
        • Optionalmount?: DeckCompanionMount
        • Optionalposition?: number

      Returns NodeArg<TData>