Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

feat(ts): document renderingContent #823

Merged
merged 2 commits into from Jun 10, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 39 additions & 0 deletions index.d.ts
Expand Up @@ -1234,6 +1234,45 @@ declare namespace algoliasearchHelper {
*/
userData: any[];

/**
* Content defining how the search interface should be rendered.
* This is set via the settings for a default value and can be overridden via rules
*/
renderingContent?: {
/**
* defining how facets should be ordered
*/
facetOrdering?: {
/**
* the ordering of facets (widgets)
*/
facet?: {
/**
* Ordered facet lists
*/
order: string[];
};
/**
* the ordering of facet values, within an individual list
*/
values?: {
[facet: string]: {
/**
* Ordered facet values
*/
order: string[];
/**
* How to display the remaining items.
* - facet count (descending)
* - alphabetical (ascending)
* - hidden (show only pinned values)
*/
sortRemainingBy: 'count' | 'alpha' | 'hidden';
};
};
};
};

/**
* queryID is the unique identifier of the query used to generate the current search results.
* This value is only available if the `clickAnalytics` search parameter is set to `true`.
Expand Down