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

    Type Alias ForTypeOptions<S>

    type ForTypeOptions<S extends Type.AnyObj> = {
        getLabel?: (object: Type.InstanceType<S>) => string;
        getPath: (target: { objectId: string; spaceId: SpaceId }) => string;
        pages?: readonly NavigationTarget[];
        position?: Position.Position;
    }

    Type Parameters

    • S extends Type.AnyObj
    Index

    Properties

    getLabel? getPath pages? position?

    Properties

    getLabel?: (object: Type.InstanceType<S>) => string

    Target label; defaults to the object's entity label.

    getPath: (target: { objectId: string; spaceId: SpaceId }) => string

    Where the plugin's section shows the object — the resolved target's path.

    pages?: readonly NavigationTarget[]

    Targets answered for a query-less call (the navigable-pages listing), e.g. a settings section.

    position?: Position.Position

    Sort order among the targets resolved for one query — e.g. Position.first when the section is the type's home and outranks the generic collection/database answers.

    Settings

    Member Visibility

    On This Page

    Properties