Interface LandingSearchByAttributeItemsOptions

interface LandingSearchByAttributeItemsOptions {
    attributeName: string;
    catalogApi: Pick<CatalogApi<unknown, unknown, unknown>, "listAttributes">;
    maxItemsPerGroup?: number;
    nameForItem?: ((key, t) => string);
    nameForItemGroup?: ((groupName, t) => string);
    tagSearchRoute: string;
}

Properties

attributeName catalogApi maxItemsPerGroup? nameForItem? nameForItemGroup? tagSearchRoute

Properties

attributeName

attributeName: string

Name of the attribute to list out the items/groups for

catalogApi

catalogApi: Pick<CatalogApi<unknown, unknown, unknown>, "listAttributes">

Catalog API

Optional maxItemsPerGroup

maxItemsPerGroup?: number

Max items to show per group (default: 10)

Optional nameForItem

nameForItem?: ((key, t) => string)

Name function for items. Use for translating attribute item keys.

By default, this will use translations located at Geekle:skills.<key>, but this behavior is deprecated. Please provide a custom function.

Type declaration

    • (key, t): string

    • Name function for items. Use for translating attribute item keys.

      By default, this will use translations located at Geekle:skills.<key>, but this behavior is deprecated. Please provide a custom function.

      Parameters

      • key: string
      • t: TFunction<"translation", undefined>

      Returns string

Optional nameForItemGroup

nameForItemGroup?: ((groupName, t) => string)

Name function for item groups. Use for translating attribute group names.

If an an item has no group, this will be passed the value 'fallbackGroupName',

By default, this will use translations located at Geekle:skillGroups.<groupName>, but this behavior is deprecated. Please provide a custom function.

Type declaration

    • (groupName, t): string

    • Name function for item groups. Use for translating attribute group names.

      If an an item has no group, this will be passed the value 'fallbackGroupName',

      By default, this will use translations located at Geekle:skillGroups.<groupName>, but this behavior is deprecated. Please provide a custom function.

      Parameters

      • groupName: string
      • t: TFunction<"translation", undefined>

      Returns string

tagSearchRoute

tagSearchRoute: string

Route to navigate to in order to search for a tag. Query parameter filters={attributeName}.{groupName}.{item.key} will be appended.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc