Skip to content

Commit

Permalink
feat(ts): document renderingContent (algolia/algoliasearch-helper-js#823
Browse files Browse the repository at this point in the history
)

* feat(ts): document renderingContent

Note: while the format will not change, it's not yet live

* Apply suggestions from code review

Co-authored-by: Clément Vannicatte <20689156+shortcuts@users.noreply.github.com>

Co-authored-by: Clément Vannicatte <20689156+shortcuts@users.noreply.github.com>
  • Loading branch information
Haroenv and shortcuts committed Jun 10, 2021
1 parent ed37d10 commit 298f8db
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions packages/algoliasearch-helper/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

0 comments on commit 298f8db

Please sign in to comment.