instantsearch.js 4.50.0 → 4.50.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/connectors/infinite-hits/connectInfiniteHits.js +8 -1
- package/cjs/lib/templating/prepareTemplateProps.js +1 -2
- package/cjs/lib/version.js +1 -1
- package/cjs/widgets/hits/hits.js +3 -4
- package/cjs/widgets/index/index.js +3 -0
- package/cjs/widgets/infinite-hits/infinite-hits.js +3 -4
- package/dist/instantsearch.development.d.ts +2 -1
- package/dist/instantsearch.development.js +36 -19
- package/dist/instantsearch.development.js.map +1 -1
- package/dist/instantsearch.production.d.ts +2 -1
- package/dist/instantsearch.production.min.d.ts +2 -1
- package/dist/instantsearch.production.min.js +2 -2
- package/dist/instantsearch.production.min.js.map +1 -1
- package/es/components/Answers/Answers.d.ts +3 -3
- package/es/components/Breadcrumb/Breadcrumb.d.ts +3 -3
- package/es/components/ClearRefinements/ClearRefinements.d.ts +3 -3
- package/es/components/CurrentRefinements/CurrentRefinements.d.ts +2 -2
- package/es/components/GeoSearchControls/GeoSearchButton.d.ts +1 -1
- package/es/components/GeoSearchControls/GeoSearchControls.d.ts +1 -1
- package/es/components/GeoSearchControls/GeoSearchToggle.d.ts +1 -1
- package/es/components/Highlight/Highlight.d.ts +2 -2
- package/es/components/Hits/Hits.d.ts +3 -3
- package/es/components/InfiniteHits/InfiniteHits.d.ts +3 -3
- package/es/components/MenuSelect/MenuSelect.d.ts +4 -4
- package/es/components/Pagination/Pagination.d.ts +3 -3
- package/es/components/Panel/Panel.d.ts +3 -3
- package/es/components/PoweredBy/PoweredBy.d.ts +2 -2
- package/es/components/QueryRuleCustomData/QueryRuleCustomData.d.ts +3 -3
- package/es/components/RangeInput/RangeInput.d.ts +3 -3
- package/es/components/RefinementList/RefinementList.d.ts +7 -7
- package/es/components/RefinementList/RefinementListItem.d.ts +1 -1
- package/es/components/RelevantSort/RelevantSort.d.ts +3 -3
- package/es/components/ReverseHighlight/ReverseHighlight.d.ts +2 -2
- package/es/components/ReverseSnippet/ReverseSnippet.d.ts +2 -2
- package/es/components/SearchBox/SearchBox.d.ts +5 -5
- package/es/components/Selector/Selector.d.ts +3 -3
- package/es/components/Slider/Rheostat.d.ts +6 -6
- package/es/components/Slider/Slider.d.ts +2 -2
- package/es/components/Snippet/Snippet.d.ts +2 -2
- package/es/components/Stats/Stats.d.ts +3 -3
- package/es/components/Template/Template.d.ts +1 -1
- package/es/components/ToggleRefinement/ToggleRefinement.d.ts +3 -3
- package/es/components/VoiceSearch/VoiceSearch.d.ts +3 -3
- package/es/connectors/answers/connectAnswers.d.ts +4 -4
- package/es/connectors/autocomplete/connectAutocomplete.d.ts +4 -4
- package/es/connectors/breadcrumb/connectBreadcrumb.d.ts +5 -5
- package/es/connectors/clear-refinements/connectClearRefinements.d.ts +4 -4
- package/es/connectors/configure/connectConfigure.d.ts +5 -5
- package/es/connectors/configure-related-items/connectConfigureRelatedItems.d.ts +5 -5
- package/es/connectors/current-refinements/connectCurrentRefinements.d.ts +6 -6
- package/es/connectors/dynamic-widgets/connectDynamicWidgets.d.ts +4 -4
- package/es/connectors/geo-search/connectGeoSearch.d.ts +6 -6
- package/es/connectors/hierarchical-menu/connectHierarchicalMenu.d.ts +5 -5
- package/es/connectors/hits/connectHits.d.ts +4 -4
- package/es/connectors/hits-per-page/connectHitsPerPage.d.ts +6 -6
- package/es/connectors/infinite-hits/connectInfiniteHits.d.ts +8 -8
- package/es/connectors/infinite-hits/connectInfiniteHits.js +8 -1
- package/es/connectors/menu/connectMenu.d.ts +5 -5
- package/es/connectors/numeric-menu/connectNumericMenu.d.ts +6 -6
- package/es/connectors/pagination/connectPagination.d.ts +4 -4
- package/es/connectors/powered-by/connectPoweredBy.d.ts +4 -4
- package/es/connectors/query-rules/connectQueryRules.d.ts +7 -7
- package/es/connectors/range/connectRange.d.ts +8 -8
- package/es/connectors/rating-menu/connectRatingMenu.d.ts +6 -6
- package/es/connectors/refinement-list/connectRefinementList.d.ts +5 -5
- package/es/connectors/relevant-sort/connectRelevantSort.d.ts +5 -5
- package/es/connectors/search-box/connectSearchBox.d.ts +4 -4
- package/es/connectors/sort-by/connectSortBy.d.ts +5 -5
- package/es/connectors/stats/connectStats.d.ts +4 -4
- package/es/connectors/toggle-refinement/connectToggleRefinement.d.ts +9 -9
- package/es/connectors/toggle-refinement/types.d.ts +5 -5
- package/es/connectors/voice-search/connectVoiceSearch.d.ts +4 -4
- package/es/helpers/components/Highlight.d.ts +1 -1
- package/es/helpers/components/ReverseHighlight.d.ts +1 -1
- package/es/helpers/components/ReverseSnippet.d.ts +1 -1
- package/es/helpers/components/Snippet.d.ts +1 -1
- package/es/helpers/highlight.d.ts +1 -1
- package/es/helpers/reverseHighlight.d.ts +1 -1
- package/es/helpers/reverseSnippet.d.ts +1 -1
- package/es/helpers/snippet.d.ts +1 -1
- package/es/index.d.ts +1 -1
- package/es/lib/InstantSearch.d.ts +3 -3
- package/es/lib/createHelpers.d.ts +1 -1
- package/es/lib/insights/listener.d.ts +1 -1
- package/es/lib/routers/history.d.ts +3 -3
- package/es/lib/suit.d.ts +2 -2
- package/es/lib/templating/prepareTemplateProps.d.ts +2 -2
- package/es/lib/templating/prepareTemplateProps.js +1 -2
- package/es/lib/utils/checkIndexUiState.d.ts +1 -1
- package/es/lib/utils/createConcurrentSafePromise.d.ts +2 -2
- package/es/lib/utils/createSendEventForFacet.d.ts +4 -4
- package/es/lib/utils/createSendEventForHits.d.ts +6 -6
- package/es/lib/utils/debounce.d.ts +2 -2
- package/es/lib/utils/defer.d.ts +2 -2
- package/es/lib/utils/documentation.d.ts +2 -2
- package/es/lib/utils/escapeFacetValue.d.ts +1 -1
- package/es/lib/utils/geo-search.d.ts +1 -1
- package/es/lib/utils/getRefinements.d.ts +6 -6
- package/es/lib/utils/logger.d.ts +2 -2
- package/es/lib/utils/range.d.ts +1 -1
- package/es/lib/utils/safelyRunOnBrowser.d.ts +2 -2
- package/es/lib/utils/toArray.d.ts +1 -1
- package/es/lib/version.d.ts +1 -1
- package/es/lib/version.js +1 -1
- package/es/lib/voiceSearchHelper/types.d.ts +5 -5
- package/es/middlewares/createInsightsMiddleware.d.ts +3 -3
- package/es/middlewares/createRouterMiddleware.d.ts +1 -1
- package/es/types/component.d.ts +1 -1
- package/es/types/connector.d.ts +4 -4
- package/es/types/insights.d.ts +5 -5
- package/es/types/middleware.d.ts +4 -4
- package/es/types/render-state.d.ts +5 -5
- package/es/types/results.d.ts +16 -16
- package/es/types/router.d.ts +2 -2
- package/es/types/templates.d.ts +5 -5
- package/es/types/ui-state.d.ts +4 -4
- package/es/types/utils.d.ts +6 -6
- package/es/types/widget-factory.d.ts +2 -2
- package/es/types/widget.d.ts +23 -23
- package/es/widgets/analytics/analytics.d.ts +4 -4
- package/es/widgets/answers/answers.d.ts +4 -4
- package/es/widgets/breadcrumb/breadcrumb.d.ts +4 -4
- package/es/widgets/clear-refinements/clear-refinements.d.ts +4 -4
- package/es/widgets/configure/configure.d.ts +2 -2
- package/es/widgets/configure-related-items/configure-related-items.d.ts +2 -2
- package/es/widgets/current-refinements/current-refinements.d.ts +3 -3
- package/es/widgets/dynamic-widgets/dynamic-widgets.d.ts +2 -2
- package/es/widgets/geo-search/createHTMLMarker.d.ts +1 -1
- package/es/widgets/geo-search/geo-search.d.ts +7 -7
- package/es/widgets/hierarchical-menu/hierarchical-menu.d.ts +6 -6
- package/es/widgets/hits/hits.d.ts +4 -4
- package/es/widgets/hits/hits.js +3 -4
- package/es/widgets/hits-per-page/hits-per-page.d.ts +3 -3
- package/es/widgets/index/index.d.ts +6 -5
- package/es/widgets/index/index.js +3 -0
- package/es/widgets/infinite-hits/infinite-hits.d.ts +4 -4
- package/es/widgets/infinite-hits/infinite-hits.js +3 -4
- package/es/widgets/menu/menu.d.ts +6 -6
- package/es/widgets/menu-select/menu-select.d.ts +4 -4
- package/es/widgets/numeric-menu/numeric-menu.d.ts +6 -6
- package/es/widgets/pagination/pagination.d.ts +4 -4
- package/es/widgets/panel/panel.d.ts +9 -9
- package/es/widgets/places/places.d.ts +6 -6
- package/es/widgets/powered-by/powered-by.d.ts +3 -3
- package/es/widgets/query-rule-context/query-rule-context.d.ts +2 -2
- package/es/widgets/query-rule-custom-data/query-rule-custom-data.d.ts +4 -4
- package/es/widgets/range-input/range-input.d.ts +4 -4
- package/es/widgets/range-slider/range-slider.d.ts +4 -4
- package/es/widgets/rating-menu/rating-menu.d.ts +6 -6
- package/es/widgets/refinement-list/refinement-list.d.ts +10 -10
- package/es/widgets/relevant-sort/relevant-sort.d.ts +4 -4
- package/es/widgets/search-box/search-box.d.ts +4 -4
- package/es/widgets/sort-by/sort-by.d.ts +4 -4
- package/es/widgets/stats/stats.d.ts +5 -5
- package/es/widgets/toggle-refinement/toggle-refinement.d.ts +4 -4
- package/es/widgets/voice-search/voice-search.d.ts +5 -5
- package/package.json +6 -5
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
import { h } from 'preact';
|
|
3
3
|
import type { AnswersCSSClasses, AnswersTemplates } from '../../widgets/answers/answers';
|
|
4
4
|
import type { ComponentCSSClasses, Hit } from '../../types';
|
|
5
|
-
export
|
|
6
|
-
export
|
|
7
|
-
export
|
|
5
|
+
export type AnswersComponentCSSClasses = ComponentCSSClasses<AnswersCSSClasses>;
|
|
6
|
+
export type AnswersComponentTemplates = Required<AnswersTemplates>;
|
|
7
|
+
export type AnswersProps = {
|
|
8
8
|
hits: Hit[];
|
|
9
9
|
isLoading: boolean;
|
|
10
10
|
cssClasses: AnswersComponentCSSClasses;
|
|
@@ -4,9 +4,9 @@ import type { BreadcrumbCSSClasses, BreadcrumbTemplates } from '../../widgets/br
|
|
|
4
4
|
import type { ComponentCSSClasses } from '../../types';
|
|
5
5
|
import type { PreparedTemplateProps } from '../../lib/templating';
|
|
6
6
|
import type { BreadcrumbConnectorParamsItem } from '../../connectors/breadcrumb/connectBreadcrumb';
|
|
7
|
-
export
|
|
8
|
-
export
|
|
9
|
-
export
|
|
7
|
+
export type BreadcrumbComponentCSSClasses = ComponentCSSClasses<BreadcrumbCSSClasses>;
|
|
8
|
+
export type BreadcrumbComponentTemplates = Required<BreadcrumbTemplates>;
|
|
9
|
+
export type BreadcrumbProps = {
|
|
10
10
|
items: BreadcrumbConnectorParamsItem[];
|
|
11
11
|
cssClasses: BreadcrumbComponentCSSClasses;
|
|
12
12
|
templateProps: PreparedTemplateProps<BreadcrumbComponentTemplates>;
|
|
@@ -4,9 +4,9 @@ import type { ClearRefinementsRenderState } from '../../connectors/clear-refinem
|
|
|
4
4
|
import type { ClearRefinementsCSSClasses, ClearRefinementsTemplates } from '../../widgets/clear-refinements/clear-refinements';
|
|
5
5
|
import type { ComponentCSSClasses } from '../../types';
|
|
6
6
|
import type { PreparedTemplateProps } from '../../lib/templating';
|
|
7
|
-
export
|
|
8
|
-
export
|
|
9
|
-
export
|
|
7
|
+
export type ClearRefinementsComponentCSSClasses = ComponentCSSClasses<ClearRefinementsCSSClasses>;
|
|
8
|
+
export type ClearRefinementsComponentTemplates = Required<ClearRefinementsTemplates>;
|
|
9
|
+
export type ClearRefinementsProps = {
|
|
10
10
|
refine: ClearRefinementsRenderState['refine'];
|
|
11
11
|
cssClasses: ClearRefinementsComponentCSSClasses;
|
|
12
12
|
hasRefinements: ClearRefinementsRenderState['hasRefinements'];
|
|
@@ -3,8 +3,8 @@ import { h } from 'preact';
|
|
|
3
3
|
import type { CurrentRefinementsConnectorParamsItem } from '../../connectors/current-refinements/connectCurrentRefinements';
|
|
4
4
|
import type { CurrentRefinementsCSSClasses } from '../../widgets/current-refinements/current-refinements';
|
|
5
5
|
import type { ComponentCSSClasses } from '../../types';
|
|
6
|
-
export
|
|
7
|
-
export
|
|
6
|
+
export type CurrentRefinementsComponentCSSClasses = ComponentCSSClasses<CurrentRefinementsCSSClasses>;
|
|
7
|
+
export type CurrentRefinementsProps = {
|
|
8
8
|
items: CurrentRefinementsConnectorParamsItem[];
|
|
9
9
|
cssClasses: CurrentRefinementsComponentCSSClasses;
|
|
10
10
|
canRefine: boolean;
|
|
@@ -3,7 +3,7 @@ import { h } from 'preact';
|
|
|
3
3
|
import type { GeoSearchCSSClasses, GeoSearchTemplates } from '../../widgets/geo-search/geo-search';
|
|
4
4
|
import type { ComponentCSSClasses } from '../../types';
|
|
5
5
|
import type { PreparedTemplateProps } from '../../lib/templating';
|
|
6
|
-
|
|
6
|
+
type Props = {
|
|
7
7
|
cssClasses: ComponentCSSClasses<GeoSearchCSSClasses>;
|
|
8
8
|
enableRefine: boolean;
|
|
9
9
|
enableRefineControl: boolean;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { h } from 'preact';
|
|
2
2
|
import type { HighlightProps as InternalHighlightProps, HighlightClassNames as InternalHighlightClassNames } from '@algolia/ui-components-highlight-vdom';
|
|
3
|
-
export
|
|
4
|
-
export
|
|
3
|
+
export type HighlightClassNames = InternalHighlightClassNames;
|
|
4
|
+
export type HighlightProps = Omit<InternalHighlightProps, 'classNames'> & {
|
|
5
5
|
classNames?: Partial<HighlightClassNames>;
|
|
6
6
|
};
|
|
7
7
|
export declare function Highlight({ classNames, ...props }: HighlightProps): h.JSX.Element;
|
|
@@ -5,9 +5,9 @@ import type { BindEventForHits, SendEventForHits } from '../../lib/utils';
|
|
|
5
5
|
import type { PreparedTemplateProps } from '../../lib/templating';
|
|
6
6
|
import type { ComponentCSSClasses, Hit } from '../../types';
|
|
7
7
|
import type { HitsCSSClasses, HitsTemplates } from '../../widgets/hits/hits';
|
|
8
|
-
export
|
|
9
|
-
export
|
|
10
|
-
export
|
|
8
|
+
export type HitsComponentCSSClasses = ComponentCSSClasses<HitsCSSClasses>;
|
|
9
|
+
export type HitsComponentTemplates = Required<HitsTemplates>;
|
|
10
|
+
export type HitsProps = {
|
|
11
11
|
results: SearchResults;
|
|
12
12
|
hits: Hit[];
|
|
13
13
|
sendEvent?: SendEventForHits;
|
|
@@ -4,9 +4,9 @@ import type { SearchResults } from 'algoliasearch-helper';
|
|
|
4
4
|
import type { ComponentCSSClasses, Hit } from '../../types';
|
|
5
5
|
import type { InfiniteHitsCSSClasses, InfiniteHitsTemplates } from '../../widgets/infinite-hits/infinite-hits';
|
|
6
6
|
import type { SendEventForHits, BindEventForHits } from '../../lib/utils';
|
|
7
|
-
export
|
|
8
|
-
export
|
|
9
|
-
export
|
|
7
|
+
export type InfiniteHitsComponentCSSClasses = ComponentCSSClasses<InfiniteHitsCSSClasses>;
|
|
8
|
+
export type InfiniteHitsComponentTemplates = Required<InfiniteHitsTemplates>;
|
|
9
|
+
export type InfiniteHitsProps = {
|
|
10
10
|
cssClasses: InfiniteHitsComponentCSSClasses;
|
|
11
11
|
hits: Hit[];
|
|
12
12
|
results: SearchResults;
|
|
@@ -3,9 +3,9 @@ import { h } from 'preact';
|
|
|
3
3
|
import type { MenuSelectCSSClasses, MenuSelectTemplates } from '../../widgets/menu-select/menu-select';
|
|
4
4
|
import type { MenuRenderState } from '../../connectors/menu/connectMenu';
|
|
5
5
|
import type { ComponentCSSClasses } from '../../types';
|
|
6
|
-
export
|
|
7
|
-
export
|
|
8
|
-
|
|
6
|
+
export type MenuSelectComponentCSSClasses = ComponentCSSClasses<MenuSelectCSSClasses>;
|
|
7
|
+
export type MenuSelectComponentTemplates = Required<MenuSelectTemplates>;
|
|
8
|
+
type MenuItem = {
|
|
9
9
|
/**
|
|
10
10
|
* The value of the menu item.
|
|
11
11
|
**/
|
|
@@ -23,7 +23,7 @@ declare type MenuItem = {
|
|
|
23
23
|
**/
|
|
24
24
|
isRefined: boolean;
|
|
25
25
|
};
|
|
26
|
-
|
|
26
|
+
type Props = {
|
|
27
27
|
cssClasses: MenuSelectComponentCSSClasses;
|
|
28
28
|
items: MenuItem[];
|
|
29
29
|
refine: MenuRenderState['refine'];
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
import { h } from 'preact';
|
|
3
3
|
import type { PaginationCSSClasses, PaginationTemplates } from '../../widgets/pagination/pagination';
|
|
4
4
|
import type { ComponentCSSClasses } from '../../types';
|
|
5
|
-
export
|
|
6
|
-
export
|
|
7
|
-
export
|
|
5
|
+
export type PaginationComponentCSSClasses = ComponentCSSClasses<PaginationCSSClasses>;
|
|
6
|
+
export type PaginationComponentTemplates = Required<PaginationTemplates>;
|
|
7
|
+
export type PaginationProps = {
|
|
8
8
|
createURL(value: number): string;
|
|
9
9
|
cssClasses: PaginationComponentCSSClasses;
|
|
10
10
|
templates: PaginationComponentTemplates;
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
import { h } from 'preact';
|
|
3
3
|
import type { PanelCSSClasses, PanelSharedOptions, PanelTemplates } from '../../widgets/panel/panel';
|
|
4
4
|
import type { ComponentCSSClasses, UnknownWidgetFactory } from '../../types';
|
|
5
|
-
export
|
|
6
|
-
export
|
|
7
|
-
export
|
|
5
|
+
export type PanelComponentCSSClasses = ComponentCSSClasses<Omit<PanelCSSClasses, 'collapseIcon'>>;
|
|
6
|
+
export type PanelComponentTemplates<TWidget extends UnknownWidgetFactory> = Required<PanelTemplates<TWidget>>;
|
|
7
|
+
export type PanelProps<TWidget extends UnknownWidgetFactory> = {
|
|
8
8
|
hidden: boolean;
|
|
9
9
|
collapsible: boolean;
|
|
10
10
|
isCollapsed: boolean;
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
import { h } from 'preact';
|
|
3
3
|
import type { ComponentCSSClasses } from '../../types';
|
|
4
4
|
import type { PoweredByCSSClasses } from '../../widgets/powered-by/powered-by';
|
|
5
|
-
export
|
|
6
|
-
export
|
|
5
|
+
export type PoweredByComponentCSSClasses = ComponentCSSClasses<PoweredByCSSClasses>;
|
|
6
|
+
export type PoweredByProps = {
|
|
7
7
|
url: string;
|
|
8
8
|
theme: string;
|
|
9
9
|
cssClasses: PoweredByComponentCSSClasses;
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
import { h } from 'preact';
|
|
3
3
|
import type { ComponentCSSClasses } from '../../types';
|
|
4
4
|
import type { QueryRuleCustomDataCSSClasses, QueryRuleCustomDataTemplates } from '../../widgets/query-rule-custom-data/query-rule-custom-data';
|
|
5
|
-
export
|
|
6
|
-
export
|
|
7
|
-
export
|
|
5
|
+
export type QueryRuleCustomDataComponentCSSClasses = ComponentCSSClasses<QueryRuleCustomDataCSSClasses>;
|
|
6
|
+
export type QueryRuleCustomDataComponentTemplates = Required<QueryRuleCustomDataTemplates>;
|
|
7
|
+
export type QueryRuleCustomDataProps = {
|
|
8
8
|
cssClasses: QueryRuleCustomDataComponentCSSClasses;
|
|
9
9
|
templates: QueryRuleCustomDataComponentTemplates;
|
|
10
10
|
items: any[];
|
|
@@ -3,9 +3,9 @@ import { h, Component } from 'preact';
|
|
|
3
3
|
import type { RangeInputCSSClasses, RangeInputTemplates } from '../../widgets/range-input/range-input';
|
|
4
4
|
import type { Range, RangeBoundaries } from '../../connectors/range/connectRange';
|
|
5
5
|
import type { ComponentCSSClasses } from '../../types';
|
|
6
|
-
export
|
|
7
|
-
export
|
|
8
|
-
export
|
|
6
|
+
export type RangeInputComponentCSSClasses = ComponentCSSClasses<RangeInputCSSClasses>;
|
|
7
|
+
export type RangeInputComponentTemplates = Required<RangeInputTemplates>;
|
|
8
|
+
export type RangeInputProps = {
|
|
9
9
|
min?: number;
|
|
10
10
|
max?: number;
|
|
11
11
|
step: number;
|
|
@@ -8,13 +8,13 @@ import type { ComponentCSSClasses, CreateURL, Templates } from '../../types';
|
|
|
8
8
|
import type { RefinementListOwnCSSClasses } from '../../widgets/refinement-list/refinement-list';
|
|
9
9
|
import type { RatingMenuComponentCSSClasses } from '../../widgets/rating-menu/rating-menu';
|
|
10
10
|
import type { HierarchicalMenuComponentCSSClasses } from '../../widgets/hierarchical-menu/hierarchical-menu';
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
export
|
|
11
|
+
type RefinementListOptionalClasses = 'noResults' | 'checkbox' | 'labelText' | 'showMore' | 'disabledShowMore' | 'searchBox' | 'count';
|
|
12
|
+
type RefinementListWidgetCSSClasses = ComponentCSSClasses<RefinementListOwnCSSClasses>;
|
|
13
|
+
type RefinementListRequiredCSSClasses = Omit<RefinementListWidgetCSSClasses, RefinementListOptionalClasses> & Partial<Pick<RefinementListWidgetCSSClasses, RefinementListOptionalClasses>>;
|
|
14
|
+
export type RefinementListComponentCSSClasses = RefinementListRequiredCSSClasses & {
|
|
15
15
|
searchable?: SearchBoxComponentCSSClasses;
|
|
16
16
|
} & Partial<Pick<RatingMenuComponentCSSClasses, 'disabledItem'>> & Partial<Pick<HierarchicalMenuComponentCSSClasses, 'childList' | 'parentItem'>>;
|
|
17
|
-
|
|
17
|
+
type FacetValue = {
|
|
18
18
|
value: string;
|
|
19
19
|
label: string;
|
|
20
20
|
highlighted?: string;
|
|
@@ -22,7 +22,7 @@ declare type FacetValue = {
|
|
|
22
22
|
isRefined: boolean;
|
|
23
23
|
data?: HierarchicalMenuItem[] | null;
|
|
24
24
|
};
|
|
25
|
-
export
|
|
25
|
+
export type RefinementListProps<TTemplates extends Templates> = {
|
|
26
26
|
createURL: CreateURL<string>;
|
|
27
27
|
cssClasses: RefinementListComponentCSSClasses;
|
|
28
28
|
depth?: number;
|
|
@@ -47,7 +47,7 @@ declare const defaultProps: {
|
|
|
47
47
|
cssClasses: {};
|
|
48
48
|
depth: number;
|
|
49
49
|
};
|
|
50
|
-
|
|
50
|
+
type RefinementListPropsWithDefaultProps<TTemplates extends Templates> = RefinementListProps<TTemplates> & Readonly<typeof defaultProps>;
|
|
51
51
|
declare class RefinementList<TTemplates extends Templates> extends Component<RefinementListPropsWithDefaultProps<TTemplates>> {
|
|
52
52
|
static defaultProps: {
|
|
53
53
|
cssClasses: {};
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
import { h } from 'preact';
|
|
3
3
|
import type { RelevantSortCSSClasses, RelevantSortTemplates } from '../../widgets/relevant-sort/relevant-sort';
|
|
4
4
|
import type { ComponentCSSClasses } from '../../types';
|
|
5
|
-
export
|
|
6
|
-
export
|
|
7
|
-
|
|
5
|
+
export type RelevantSortComponentCSSClasses = ComponentCSSClasses<RelevantSortCSSClasses>;
|
|
6
|
+
export type RelevantSortComponentTemplates = Required<RelevantSortTemplates>;
|
|
7
|
+
type RelevantSortProps = {
|
|
8
8
|
cssClasses: RelevantSortComponentCSSClasses;
|
|
9
9
|
templates: RelevantSortComponentTemplates;
|
|
10
10
|
isRelevantSorted: boolean;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { h } from 'preact';
|
|
2
2
|
import type { HighlightProps as InternalHighlightProps, HighlightClassNames as InternalHighlightClassNames } from '@algolia/ui-components-highlight-vdom';
|
|
3
|
-
export
|
|
4
|
-
export
|
|
3
|
+
export type ReverseHighlightClassNames = InternalHighlightClassNames;
|
|
4
|
+
export type ReverseHighlightProps = Omit<InternalHighlightProps, 'classNames'> & {
|
|
5
5
|
classNames?: Partial<ReverseHighlightClassNames>;
|
|
6
6
|
};
|
|
7
7
|
export declare function ReverseHighlight({ classNames, ...props }: ReverseHighlightProps): h.JSX.Element;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { h } from 'preact';
|
|
2
2
|
import type { HighlightProps as InternalHighlightProps, HighlightClassNames as InternalHighlightClassNames } from '@algolia/ui-components-highlight-vdom';
|
|
3
|
-
export
|
|
4
|
-
export
|
|
3
|
+
export type ReverseSnippetClassNames = InternalHighlightClassNames;
|
|
4
|
+
export type ReverseSnippetProps = Omit<InternalHighlightProps, 'classNames'> & {
|
|
5
5
|
classNames?: Partial<ReverseSnippetClassNames>;
|
|
6
6
|
};
|
|
7
7
|
export declare function ReverseSnippet({ classNames, ...props }: ReverseSnippetProps): h.JSX.Element;
|
|
@@ -3,9 +3,9 @@ import { h, Component } from 'preact';
|
|
|
3
3
|
import { noop } from '../../lib/utils';
|
|
4
4
|
import type { SearchBoxCSSClasses, SearchBoxTemplates } from '../../widgets/search-box/search-box';
|
|
5
5
|
import type { ComponentCSSClasses } from '../../types';
|
|
6
|
-
export
|
|
7
|
-
export
|
|
8
|
-
|
|
6
|
+
export type SearchBoxComponentCSSClasses = ComponentCSSClasses<SearchBoxCSSClasses>;
|
|
7
|
+
export type SearchBoxComponentTemplates = Required<SearchBoxTemplates>;
|
|
8
|
+
type SearchBoxProps = {
|
|
9
9
|
placeholder?: string;
|
|
10
10
|
cssClasses: SearchBoxComponentCSSClasses;
|
|
11
11
|
templates: SearchBoxComponentTemplates;
|
|
@@ -36,8 +36,8 @@ declare const defaultProps: {
|
|
|
36
36
|
onReset: typeof noop;
|
|
37
37
|
refine: typeof noop;
|
|
38
38
|
};
|
|
39
|
-
|
|
40
|
-
|
|
39
|
+
type SearchBoxPropsWithDefaultProps = SearchBoxProps & Readonly<typeof defaultProps>;
|
|
40
|
+
type SearchBoxState = {
|
|
41
41
|
query: string;
|
|
42
42
|
focused: boolean;
|
|
43
43
|
};
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
|
|
2
2
|
import { h } from 'preact';
|
|
3
|
-
export
|
|
3
|
+
export type SelectorOption = {
|
|
4
4
|
value?: string | number;
|
|
5
5
|
label: string;
|
|
6
6
|
};
|
|
7
|
-
export
|
|
7
|
+
export type SelectorComponentCSSClasses = {
|
|
8
8
|
root: string;
|
|
9
9
|
select: string;
|
|
10
10
|
option: string;
|
|
11
11
|
};
|
|
12
|
-
export
|
|
12
|
+
export type SelectorProps = {
|
|
13
13
|
cssClasses: SelectorComponentCSSClasses;
|
|
14
14
|
currentValue?: string | number;
|
|
15
15
|
options: SelectorOption[];
|
|
@@ -6,25 +6,25 @@
|
|
|
6
6
|
|
|
7
7
|
import type { ComponentChildren, ComponentType, JSX } from 'preact';
|
|
8
8
|
import { Component } from 'preact';
|
|
9
|
-
|
|
9
|
+
type BoundingBox = {
|
|
10
10
|
height: number;
|
|
11
11
|
left: number;
|
|
12
12
|
top: number;
|
|
13
13
|
width: number;
|
|
14
14
|
};
|
|
15
15
|
declare function Button(props: JSX.IntrinsicElements['button']): JSX.Element;
|
|
16
|
-
|
|
16
|
+
type Style = {
|
|
17
17
|
position?: 'absolute';
|
|
18
18
|
top?: number | string;
|
|
19
19
|
left?: number | string;
|
|
20
20
|
height?: string;
|
|
21
21
|
width?: string;
|
|
22
22
|
};
|
|
23
|
-
export
|
|
23
|
+
export type PitProps = {
|
|
24
24
|
children: number | string;
|
|
25
25
|
style: Style;
|
|
26
26
|
};
|
|
27
|
-
export
|
|
27
|
+
export type HandleProps = {
|
|
28
28
|
'aria-valuemax'?: number;
|
|
29
29
|
'aria-valuemin'?: number;
|
|
30
30
|
'aria-valuenow'?: number;
|
|
@@ -40,7 +40,7 @@ export declare type HandleProps = {
|
|
|
40
40
|
style: JSX.HTMLAttributes['style'];
|
|
41
41
|
tabIndex: number;
|
|
42
42
|
};
|
|
43
|
-
|
|
43
|
+
type Props = {
|
|
44
44
|
children?: ComponentChildren;
|
|
45
45
|
className?: string;
|
|
46
46
|
disabled?: boolean;
|
|
@@ -62,7 +62,7 @@ declare type Props = {
|
|
|
62
62
|
snapPoints?: number[];
|
|
63
63
|
values?: number[];
|
|
64
64
|
};
|
|
65
|
-
|
|
65
|
+
type State = {
|
|
66
66
|
className: string;
|
|
67
67
|
handlePos: number[];
|
|
68
68
|
handleDimensions: number;
|
|
@@ -3,8 +3,8 @@ import { h, Component } from 'preact';
|
|
|
3
3
|
import type { RangeBoundaries } from '../../connectors/range/connectRange';
|
|
4
4
|
import type { RangeSliderCssClasses, RangeSliderWidgetParams } from '../../widgets/range-slider/range-slider';
|
|
5
5
|
import type { ComponentCSSClasses } from '../../types';
|
|
6
|
-
export
|
|
7
|
-
export
|
|
6
|
+
export type RangeSliderComponentCSSClasses = ComponentCSSClasses<RangeSliderCssClasses>;
|
|
7
|
+
export type SliderProps = {
|
|
8
8
|
refine(values: RangeBoundaries): void;
|
|
9
9
|
min?: number;
|
|
10
10
|
max?: number;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { h } from 'preact';
|
|
2
2
|
import type { HighlightProps as InternalHighlightProps, HighlightClassNames as InternalHighlightClassNames } from '@algolia/ui-components-highlight-vdom';
|
|
3
|
-
export
|
|
4
|
-
export
|
|
3
|
+
export type SnippetClassNames = InternalHighlightClassNames;
|
|
4
|
+
export type SnippetProps = Omit<InternalHighlightProps, 'classNames'> & {
|
|
5
5
|
classNames?: Partial<SnippetClassNames>;
|
|
6
6
|
};
|
|
7
7
|
export declare function Snippet({ classNames, ...props }: SnippetProps): h.JSX.Element;
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
import { h } from 'preact';
|
|
3
3
|
import type { StatsCSSClasses, StatsTemplates } from '../../widgets/stats/stats';
|
|
4
4
|
import type { ComponentCSSClasses } from '../../types';
|
|
5
|
-
export
|
|
6
|
-
export
|
|
7
|
-
|
|
5
|
+
export type StatsComponentCSSClasses = ComponentCSSClasses<StatsCSSClasses>;
|
|
6
|
+
export type StatsComponentTemplates = Required<StatsTemplates>;
|
|
7
|
+
type StatsProps = {
|
|
8
8
|
cssClasses: StatsComponentCSSClasses;
|
|
9
9
|
templateProps: {
|
|
10
10
|
[key: string]: any;
|
|
@@ -11,7 +11,7 @@ declare const defaultProps: {
|
|
|
11
11
|
templates: {};
|
|
12
12
|
templatesConfig: {};
|
|
13
13
|
};
|
|
14
|
-
export
|
|
14
|
+
export type TemplateProps = {
|
|
15
15
|
data?: Record<string, any>;
|
|
16
16
|
rootProps?: Record<string, any>;
|
|
17
17
|
rootTagName?: keyof JSX.IntrinsicElements;
|
|
@@ -4,9 +4,9 @@ import type { ToggleRefinementRenderState, ToggleRefinementValue } from '../../c
|
|
|
4
4
|
import type { PreparedTemplateProps } from '../../lib/templating';
|
|
5
5
|
import type { ComponentCSSClasses } from '../../types';
|
|
6
6
|
import type { ToggleRefinementTemplates, ToggleRefinementCSSClasses } from '../../widgets/toggle-refinement/toggle-refinement';
|
|
7
|
-
export
|
|
8
|
-
export
|
|
9
|
-
export
|
|
7
|
+
export type ToggleRefinementComponentCSSClasses = ComponentCSSClasses<ToggleRefinementCSSClasses>;
|
|
8
|
+
export type ToggleRefinementComponentTemplates = Required<ToggleRefinementTemplates>;
|
|
9
|
+
export type ToggleRefinementProps = {
|
|
10
10
|
currentRefinement: ToggleRefinementValue;
|
|
11
11
|
refine: ToggleRefinementRenderState['refine'];
|
|
12
12
|
cssClasses: ToggleRefinementComponentCSSClasses;
|
|
@@ -3,9 +3,9 @@ import { h } from 'preact';
|
|
|
3
3
|
import type { VoiceSearchCSSClasses, VoiceSearchTemplates } from '../../widgets/voice-search/voice-search';
|
|
4
4
|
import type { VoiceListeningState } from '../../lib/voiceSearchHelper/types';
|
|
5
5
|
import type { ComponentCSSClasses } from '../../types';
|
|
6
|
-
export
|
|
7
|
-
export
|
|
8
|
-
export
|
|
6
|
+
export type VoiceSearchComponentCSSClasses = ComponentCSSClasses<VoiceSearchCSSClasses>;
|
|
7
|
+
export type VoiceSearchComponentTemplates = Required<VoiceSearchTemplates>;
|
|
8
|
+
export type VoiceSearchProps = {
|
|
9
9
|
cssClasses: VoiceSearchComponentCSSClasses;
|
|
10
10
|
isBrowserSupported: boolean;
|
|
11
11
|
isListening: boolean;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Connector, Hit, FindAnswersOptions, WidgetRenderState } from '../../types';
|
|
2
|
-
export
|
|
2
|
+
export type AnswersRenderState = {
|
|
3
3
|
/**
|
|
4
4
|
* The matched hits from Algolia API.
|
|
5
5
|
*/
|
|
@@ -9,7 +9,7 @@ export declare type AnswersRenderState = {
|
|
|
9
9
|
*/
|
|
10
10
|
isLoading: boolean;
|
|
11
11
|
};
|
|
12
|
-
export
|
|
12
|
+
export type AnswersConnectorParams = {
|
|
13
13
|
/**
|
|
14
14
|
* Attributes to use for predictions.
|
|
15
15
|
* If empty, we use all `searchableAttributes` to find answers.
|
|
@@ -48,13 +48,13 @@ export declare type AnswersConnectorParams = {
|
|
|
48
48
|
*/
|
|
49
49
|
extraParameters?: FindAnswersOptions;
|
|
50
50
|
};
|
|
51
|
-
export
|
|
51
|
+
export type AnswersWidgetDescription = {
|
|
52
52
|
$$type: 'ais.answers';
|
|
53
53
|
renderState: AnswersRenderState;
|
|
54
54
|
indexRenderState: {
|
|
55
55
|
answers: WidgetRenderState<AnswersRenderState, AnswersConnectorParams>;
|
|
56
56
|
};
|
|
57
57
|
};
|
|
58
|
-
export
|
|
58
|
+
export type AnswersConnector = Connector<AnswersWidgetDescription, AnswersConnectorParams>;
|
|
59
59
|
declare const connectAnswers: AnswersConnector;
|
|
60
60
|
export default connectAnswers;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { SearchResults } from 'algoliasearch-helper';
|
|
2
2
|
import type { SendEventForHits } from '../../lib/utils';
|
|
3
3
|
import type { Hit, Connector, WidgetRenderState } from '../../types';
|
|
4
|
-
export
|
|
4
|
+
export type AutocompleteConnectorParams = {
|
|
5
5
|
/**
|
|
6
6
|
* Escapes HTML entities from hits string values.
|
|
7
7
|
*
|
|
@@ -9,7 +9,7 @@ export declare type AutocompleteConnectorParams = {
|
|
|
9
9
|
*/
|
|
10
10
|
escapeHTML?: boolean;
|
|
11
11
|
};
|
|
12
|
-
export
|
|
12
|
+
export type AutocompleteRenderState = {
|
|
13
13
|
/**
|
|
14
14
|
* The current value of the query.
|
|
15
15
|
*/
|
|
@@ -40,7 +40,7 @@ export declare type AutocompleteRenderState = {
|
|
|
40
40
|
*/
|
|
41
41
|
refine: (query: string) => void;
|
|
42
42
|
};
|
|
43
|
-
export
|
|
43
|
+
export type AutocompleteWidgetDescription = {
|
|
44
44
|
$$type: 'ais.autocomplete';
|
|
45
45
|
renderState: AutocompleteRenderState;
|
|
46
46
|
indexRenderState: {
|
|
@@ -50,6 +50,6 @@ export declare type AutocompleteWidgetDescription = {
|
|
|
50
50
|
query: string;
|
|
51
51
|
};
|
|
52
52
|
};
|
|
53
|
-
export
|
|
53
|
+
export type AutocompleteConnector = Connector<AutocompleteWidgetDescription, AutocompleteConnectorParams>;
|
|
54
54
|
declare const connectAutocomplete: AutocompleteConnector;
|
|
55
55
|
export default connectAutocomplete;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Connector, TransformItems, CreateURL, WidgetRenderState } from '../../types';
|
|
2
|
-
export
|
|
2
|
+
export type BreadcrumbConnectorParamsItem = {
|
|
3
3
|
/**
|
|
4
4
|
* Label of the category or subcategory.
|
|
5
5
|
*/
|
|
@@ -9,7 +9,7 @@ export declare type BreadcrumbConnectorParamsItem = {
|
|
|
9
9
|
*/
|
|
10
10
|
value: string | null;
|
|
11
11
|
};
|
|
12
|
-
export
|
|
12
|
+
export type BreadcrumbConnectorParams = {
|
|
13
13
|
/**
|
|
14
14
|
* Attributes to use to generate the hierarchy of the breadcrumb.
|
|
15
15
|
*/
|
|
@@ -29,7 +29,7 @@ export declare type BreadcrumbConnectorParams = {
|
|
|
29
29
|
*/
|
|
30
30
|
separator?: string;
|
|
31
31
|
};
|
|
32
|
-
export
|
|
32
|
+
export type BreadcrumbRenderState = {
|
|
33
33
|
/**
|
|
34
34
|
* Creates the URL for a single item name in the list.
|
|
35
35
|
*/
|
|
@@ -47,7 +47,7 @@ export declare type BreadcrumbRenderState = {
|
|
|
47
47
|
*/
|
|
48
48
|
canRefine: boolean;
|
|
49
49
|
};
|
|
50
|
-
export
|
|
50
|
+
export type BreadcrumbWidgetDescription = {
|
|
51
51
|
$$type: 'ais.breadcrumb';
|
|
52
52
|
renderState: BreadcrumbRenderState;
|
|
53
53
|
indexRenderState: {
|
|
@@ -56,6 +56,6 @@ export declare type BreadcrumbWidgetDescription = {
|
|
|
56
56
|
};
|
|
57
57
|
};
|
|
58
58
|
};
|
|
59
|
-
export
|
|
59
|
+
export type BreadcrumbConnector = Connector<BreadcrumbWidgetDescription, BreadcrumbConnectorParams>;
|
|
60
60
|
declare const connectBreadcrumb: BreadcrumbConnector;
|
|
61
61
|
export default connectBreadcrumb;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { TransformItems, CreateURL, Connector, WidgetRenderState } from '../../types';
|
|
2
|
-
export
|
|
2
|
+
export type ClearRefinementsConnectorParams = {
|
|
3
3
|
/**
|
|
4
4
|
* The attributes to include in the refinements to clear (all by default). Cannot be used with `excludedAttributes`.
|
|
5
5
|
*/
|
|
@@ -13,7 +13,7 @@ export declare type ClearRefinementsConnectorParams = {
|
|
|
13
13
|
*/
|
|
14
14
|
transformItems?: TransformItems<string>;
|
|
15
15
|
};
|
|
16
|
-
export
|
|
16
|
+
export type ClearRefinementsRenderState = {
|
|
17
17
|
/**
|
|
18
18
|
* Triggers the clear of all the currently refined values.
|
|
19
19
|
*/
|
|
@@ -32,13 +32,13 @@ export declare type ClearRefinementsRenderState = {
|
|
|
32
32
|
*/
|
|
33
33
|
createURL: CreateURL<void>;
|
|
34
34
|
};
|
|
35
|
-
export
|
|
35
|
+
export type ClearRefinementsWidgetDescription = {
|
|
36
36
|
$$type: 'ais.clearRefinements';
|
|
37
37
|
renderState: ClearRefinementsRenderState;
|
|
38
38
|
indexRenderState: {
|
|
39
39
|
clearRefinements: WidgetRenderState<ClearRefinementsRenderState, ClearRefinementsConnectorParams>;
|
|
40
40
|
};
|
|
41
41
|
};
|
|
42
|
-
export
|
|
42
|
+
export type ClearRefinementsConnector = Connector<ClearRefinementsWidgetDescription, ClearRefinementsConnectorParams>;
|
|
43
43
|
declare const connectClearRefinements: ClearRefinementsConnector;
|
|
44
44
|
export default connectClearRefinements;
|