Interface ResultListInput

Configures the result list's content.

interface ResultListInput {
    columns: ResultColumn[];
    data: BaseFeature<Readonly<Record<string, unknown>>>[];
    formatOptions?: FormatOptions;
    labelProperty?: string;
}

Properties

Configures the columns shown by the result list.

data: BaseFeature<Readonly<Record<string, unknown>>>[]

The data shown by the result list component. Every feature will be rendered as an individual row.

formatOptions?: FormatOptions

Optional formatOptions to specify the numberOptions for number type values and dateOptions to specify the format of date type values

labelProperty?: string

Property of the features in the result list that is used to enrich aria labels with context.

The feature's id is used by default or as fallback if this option is not configured or the property does not exist on the feature.