@coveo/headless 3.28.0-pre.aeda47bcba → 3.28.0-pre.bc5fc96bfc
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/README.md +1 -1
- package/dist/cjs/case-assist/headless.cjs +1 -1
- package/dist/cjs/case-assist/node.cjs.stats.json +1 -1
- package/dist/cjs/commerce/headless.cjs +1 -1
- package/dist/cjs/commerce/node.cjs.stats.json +1 -1
- package/dist/cjs/headless.cjs +1 -1
- package/dist/cjs/insight/headless.cjs +1 -1
- package/dist/cjs/insight/node.cjs.stats.json +1 -1
- package/dist/cjs/node.cjs.stats.json +1 -1
- package/dist/cjs/recommendation/headless.cjs +1 -1
- package/dist/cjs/recommendation/node.cjs.stats.json +1 -1
- package/dist/cjs/ssr/headless.cjs +1 -1
- package/dist/cjs/ssr/node.cjs.stats.json +1 -1
- package/dist/cjs/ssr-commerce/headless.cjs +1 -1
- package/dist/cjs/ssr-commerce/node.cjs.stats.json +1 -1
- package/dist/cjs/ssr-commerce-next/headless.cjs +1 -1
- package/dist/cjs/ssr-commerce-next/node.cjs.stats.json +1 -1
- package/dist/cjs/ssr-next/headless.cjs +1 -1
- package/dist/cjs/ssr-next/node.cjs.stats.json +1 -1
- package/dist/definitions/app/case-assist-engine/case-assist-engine.d.ts +2 -2
- package/dist/definitions/controllers/breadcrumb-manager/headless-breadcrumb-manager.d.ts +1 -1
- package/dist/definitions/controllers/case-field/headless-case-field.d.ts +2 -2
- package/dist/definitions/controllers/case-input/headless-case-input.d.ts +2 -2
- package/dist/definitions/controllers/commerce/product-listing/headless-product-listing.d.ts +1 -1
- package/dist/definitions/controllers/commerce/recommendations/headless-recommendations.d.ts +1 -1
- package/dist/definitions/controllers/commerce/search/headless-search.d.ts +1 -1
- package/dist/definitions/controllers/core/context/headless-core-context.d.ts +1 -1
- package/dist/definitions/controllers/core/did-you-mean/headless-core-did-you-mean.d.ts +1 -1
- package/dist/definitions/controllers/core/facet-manager/headless-core-facet-manager.d.ts +1 -1
- package/dist/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts +2 -2
- package/dist/definitions/controllers/core/facets/facet/headless-core-facet.d.ts +3 -3
- package/dist/definitions/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.d.ts +2 -2
- package/dist/definitions/controllers/core/facets/range-facet/date-facet/headless-core-date-filter.d.ts +1 -1
- package/dist/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-facet.d.ts +1 -1
- package/dist/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-filter.d.ts +1 -1
- package/dist/definitions/controllers/core/folded-result-list/headless-core-folded-result-list.d.ts +1 -1
- package/dist/definitions/controllers/core/pager/headless-core-pager.d.ts +1 -1
- package/dist/definitions/controllers/core/query-error/headless-core-query-error.d.ts +1 -1
- package/dist/definitions/controllers/core/result-list/headless-core-result-list.d.ts +1 -1
- package/dist/definitions/controllers/core/results-per-page/headless-core-results-per-page.d.ts +1 -1
- package/dist/definitions/controllers/core/sort/headless-core-sort.d.ts +1 -1
- package/dist/definitions/controllers/core/status/headless-core-status.d.ts +1 -1
- package/dist/definitions/controllers/core/tab/headless-core-tab.d.ts +1 -1
- package/dist/definitions/controllers/core/triggers/headless-core-notify-trigger.d.ts +1 -1
- package/dist/definitions/controllers/core/triggers/headless-core-query-trigger.d.ts +1 -1
- package/dist/definitions/controllers/core/triggers/headless-core-redirection-trigger.d.ts +1 -1
- package/dist/definitions/controllers/dictionary-field-context/headless-dictionary-field-context.d.ts +1 -1
- package/dist/definitions/controllers/document-suggestion-list/case-assist-headless-interactive-result.d.ts +2 -2
- package/dist/definitions/controllers/document-suggestion-list/headless-document-suggestion-list.d.ts +2 -2
- package/dist/definitions/controllers/facets/automatic-facet-generator/headless-automatic-facet-generator.d.ts +2 -2
- package/dist/definitions/controllers/field-suggestions/category-facet/headless-category-field-suggestions.d.ts +1 -1
- package/dist/definitions/controllers/field-suggestions/facet/headless-field-suggestions.d.ts +1 -1
- package/dist/definitions/controllers/history-manager/headless-history-manager.d.ts +1 -1
- package/dist/definitions/controllers/instant-results/instant-results.d.ts +1 -1
- package/dist/definitions/controllers/query-summary/headless-query-summary.d.ts +1 -1
- package/dist/definitions/controllers/quickview/case-assist-headless-quickview.d.ts +2 -2
- package/dist/definitions/controllers/quickview/headless-quickview.d.ts +1 -1
- package/dist/definitions/controllers/recent-queries-list/headless-recent-queries-list.d.ts +1 -1
- package/dist/definitions/controllers/recent-results-list/headless-recent-results-list.d.ts +1 -1
- package/dist/definitions/controllers/recommendation/headless-recommendation.d.ts +1 -1
- package/dist/definitions/controllers/relevance-inspector/headless-relevance-inspector.d.ts +1 -1
- package/dist/definitions/controllers/result-list/headless-interactive-result.d.ts +1 -1
- package/dist/definitions/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.d.ts +1 -1
- package/dist/definitions/controllers/standalone-search-box/headless-standalone-search-box.d.ts +1 -1
- package/dist/definitions/controllers/static-filter/headless-static-filter.d.ts +1 -1
- package/dist/definitions/controllers/triggers/headless-execute-trigger.d.ts +2 -2
- package/dist/definitions/controllers/url-manager/headless-url-manager.d.ts +1 -1
- package/dist/esm/controllers/query-summary/headless-query-summary.js +1 -1
- package/dist/esm/utils/version.js +1 -1
- package/dist/quantic/browser.cjs.stats.json +1 -1
- package/dist/quantic/case-assist/browser.cjs.stats.json +1 -1
- package/dist/quantic/case-assist/headless.js +1 -1
- package/dist/quantic/case-assist/headless.js.map +1 -1
- package/dist/quantic/commerce/browser.cjs.stats.json +1 -1
- package/dist/quantic/commerce/headless.js +1 -1
- package/dist/quantic/commerce/headless.js.map +1 -1
- package/dist/quantic/headless.js +1 -1
- package/dist/quantic/headless.js.map +1 -1
- package/dist/quantic/insight/browser.cjs.stats.json +1 -1
- package/dist/quantic/insight/headless.js +1 -1
- package/dist/quantic/insight/headless.js.map +1 -1
- package/dist/quantic/recommendation/browser.cjs.stats.json +1 -1
- package/dist/quantic/recommendation/headless.js +1 -1
- package/dist/quantic/recommendation/headless.js.map +1 -1
- package/package.json +2 -2
|
@@ -21,8 +21,8 @@ type CaseAssistEngineState = StateFromReducersMapObject<CaseAssistEngineReducers
|
|
|
21
21
|
* The engine for powering case assist experiences.
|
|
22
22
|
*
|
|
23
23
|
* For example implementations, see the following [Coveo Quantic Case Assist components](https://docs.coveo.com/en/quantic/latest/reference/case-assist-components/):
|
|
24
|
-
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/
|
|
25
|
-
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/
|
|
24
|
+
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
|
|
25
|
+
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
|
|
26
26
|
*
|
|
27
27
|
* @group Engine
|
|
28
28
|
*/
|
|
@@ -5,7 +5,7 @@ export type { NumericFacetBreadcrumb, FacetBreadcrumb, DateFacetBreadcrumb, Cate
|
|
|
5
5
|
/**
|
|
6
6
|
* The `BreadcrumbManager` headless controller manages a summary of the currently active facet filters.
|
|
7
7
|
*
|
|
8
|
-
* Example: [breadcrumb-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
8
|
+
* Example: [breadcrumb-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/breadcrumb-manager/breadcrumb-manager.fn.tsx)
|
|
9
9
|
*
|
|
10
10
|
* @group Controllers
|
|
11
11
|
* @category BreadcrumbManager
|
|
@@ -36,8 +36,8 @@ export interface CaseFieldState {
|
|
|
36
36
|
* The `CaseField` controller is responsible for setting the value and retrieving suggestions for a field from the case creation form and optionally trigger Case Assist API requests.
|
|
37
37
|
*
|
|
38
38
|
* For example implementations, see the following [Coveo Quantic Case Assist components](https://docs.coveo.com/en/quantic/latest/reference/case-assist-components/):
|
|
39
|
-
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/
|
|
40
|
-
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/
|
|
39
|
+
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
|
|
40
|
+
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
|
|
41
41
|
*
|
|
42
42
|
* @group Controllers
|
|
43
43
|
* @category CaseField
|
|
@@ -14,8 +14,8 @@ export interface UpdateFetchOptions {
|
|
|
14
14
|
* The `CaseInput` controller is responsible for setting and retrieving the value of a single field from the case creation form and optionally trigger Case Assist API requests.
|
|
15
15
|
*
|
|
16
16
|
* For example implementations, see the following [Coveo Quantic Case Assist components](https://docs.coveo.com/en/quantic/latest/reference/case-assist-components/):
|
|
17
|
-
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/
|
|
18
|
-
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/
|
|
17
|
+
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
|
|
18
|
+
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
|
|
19
19
|
*
|
|
20
20
|
* @group Controllers
|
|
21
21
|
* @category CaseInput
|
|
@@ -8,7 +8,7 @@ import type { ProductListingSummaryState } from './summary/headless-product-list
|
|
|
8
8
|
/**
|
|
9
9
|
* The `ProductListing` controller exposes a method for retrieving product listing content in a commerce interface.
|
|
10
10
|
*
|
|
11
|
-
* Example: [product-listing.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
11
|
+
* Example: [product-listing.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/commerce/product-listing.fn.tsx)
|
|
12
12
|
*
|
|
13
13
|
* @group Buildable controllers
|
|
14
14
|
* @category ProductListing
|
|
@@ -7,7 +7,7 @@ import type { SummaryState } from '../core/summary/headless-core-summary.js';
|
|
|
7
7
|
/**
|
|
8
8
|
* The `Recommendations` controller exposes a method for retrieving recommendations content in a commerce interface.
|
|
9
9
|
*
|
|
10
|
-
* Example: [recommendations.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
10
|
+
* Example: [recommendations.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/commerce/recommendations.fn.tsx)
|
|
11
11
|
*
|
|
12
12
|
* @group Buildable controllers
|
|
13
13
|
* @category Recommendations
|
|
@@ -6,7 +6,7 @@ import { type SearchSubControllers } from '../core/sub-controller/headless-sub-c
|
|
|
6
6
|
/**
|
|
7
7
|
* The `Search` controller lets you create a commerce search page.
|
|
8
8
|
*
|
|
9
|
-
* Example: [search.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
9
|
+
* Example: [search.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/commerce/search.fn.tsx)
|
|
10
10
|
*
|
|
11
11
|
* @group Buildable controllers
|
|
12
12
|
* @category Search
|
|
@@ -18,7 +18,7 @@ export interface ContextInitialState {
|
|
|
18
18
|
* The `Context` controller injects [custom contextual information](https://docs.coveo.com/en/3389/)
|
|
19
19
|
* into the search requests and usage analytics search events sent from a search interface.
|
|
20
20
|
*
|
|
21
|
-
* Example: [context.ts](https://github.com/coveo/ui-kit/blob/
|
|
21
|
+
* Example: [context.ts](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/context/context.ts)
|
|
22
22
|
*
|
|
23
23
|
* @group Controllers
|
|
24
24
|
* @category Context
|
|
@@ -27,7 +27,7 @@ export interface DidYouMeanOptions {
|
|
|
27
27
|
/**
|
|
28
28
|
* The `DidYouMean` controller is responsible for handling query corrections.
|
|
29
29
|
*
|
|
30
|
-
* Example: [did-you-mean.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
30
|
+
* Example: [did-you-mean.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/did-you-mean/did-you-mean.fn.tsx)
|
|
31
31
|
*
|
|
32
32
|
* @group Controllers
|
|
33
33
|
* @category DidYouMean
|
|
@@ -16,7 +16,7 @@ export interface FacetManagerPayload<T> {
|
|
|
16
16
|
/**
|
|
17
17
|
* The `FacetManager` controller helps reorder facets to match the most recent search response.
|
|
18
18
|
*
|
|
19
|
-
* Example: [facet-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
19
|
+
* Example: [facet-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/facet-manager/facet-manager.fn.tsx)
|
|
20
20
|
*
|
|
21
21
|
* @group Controllers
|
|
22
22
|
* @category FacetManager
|
package/dist/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts
CHANGED
|
@@ -13,8 +13,8 @@ export interface CategoryFacetProps {
|
|
|
13
13
|
* The `CategoryFacet` headless controller offers a high-level interface for designing a facet UI controller that renders values hierarchically.
|
|
14
14
|
*
|
|
15
15
|
* Example:
|
|
16
|
-
* - [category-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
17
|
-
* - [category-facet-search.tsx](https://github.com/coveo/ui-kit/blob/
|
|
16
|
+
* - [category-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/category-facet/category-facet.fn.tsx)
|
|
17
|
+
* - [category-facet-search.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/category-facet/category-facet-search.tsx)
|
|
18
18
|
*
|
|
19
19
|
* @group Controllers
|
|
20
20
|
* @category CategoryFacet
|
|
@@ -17,9 +17,9 @@ interface CoreFacetProps {
|
|
|
17
17
|
* model, the `Facet` controller automatically reorders facet values according to the user query.
|
|
18
18
|
*
|
|
19
19
|
* Examples:
|
|
20
|
-
* - [facet.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
21
|
-
* - [facet-search.tsx](https://github.com/coveo/ui-kit/blob/
|
|
22
|
-
* - [facet.class.tsx](https://github.com/coveo/ui-kit/blob/
|
|
20
|
+
* - [facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/facet/facet.fn.tsx)
|
|
21
|
+
* - [facet-search.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/facet/facet-search.tsx)
|
|
22
|
+
* - [facet.class.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/facet/facet.class.tsx)
|
|
23
23
|
*
|
|
24
24
|
* @group Controllers
|
|
25
25
|
* @category Facet
|
|
@@ -17,8 +17,8 @@ export interface DateFacetProps {
|
|
|
17
17
|
* The `DateFacet` controller makes it possible to create a facet with date ranges.
|
|
18
18
|
*
|
|
19
19
|
* Examples:
|
|
20
|
-
* - [date-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
21
|
-
* - [relative-date-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
20
|
+
* - [date-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/date-facet/date-facet.fn.tsx)
|
|
21
|
+
* - [relative-date-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/relative-date-facet/relative-date-facet.fn.tsx)
|
|
22
22
|
*
|
|
23
23
|
* @document relative-date-format.md
|
|
24
24
|
*
|
|
@@ -93,7 +93,7 @@ export interface DateFilterState {
|
|
|
93
93
|
/**
|
|
94
94
|
* The `DateFilter` controller makes it possible to create a date filter.
|
|
95
95
|
*
|
|
96
|
-
* Example: [date-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
96
|
+
* Example: [date-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/date-filter/date-filter.fn.tsx)
|
|
97
97
|
*
|
|
98
98
|
* @group Controllers
|
|
99
99
|
* @category DateFilter
|
|
@@ -16,7 +16,7 @@ export interface NumericFacetProps {
|
|
|
16
16
|
/**
|
|
17
17
|
* The `NumericFacet` controller makes it possible to create a facet with numeric ranges.
|
|
18
18
|
*
|
|
19
|
-
* Example: [numeric-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
19
|
+
* Example: [numeric-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/numeric-facet/numeric-facet.fn.tsx)
|
|
20
20
|
*
|
|
21
21
|
* @group Controllers
|
|
22
22
|
* @category NumericFacet
|
|
@@ -93,7 +93,7 @@ export interface NumericFilterState {
|
|
|
93
93
|
/**
|
|
94
94
|
* The `NumericFilter` controller makes it possible to create a numeric filter.
|
|
95
95
|
*
|
|
96
|
-
* Example: [numeric-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
96
|
+
* Example: [numeric-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/numeric-filter/numeric-filter.fn.tsx)
|
|
97
97
|
*
|
|
98
98
|
* @group Controllers
|
|
99
99
|
* @category NumericFilter
|
package/dist/definitions/controllers/core/folded-result-list/headless-core-folded-result-list.d.ts
CHANGED
|
@@ -53,7 +53,7 @@ export interface CoreFoldedResultListProps {
|
|
|
53
53
|
/**
|
|
54
54
|
* The `FoldedResultList` headless controller re-organizes results into hierarchical collections (a.k.a. threads).
|
|
55
55
|
*
|
|
56
|
-
* Example: [folded-result-list.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
56
|
+
* Example: [folded-result-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/folded-result-list/folded-result-list.fn.tsx)
|
|
57
57
|
*
|
|
58
58
|
* @group Controllers
|
|
59
59
|
* @category FoldedResultList
|
|
@@ -27,7 +27,7 @@ export interface PagerProps {
|
|
|
27
27
|
/**
|
|
28
28
|
* The `Pager` controller allows to navigate through the different result pages.
|
|
29
29
|
*
|
|
30
|
-
* [pager.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
30
|
+
* [pager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/pager/pager.fn.tsx)
|
|
31
31
|
*
|
|
32
32
|
* @group Controllers
|
|
33
33
|
* @category Pager
|
|
@@ -4,7 +4,7 @@ import { type Controller } from '../../controller/headless-controller.js';
|
|
|
4
4
|
/**
|
|
5
5
|
* The `QueryError` controller allows to retrieve information about the current error returned by the search API, if any.
|
|
6
6
|
*
|
|
7
|
-
* Example: [query-error.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
7
|
+
* Example: [query-error.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/query-error/query-error.fn.tsx)
|
|
8
8
|
*
|
|
9
9
|
* @group Controllers
|
|
10
10
|
* @category QueryError
|
|
@@ -24,7 +24,7 @@ export interface ResultListProps {
|
|
|
24
24
|
/**
|
|
25
25
|
* The `ResultList` headless controller offers a high-level interface for designing a common result list UI controller.
|
|
26
26
|
*
|
|
27
|
-
* Example: [result-list.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
27
|
+
* Example: [result-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/result-list/result-list.fn.tsx)
|
|
28
28
|
*
|
|
29
29
|
* @group Controllers
|
|
30
30
|
* @category ResultList
|
package/dist/definitions/controllers/core/results-per-page/headless-core-results-per-page.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ export interface ResultsPerPageInitialState {
|
|
|
15
15
|
/**
|
|
16
16
|
* The `ResultsPerPage` controller allows the end user to choose how many results to display per page.
|
|
17
17
|
*
|
|
18
|
-
* Example: [results-per-page.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
18
|
+
* Example: [results-per-page.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/results-per-page/results-per-page.fn.tsx)
|
|
19
19
|
*
|
|
20
20
|
* @group Controllers
|
|
21
21
|
* @category ResultsPerPage
|
|
@@ -16,7 +16,7 @@ export interface SortInitialState {
|
|
|
16
16
|
/**
|
|
17
17
|
* The `Sort` controller manages how the results are sorted.
|
|
18
18
|
*
|
|
19
|
-
* Example: [sort.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
19
|
+
* Example: [sort.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/sort/sort.fn.tsx)
|
|
20
20
|
*
|
|
21
21
|
* @group Controllers
|
|
22
22
|
* @category Sort
|
|
@@ -3,7 +3,7 @@ import { type Controller } from '../../controller/headless-controller.js';
|
|
|
3
3
|
/**
|
|
4
4
|
* The `SearchStatus` controller lets you access search status information.
|
|
5
5
|
*
|
|
6
|
-
* Example: [search-status.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
6
|
+
* Example: [search-status.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/search-status/search-status.fn.tsx)
|
|
7
7
|
*
|
|
8
8
|
* @group Controllers
|
|
9
9
|
* @category SearchStatus
|
|
@@ -38,7 +38,7 @@ export interface TabProps {
|
|
|
38
38
|
/**
|
|
39
39
|
* The `Tab` headless controller offers a high-level interface for designing a common tab UI controller.
|
|
40
40
|
*
|
|
41
|
-
* Example: [tab.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
41
|
+
* Example: [tab.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/tab/tab.fn.tsx)
|
|
42
42
|
*
|
|
43
43
|
* @group Controllers
|
|
44
44
|
* @category Tab
|
|
@@ -4,7 +4,7 @@ import { type Controller } from '../../controller/headless-controller.js';
|
|
|
4
4
|
/**
|
|
5
5
|
* The `NotifyTrigger` controller handles notify triggers. A [Notify trigger](https://docs.coveo.com/en/3413#notify) query pipeline rule lets you define a message to be displayed to the end user when a certain condition is met.
|
|
6
6
|
*
|
|
7
|
-
* Example: [notify-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
7
|
+
* Example: [notify-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/notify-trigger.fn.tsx)
|
|
8
8
|
*
|
|
9
9
|
* @group Controllers
|
|
10
10
|
* @category NotifyTrigger
|
|
@@ -2,7 +2,7 @@ import type { Controller } from '../../controller/headless-controller.js';
|
|
|
2
2
|
/**
|
|
3
3
|
* The `QueryTrigger` controller handles [query trigger](https://docs.coveo.com/en/3413#query) query pipeline rules, which let you define a search query to execute when a certain condition is met.
|
|
4
4
|
*
|
|
5
|
-
* Example: [query-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
5
|
+
* Example: [query-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/query-trigger.fn.tsx)
|
|
6
6
|
*
|
|
7
7
|
* @group Controllers
|
|
8
8
|
* @category QueryTrigger
|
|
@@ -2,7 +2,7 @@ import type { Controller } from '../../controller/headless-controller.js';
|
|
|
2
2
|
/**
|
|
3
3
|
* The `RedirectionTrigger` controller handles redirection triggers. A [Redirection trigger](https://docs.coveo.com/en/3413#redirect) query pipeline rule lets you define a URL to redirect the user's browser to when a certain condition is met.
|
|
4
4
|
*
|
|
5
|
-
* Example: [redirection-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
5
|
+
* Example: [redirection-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/redirection-trigger.fn.tsx)
|
|
6
6
|
*
|
|
7
7
|
* @group Controllers
|
|
8
8
|
* @category RedirectionTrigger
|
package/dist/definitions/controllers/dictionary-field-context/headless-dictionary-field-context.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export type { DictionaryFieldContextPayload };
|
|
|
5
5
|
/**
|
|
6
6
|
* The `DictionaryFieldContext` controller allows specifying which [dictionary field](https://docs.coveo.com/en/2036/) keys to retrieve.
|
|
7
7
|
*
|
|
8
|
-
* Example: [dictionary-field-context.fn.ts](https://github.com/coveo/ui-kit/blob/
|
|
8
|
+
* Example: [dictionary-field-context.fn.ts](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/dictionary-field-context/dictionary-field-context.fn.ts)
|
|
9
9
|
*
|
|
10
10
|
* @group Controllers
|
|
11
11
|
* @category DictionaryFieldContext
|
|
@@ -18,8 +18,8 @@ export interface CaseAssistInteractiveResultProps extends InteractiveResultCoreP
|
|
|
18
18
|
* The `CaseAssistInteractiveResult` controller provides an interface for triggering desirable side effects, such as logging UA events to the Coveo Platform, when a user selects a query result.
|
|
19
19
|
*
|
|
20
20
|
* For example implementations, see the following [Coveo Quantic Case Assist components](https://docs.coveo.com/en/quantic/latest/reference/case-assist-components/):
|
|
21
|
-
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/
|
|
22
|
-
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/
|
|
21
|
+
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
|
|
22
|
+
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
|
|
23
23
|
*
|
|
24
24
|
* @group Controllers
|
|
25
25
|
* @category CaseAssistInteractiveResult
|
package/dist/definitions/controllers/document-suggestion-list/headless-document-suggestion-list.d.ts
CHANGED
|
@@ -6,8 +6,8 @@ import { type Controller } from '../controller/headless-controller.js';
|
|
|
6
6
|
* The `DocumentSuggestion` controller is responsible for getting document suggestions using case information present in the state.
|
|
7
7
|
*
|
|
8
8
|
* For example implementations, see the following [Coveo Quantic Case Assist components](https://docs.coveo.com/en/quantic/latest/reference/case-assist-components/):
|
|
9
|
-
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/
|
|
10
|
-
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/
|
|
9
|
+
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
|
|
10
|
+
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
|
|
11
11
|
*
|
|
12
12
|
* @group Controllers
|
|
13
13
|
* @category DocumentSuggestionList
|
|
@@ -12,8 +12,8 @@ export type { AutomaticFacetGeneratorOptions };
|
|
|
12
12
|
* To learn more about the automatic facet generator feature, see: [About the Facet Generator](https://docs.coveo.com/en/n9sd0159/).
|
|
13
13
|
*
|
|
14
14
|
* Examples:
|
|
15
|
-
* - [automatic-facet-generator.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
16
|
-
* - [automatic-facet-generator.class.tsx](https://github.com/coveo/ui-kit/blob/
|
|
15
|
+
* - [automatic-facet-generator.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/automatic-facet-generator/automatic-facet-generator.fn.tsx)
|
|
16
|
+
* - [automatic-facet-generator.class.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/automatic-facet-generator/automatic-facet-generator.class.tsx)
|
|
17
17
|
*
|
|
18
18
|
* @group Controllers
|
|
19
19
|
* @category AutomaticFacetGenerator
|
|
@@ -54,7 +54,7 @@ export interface CategoryFieldSuggestionsState {
|
|
|
54
54
|
*
|
|
55
55
|
* This controller is a wrapper around the basic category facet controller search functionality, and thus exposes similar options and properties.
|
|
56
56
|
*
|
|
57
|
-
* Example: [category-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
57
|
+
* Example: [category-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/field-suggestions/category-field/category-suggestions.fn.tsx)
|
|
58
58
|
*
|
|
59
59
|
* @group Controllers
|
|
60
60
|
* @category CategoryFieldSuggestions
|
package/dist/definitions/controllers/field-suggestions/facet/headless-field-suggestions.d.ts
CHANGED
|
@@ -47,7 +47,7 @@ export interface FieldSuggestionsState {
|
|
|
47
47
|
*
|
|
48
48
|
* This controller is a wrapper around the basic facet controller search functionality, and thus exposes similar options and properties.
|
|
49
49
|
*
|
|
50
|
-
* Example: [field-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
50
|
+
* Example: [field-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/field-suggestions/specific-field/field-suggestions.fn.tsx)
|
|
51
51
|
*
|
|
52
52
|
* @group Controllers
|
|
53
53
|
* @category FieldSuggestions
|
|
@@ -5,7 +5,7 @@ import { type Controller } from '../controller/headless-controller.js';
|
|
|
5
5
|
/**
|
|
6
6
|
* The `HistoryManager` controller is in charge of allowing navigating back and forward in the search interface history.
|
|
7
7
|
*
|
|
8
|
-
* Example: [history-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
8
|
+
* Example: [history-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/history-manager/history-manager.fn.tsx)
|
|
9
9
|
*
|
|
10
10
|
* @group Controllers
|
|
11
11
|
* @category HistoryManager
|
|
@@ -11,7 +11,7 @@ export interface InstantResultProps {
|
|
|
11
11
|
/**
|
|
12
12
|
* The `InstantResults` controller allows the end user to manage instant results queries.
|
|
13
13
|
*
|
|
14
|
-
* Example: [instant-results.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
14
|
+
* Example: [instant-results.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/instant-results/instant-results.fn.tsx)
|
|
15
15
|
*
|
|
16
16
|
* @group Controllers
|
|
17
17
|
* @category InstantResults
|
|
@@ -7,7 +7,7 @@ export type { QuerySummary, QuerySummaryState };
|
|
|
7
7
|
* @param engine - The headless engine instance.
|
|
8
8
|
* @returns A `QuerySummary` controller instance.
|
|
9
9
|
*
|
|
10
|
-
* Example: [query-summary.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
10
|
+
* Example: [query-summary.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/query-summary/query-summary.fn.tsx)
|
|
11
11
|
*
|
|
12
12
|
* @group Controllers
|
|
13
13
|
* @category QuerySummary
|
|
@@ -8,8 +8,8 @@ export interface CaseAssistQuickviewOptions extends QuickviewOptions {
|
|
|
8
8
|
* The `CaseAssistQuickview` controller provides an interface for triggering desirable side effects, such as logging UA events to the Coveo Platform, when a user interacts with a quickview.
|
|
9
9
|
*
|
|
10
10
|
* For example implementations, see the following [Coveo Quantic Case Assist components](https://docs.coveo.com/en/quantic/latest/reference/case-assist-components/):
|
|
11
|
-
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/
|
|
12
|
-
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/
|
|
11
|
+
* * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
|
|
12
|
+
* * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
|
|
13
13
|
*
|
|
14
14
|
* @group Controllers
|
|
15
15
|
* @category CaseAssistQuickview
|
|
@@ -24,7 +24,7 @@ export interface QuickviewState extends CoreQuickviewState {
|
|
|
24
24
|
/**
|
|
25
25
|
* The `Quickview` controller provides an interface for triggering desirable side effects, such as logging UA events to the Coveo Platform, when a user interacts with a quickview.
|
|
26
26
|
*
|
|
27
|
-
* Example: [quickview.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
27
|
+
* Example: [quickview.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/quickview/quickview.fn.tsx)
|
|
28
28
|
*
|
|
29
29
|
* @group Controllers
|
|
30
30
|
* @category Quickview
|
|
@@ -32,7 +32,7 @@ export interface RecentQueriesListOptions {
|
|
|
32
32
|
/**
|
|
33
33
|
* The `RecentQueriesList` controller manages the user's recent queries.
|
|
34
34
|
*
|
|
35
|
-
* Example: [recent-queries.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
35
|
+
* Example: [recent-queries.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/recent-queries/recent-queries.fn.tsx)
|
|
36
36
|
*
|
|
37
37
|
* @group Controllers
|
|
38
38
|
* @category RecentQueriesList
|
|
@@ -28,7 +28,7 @@ export interface RecentResultsListOptions {
|
|
|
28
28
|
/**
|
|
29
29
|
* The `RecentResultsList` controller manages a user's recently clicked results.
|
|
30
30
|
*
|
|
31
|
-
* Example: [recent-results.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
31
|
+
* Example: [recent-results.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/recent-results/recent-results.fn.tsx)
|
|
32
32
|
*
|
|
33
33
|
* @group Controllers
|
|
34
34
|
* @category RecentResultsList
|
|
@@ -20,7 +20,7 @@ export interface RecommendationListProps {
|
|
|
20
20
|
/**
|
|
21
21
|
* The `RecommendationList` controller retrieves information about the current recommendations by the search API, if there are any.
|
|
22
22
|
*
|
|
23
|
-
* Example: [recommendation-list.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
23
|
+
* Example: [recommendation-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/recommendation-list/recommendation-list.fn.tsx)
|
|
24
24
|
*
|
|
25
25
|
* @group Controllers
|
|
26
26
|
* @category RecommendationList
|
|
@@ -22,7 +22,7 @@ export interface RelevanceInspectorInitialState {
|
|
|
22
22
|
/**
|
|
23
23
|
* The `RelevanceInspector` controller is in charge of allowing displaying various debug information.
|
|
24
24
|
*
|
|
25
|
-
* Example: [relevance-inspector.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
25
|
+
* Example: [relevance-inspector.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/relevance-inspector/relevance-inspector.fn.tsx)
|
|
26
26
|
*
|
|
27
27
|
* @group Controllers
|
|
28
28
|
* @category RelevanceInspector
|
|
@@ -16,7 +16,7 @@ export interface InteractiveResultProps extends InteractiveResultCoreProps {
|
|
|
16
16
|
/**
|
|
17
17
|
* The `InteractiveResult` controller provides an interface for triggering desirable side effects, such as logging UA events to the Coveo Platform, when a user selects a query result.
|
|
18
18
|
*
|
|
19
|
-
* Example: [result-link.tsx](https://github.com/coveo/ui-kit/blob/
|
|
19
|
+
* Example: [result-link.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/result-list/result-link.tsx)
|
|
20
20
|
*
|
|
21
21
|
* @group Controllers
|
|
22
22
|
* @category InteractiveResult
|
|
@@ -13,7 +13,7 @@ export interface SmartSnippetQuestionsListState extends CoreSmartSnippetQuestion
|
|
|
13
13
|
/**
|
|
14
14
|
* The `SmartSnippetQuestionsList` controller allows to manage additional queries for which a SmartSnippet model can provide relevant excerpts.
|
|
15
15
|
*
|
|
16
|
-
* Example: [smart-snippet-questions-list.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
16
|
+
* Example: [smart-snippet-questions-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/smart-snippet-questions-list/smart-snippet-questions-list.fn.tsx)
|
|
17
17
|
*
|
|
18
18
|
* @group Controllers
|
|
19
19
|
* @category SmartSnippetQuestionsList
|
package/dist/definitions/controllers/standalone-search-box/headless-standalone-search-box.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ export interface StandaloneSearchBoxProps {
|
|
|
10
10
|
* The `StandaloneSearchBox` headless controller offers a high-level interface for designing a common search box UI controller.
|
|
11
11
|
* Meant to be used for a search box that will redirect instead of executing a query.
|
|
12
12
|
*
|
|
13
|
-
* Example: [standalone-search-box.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
13
|
+
* Example: [standalone-search-box.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/standalone-search-box/standalone-search-box.fn.tsx)
|
|
14
14
|
*
|
|
15
15
|
* @group Controllers
|
|
16
16
|
* @category StandaloneSearchBox
|
|
@@ -23,7 +23,7 @@ export interface StaticFilterOptions {
|
|
|
23
23
|
/**
|
|
24
24
|
* The `StaticFilter` controller manages a collection of filter values.
|
|
25
25
|
*
|
|
26
|
-
* Example: [static-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
26
|
+
* Example: [static-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/static-filter/static-filter.fn.tsx)
|
|
27
27
|
*
|
|
28
28
|
* @group Controllers
|
|
29
29
|
* @category StaticFilter
|
|
@@ -5,8 +5,8 @@ import { type Controller } from '../controller/headless-controller.js';
|
|
|
5
5
|
* The `ExecuteTrigger` controller handles Execute triggers from the query response. An [Execute trigger](https://docs.coveo.com/en/3413#execute) query pipeline rule lets you define a custom JavaScript function to be executed in the frontend when a certain condition is met.
|
|
6
6
|
*
|
|
7
7
|
* Examples:
|
|
8
|
-
* - [execute-trigger.tsx](https://github.com/coveo/ui-kit/blob/
|
|
9
|
-
* - [execute-trigger.class.tsx](https://github.com/coveo/ui-kit/blob/
|
|
8
|
+
* - [execute-trigger.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/execute-trigger.tsx)
|
|
9
|
+
* - [execute-trigger.class.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/execute-trigger.class.tsx)
|
|
10
10
|
*
|
|
11
11
|
* @group Controllers
|
|
12
12
|
* @category ExecuteTrigger
|
|
@@ -18,7 +18,7 @@ export declare const initialStateSchema: Schema<Required<UrlManagerInitialState>
|
|
|
18
18
|
/**
|
|
19
19
|
* The `UrlManager` controller can parse an url fragment to extract search parameters which affect the search response.
|
|
20
20
|
*
|
|
21
|
-
* Example: [url-manager.ts](https://github.com/coveo/ui-kit/blob/
|
|
21
|
+
* Example: [url-manager.ts](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/url-manager/url-manager.ts)
|
|
22
22
|
*
|
|
23
23
|
* @group Controllers
|
|
24
24
|
* @category UrlManager
|
|
@@ -5,7 +5,7 @@ import { buildCoreQuerySummary, } from '../core/query-summary/headless-core-quer
|
|
|
5
5
|
* @param engine - The headless engine instance.
|
|
6
6
|
* @returns A `QuerySummary` controller instance.
|
|
7
7
|
*
|
|
8
|
-
* Example: [query-summary.fn.tsx](https://github.com/coveo/ui-kit/blob/
|
|
8
|
+
* Example: [query-summary.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/query-summary/query-summary.fn.tsx)
|
|
9
9
|
*
|
|
10
10
|
* @group Controllers
|
|
11
11
|
* @category QuerySummary
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = "3.28.0-pre.
|
|
1
|
+
export const VERSION = "3.28.0-pre.bc5fc96bfc" || 'Test version';
|
|
2
2
|
export const COVEO_FRAMEWORK = ['@coveo/atomic', '@coveo/quantic'];
|