feat(ts): document renderingContent (#823)

* 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 <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia · Jun 10, 2021 · 7b176a7 · 7b176a7
1 parent 52939cd
commit 7b176a7
Showing 1 changed file with 39 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -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`.