instantsearch.js 4.53.0 → 4.54.1

package/dist/instantsearch.production.d.ts

@@ -1774,6 +1774,9 @@ declare type HierarchicalMenuWidgetParams = {
 
 declare function Highlight<THit extends Hit<BaseHit>>({ hit, attribute, cssClasses, ...props }: HighlightProps<THit>): h.JSX.Element;
 
+/**
+ * @deprecated use html tagged templates and the Highlight component instead
+ */
 declare function highlight({ attribute, highlightedTagName, hit, cssClasses, }: HighlightOptions): string;
 
 declare type HighlightClassNames = HighlightClassNames_2;
@@ -2475,9 +2478,13 @@ declare type InstantSearchModule = {
     routers: typeof routers;
     stateMappings: typeof stateMappings;
     createInfiniteHitsSessionStorageCache: typeof createInfiniteHitsSessionStorageCache;
+    /** @deprecated use html tagged templates and the Highlight component instead */
     highlight: typeof helpers.highlight;
+    /** @deprecated use html tagged templates and the ReverseHighlight component instead */
     reverseHighlight: typeof helpers.reverseHighlight;
+    /** @deprecated use html tagged templates and the Snippet component instead */
     snippet: typeof helpers.snippet;
+    /** @deprecated use html tagged templates and the ReverseSnippet component instead */
     reverseSnippet: typeof helpers.reverseSnippet;
     /**
      * @deprecated use createInsightsMiddleware
@@ -3140,19 +3147,26 @@ declare type PaginationTemplates = Partial<{
     /**
      * Label for the Previous link.
      */
-    previous: string;
+    previous: Template;
     /**
      * Label for the Next link.
      */
-    next: string;
+    next: Template;
+    /**
+     * Label for the link of a certain page
+     * Page is one-based, so `page` will be `1` for the first page.
+     */
+    page: Template<{
+        page: number;
+    }>;
     /**
      * Label for the First link.
      */
-    first: string;
+    first: Template;
     /**
      * Label for the Last link.
      */
-    last: string;
+    last: Template;
 }>;
 
 declare type PaginationWidget = WidgetFactory<PaginationWidgetDescription & {
@@ -4459,6 +4473,9 @@ declare type RequiredWidgetType<TWidgetDescription extends WidgetDescription> =
 
 declare function ReverseHighlight<THit extends Hit<BaseHit>>({ hit, attribute, cssClasses, ...props }: ReverseHighlightProps<THit>): h.JSX.Element;
 
+/**
+ * @deprecated use html tagged templates and the ReverseHighlight component instead
+ */
 declare function reverseHighlight({ attribute, highlightedTagName, hit, cssClasses, }: ReverseHighlightOptions): string;
 
 declare type ReverseHighlightClassNames = HighlightClassNames_2;
@@ -4484,6 +4501,9 @@ declare type ReverseHighlightProps_2 = Omit<HighlightProps_3, 'classNames'> & {
 
 declare function ReverseSnippet<THit extends Hit<BaseHit>>({ hit, attribute, cssClasses, ...props }: ReverseSnippetProps<THit>): h.JSX.Element;
 
+/**
+ * @deprecated use html tagged templates and the ReverseSnippet component instead
+ */
 declare function reverseSnippet({ attribute, highlightedTagName, hit, cssClasses, }: ReverseSnippetOptions): string;
 
 declare type ReverseSnippetClassNames = HighlightClassNames_2;
@@ -4770,6 +4790,9 @@ declare function singleIndexStateMapping<TUiState extends UiState = UiState>(ind
 
 declare function Snippet<THit extends Hit<BaseHit>>({ hit, attribute, cssClasses, ...props }: SnippetProps<THit>): h.JSX.Element;
 
+/**
+ * @deprecated use html tagged templates and the Snippet component instead
+ */
 declare function snippet({ attribute, highlightedTagName, hit, cssClasses, }: SnippetOptions): string;
 
 declare type SnippetClassNames = HighlightClassNames_2;

package/dist/instantsearch.production.min.d.ts

@@ -1774,6 +1774,9 @@ declare type HierarchicalMenuWidgetParams = {
 
 declare function Highlight<THit extends Hit<BaseHit>>({ hit, attribute, cssClasses, ...props }: HighlightProps<THit>): h.JSX.Element;
 
+/**
+ * @deprecated use html tagged templates and the Highlight component instead
+ */
 declare function highlight({ attribute, highlightedTagName, hit, cssClasses, }: HighlightOptions): string;
 
 declare type HighlightClassNames = HighlightClassNames_2;
@@ -2475,9 +2478,13 @@ declare type InstantSearchModule = {
     routers: typeof routers;
     stateMappings: typeof stateMappings;
     createInfiniteHitsSessionStorageCache: typeof createInfiniteHitsSessionStorageCache;
+    /** @deprecated use html tagged templates and the Highlight component instead */
     highlight: typeof helpers.highlight;
+    /** @deprecated use html tagged templates and the ReverseHighlight component instead */
     reverseHighlight: typeof helpers.reverseHighlight;
+    /** @deprecated use html tagged templates and the Snippet component instead */
     snippet: typeof helpers.snippet;
+    /** @deprecated use html tagged templates and the ReverseSnippet component instead */
     reverseSnippet: typeof helpers.reverseSnippet;
     /**
      * @deprecated use createInsightsMiddleware
@@ -3140,19 +3147,26 @@ declare type PaginationTemplates = Partial<{
     /**
      * Label for the Previous link.
      */
-    previous: string;
+    previous: Template;
     /**
      * Label for the Next link.
      */
-    next: string;
+    next: Template;
+    /**
+     * Label for the link of a certain page
+     * Page is one-based, so `page` will be `1` for the first page.
+     */
+    page: Template<{
+        page: number;
+    }>;
     /**
      * Label for the First link.
      */
-    first: string;
+    first: Template;
     /**
      * Label for the Last link.
      */
-    last: string;
+    last: Template;
 }>;
 
 declare type PaginationWidget = WidgetFactory<PaginationWidgetDescription & {
@@ -4459,6 +4473,9 @@ declare type RequiredWidgetType<TWidgetDescription extends WidgetDescription> =
 
 declare function ReverseHighlight<THit extends Hit<BaseHit>>({ hit, attribute, cssClasses, ...props }: ReverseHighlightProps<THit>): h.JSX.Element;
 
+/**
+ * @deprecated use html tagged templates and the ReverseHighlight component instead
+ */
 declare function reverseHighlight({ attribute, highlightedTagName, hit, cssClasses, }: ReverseHighlightOptions): string;
 
 declare type ReverseHighlightClassNames = HighlightClassNames_2;
@@ -4484,6 +4501,9 @@ declare type ReverseHighlightProps_2 = Omit<HighlightProps_3, 'classNames'> & {
 
 declare function ReverseSnippet<THit extends Hit<BaseHit>>({ hit, attribute, cssClasses, ...props }: ReverseSnippetProps<THit>): h.JSX.Element;
 
+/**
+ * @deprecated use html tagged templates and the ReverseSnippet component instead
+ */
 declare function reverseSnippet({ attribute, highlightedTagName, hit, cssClasses, }: ReverseSnippetOptions): string;
 
 declare type ReverseSnippetClassNames = HighlightClassNames_2;
@@ -4770,6 +4790,9 @@ declare function singleIndexStateMapping<TUiState extends UiState = UiState>(ind
 
 declare function Snippet<THit extends Hit<BaseHit>>({ hit, attribute, cssClasses, ...props }: SnippetProps<THit>): h.JSX.Element;
 
+/**
+ * @deprecated use html tagged templates and the Snippet component instead
+ */
 declare function snippet({ attribute, highlightedTagName, hit, cssClasses, }: SnippetOptions): string;
 
 declare type SnippetClassNames = HighlightClassNames_2;