Member Junction
    Preparing search index...

    Interface FKSuggestion

    Represents a suggestion item for FK autocomplete search results.

    interface FKSuggestion {
        Chips?: FKLookupChip[];
        DisplayName: string;
        ExtraColumns: FKSuggestionColumn[];
        GroupKey: string;
        HighlightedName: string;
        Icon: string | null;
        PrimaryKeyValue: unknown;
        Row?: FKLookupRow;
        Secondary?: string;
    }
    Index

    Properties

    Chips? DisplayName ExtraColumns GroupKey HighlightedName Icon PrimaryKeyValue Row? Secondary?

    Properties

    Chips?: FKLookupChip[]

    Small markers beside the name, e.g. "4 orders". Supplied by the lookup strategy.

    DisplayName: string

    The related entity's NameField value — the primary clickable label.

    ExtraColumns: FKSuggestionColumn[]

    Additional DefaultInView columns shown to the right of the name (multi-column rows).

    GroupKey: string

    Which FKLookupGroup this row belongs to. Rows render under their group's header, in group order. 'results' for the ungrouped default.

    HighlightedName: string

    DisplayName with the typed query substring wrapped in a highlight mark. Bound to [innerHTML].

    Icon: string | null

    Leading icon for this row — a FontAwesome class. Per-row when the related entity has an ExtendedType = 'Icon' field; otherwise the entity-level icon; null when neither exists.

    PrimaryKeyValue: unknown

    Primary-key value used as the FK value when selected.

    Row?: FKLookupRow

    The row the strategy returned, so FKLookupStrategy.BeforeSelect sees every value it supplied rather than a rebuilt key + name. Absent on the cached path, which has no strategy row.

    Secondary?: string

    Second line under the name, supplied by the lookup strategy to tell look-alikes apart — "Springfield, IL · northwind.example.org". Absent for the default strategy, which has nothing to add.

    Settings

    Member Visibility

    On This Page

    Properties