@coveo/atomic 3.35.0-pre.ebf3345026 → 3.35.0-pre.ef36eacfa0
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/dist/atomic/_atomic.esm.js +1 -1
- package/dist/atomic/atomic.esm.js.map +1 -1
- package/dist/atomic/components/_index.d.ts +20 -0
- package/dist/atomic/components/_index.js +10 -0
- package/dist/atomic/components/atomic-focus-trap2.js +1 -1
- package/dist/atomic/components/atomic-folded-result-list.js +44 -2
- package/dist/atomic/components/atomic-folded-result-list.js.map +1 -1
- package/dist/atomic/components/atomic-insight-folded-result-list.js +40 -4
- package/dist/atomic/components/atomic-insight-folded-result-list.js.map +1 -1
- package/dist/atomic/components/atomic-insight-result-action-bar.js +1 -5
- package/dist/atomic/components/atomic-insight-result-action-bar.js.map +1 -1
- package/dist/atomic/components/atomic-insight-result-children.js +40 -4
- package/dist/atomic/components/atomic-insight-result-children.js.map +1 -1
- package/dist/atomic/components/atomic-insight-result-list.js +40 -4
- package/dist/atomic/components/atomic-insight-result-list.js.map +1 -1
- package/dist/atomic/components/atomic-ipx-recs-list.js +40 -4
- package/dist/atomic/components/atomic-ipx-recs-list.js.map +1 -1
- package/dist/atomic/components/atomic-recs-interface.js +1 -1
- package/dist/atomic/components/atomic-recs-list.js +40 -4
- package/dist/atomic/components/atomic-recs-list.js.map +1 -1
- package/dist/atomic/components/atomic-refine-modal2.js +1 -1
- package/dist/atomic/components/atomic-result-children.js +44 -2
- package/dist/atomic/components/atomic-result-children.js.map +1 -1
- package/dist/atomic/components/atomic-result-list.js +44 -2
- package/dist/atomic/components/atomic-result-list.js.map +1 -1
- package/dist/atomic/components/atomic-result-placeholder2.js +37 -1
- package/dist/atomic/components/atomic-result-placeholder2.js.map +1 -1
- package/dist/atomic/components/atomic-result-section-actions.d.ts +11 -0
- package/dist/atomic/components/atomic-result-section-actions.js +8 -0
- package/dist/atomic/components/atomic-result-section-actions.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-actions2.js +30 -0
- package/dist/atomic/components/atomic-result-section-actions2.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-badges.d.ts +11 -0
- package/dist/atomic/components/atomic-result-section-badges.js +8 -0
- package/dist/atomic/components/atomic-result-section-badges.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-badges2.js +30 -0
- package/dist/atomic/components/atomic-result-section-badges2.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-bottom-metadata.d.ts +11 -0
- package/dist/atomic/components/atomic-result-section-bottom-metadata.js +8 -0
- package/dist/atomic/components/atomic-result-section-bottom-metadata.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-bottom-metadata2.js +30 -0
- package/dist/atomic/components/atomic-result-section-bottom-metadata2.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-children.d.ts +11 -0
- package/dist/atomic/components/atomic-result-section-children.js +33 -0
- package/dist/atomic/components/atomic-result-section-children.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-emphasized.d.ts +11 -0
- package/dist/atomic/components/atomic-result-section-emphasized.js +33 -0
- package/dist/atomic/components/atomic-result-section-emphasized.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-excerpt.d.ts +11 -0
- package/dist/atomic/components/atomic-result-section-excerpt.js +8 -0
- package/dist/atomic/components/atomic-result-section-excerpt.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-excerpt2.js +30 -0
- package/dist/atomic/components/atomic-result-section-excerpt2.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-title-metadata.d.ts +11 -0
- package/dist/atomic/components/atomic-result-section-title-metadata.js +33 -0
- package/dist/atomic/components/atomic-result-section-title-metadata.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-title.d.ts +11 -0
- package/dist/atomic/components/atomic-result-section-title.js +8 -0
- package/dist/atomic/components/atomic-result-section-title.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-title2.js +30 -0
- package/dist/atomic/components/atomic-result-section-title2.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-visual.d.ts +11 -0
- package/dist/atomic/components/atomic-result-section-visual.js +8 -0
- package/dist/atomic/components/atomic-result-section-visual.js.map +1 -0
- package/dist/atomic/components/atomic-result-section-visual2.js +33 -0
- package/dist/atomic/components/atomic-result-section-visual2.js.map +1 -0
- package/dist/atomic/components/atomic-result.d.ts +11 -0
- package/dist/atomic/components/atomic-result.js +8 -0
- package/dist/atomic/components/atomic-result.js.map +1 -0
- package/dist/atomic/components/atomic-result2.js +158 -0
- package/dist/atomic/components/atomic-result2.js.map +1 -0
- package/dist/atomic/components/atomic-smart-snippet-answer2.js +1 -1
- package/dist/atomic/components/components/search/atomic-search-interface/atomic-search-interface.js +0 -2
- package/dist/atomic/components/components/search/index.js +0 -10
- package/dist/atomic/components/components/search/lazy-index.js +0 -10
- package/dist/atomic/components/global/environment.js +1 -1
- package/dist/atomic/components/index.js.map +1 -1
- package/dist/atomic/components/item-layout-sections.js +1 -1
- package/dist/atomic/components/item-section-utils.js +9 -0
- package/dist/atomic/components/item-section-utils.js.map +1 -0
- package/dist/atomic/components/mixins/item-section-mixin.js +6 -6
- package/dist/atomic/components/props-utils.js +1 -1
- package/dist/atomic/components/result-template-common.js +1 -1
- package/dist/atomic/components/utils.js +1 -1
- package/dist/atomic/{p-7303a7dc.entry.js → p-1491d8e3.entry.js} +2 -2
- package/dist/atomic/p-36e2c945.entry.js +2 -0
- package/dist/atomic/p-36e2c945.entry.js.map +1 -0
- package/dist/atomic/p-463336ca.entry.js +2 -0
- package/dist/atomic/p-463336ca.entry.js.map +1 -0
- package/dist/atomic/p-55c41e00.entry.js +2 -0
- package/dist/atomic/p-55c41e00.entry.js.map +1 -0
- package/dist/atomic/p-5d0fc7e2.js +2 -0
- package/dist/atomic/p-5d0fc7e2.js.map +1 -0
- package/dist/atomic/p-7fd58269.entry.js +2 -0
- package/dist/atomic/p-7fd58269.entry.js.map +1 -0
- package/dist/atomic/p-a9016629.entry.js.map +1 -1
- package/dist/atomic/p-d1fbb20a.entry.js +2 -0
- package/dist/atomic/p-d1fbb20a.entry.js.map +1 -0
- package/dist/atomic/p-e62caa78.entry.js.map +1 -1
- package/dist/atomic/p-f800678c.entry.js +2 -0
- package/dist/atomic/p-f800678c.entry.js.map +1 -0
- package/dist/cjs/_loader.cjs.js +1 -1
- package/dist/cjs/atomic-folded-result-list.cjs.entry.js.map +1 -1
- package/dist/cjs/atomic-insight-result-action-bar.cjs.entry.js +3 -6
- package/dist/cjs/atomic-insight-result-action-bar.cjs.entry.js.map +1 -1
- package/dist/cjs/atomic-recs-interface.cjs.entry.js +1 -1
- package/dist/cjs/atomic-result-list.cjs.entry.js.map +1 -1
- package/dist/cjs/{atomic-result-placeholder_2.cjs.entry.js → atomic-result-placeholder_8.cjs.entry.js} +69 -1
- package/dist/cjs/atomic-result-placeholder_8.cjs.entry.js.map +1 -0
- package/dist/cjs/atomic-result-section-children.cjs.entry.js +23 -0
- package/dist/cjs/atomic-result-section-children.cjs.entry.js.map +1 -0
- package/dist/cjs/atomic-result-section-emphasized.cjs.entry.js +23 -0
- package/dist/cjs/atomic-result-section-emphasized.cjs.entry.js.map +1 -0
- package/dist/cjs/atomic-result-section-title-metadata.cjs.entry.js +23 -0
- package/dist/cjs/atomic-result-section-title-metadata.cjs.entry.js.map +1 -0
- package/dist/cjs/atomic-result.cjs.entry.js +141 -0
- package/dist/cjs/atomic-result.cjs.entry.js.map +1 -0
- package/dist/cjs/atomic.cjs.js +1 -1
- package/dist/cjs/index-757bc886.js +18 -2
- package/dist/cjs/item-section-utils-37848715.js +11 -0
- package/dist/cjs/item-section-utils-37848715.js.map +1 -0
- package/dist/cjs/version.cjs.js +2 -2
- package/dist/esm/_loader.js +1 -1
- package/dist/esm/atomic-folded-result-list.entry.js.map +1 -1
- package/dist/esm/atomic-insight-result-action-bar.entry.js +2 -5
- package/dist/esm/atomic-insight-result-action-bar.entry.js.map +1 -1
- package/dist/esm/atomic-recs-interface.entry.js +1 -1
- package/dist/esm/atomic-result-list.entry.js.map +1 -1
- package/dist/esm/{atomic-result-placeholder_2.entry.js → atomic-result-placeholder_8.entry.js} +65 -3
- package/dist/esm/atomic-result-placeholder_8.entry.js.map +1 -0
- package/dist/esm/atomic-result-section-children.entry.js +19 -0
- package/dist/esm/atomic-result-section-children.entry.js.map +1 -0
- package/dist/esm/atomic-result-section-emphasized.entry.js +19 -0
- package/dist/esm/atomic-result-section-emphasized.entry.js.map +1 -0
- package/dist/esm/atomic-result-section-title-metadata.entry.js +19 -0
- package/dist/esm/atomic-result-section-title-metadata.entry.js.map +1 -0
- package/dist/esm/atomic-result.entry.js +137 -0
- package/dist/esm/atomic-result.entry.js.map +1 -0
- package/dist/esm/atomic.js +1 -1
- package/dist/esm/index-3f35faca.js +18 -2
- package/dist/esm/item-section-utils-d8aa24b7.js +9 -0
- package/dist/esm/item-section-utils-d8aa24b7.js.map +1 -0
- package/dist/esm/version.js +2 -2
- package/dist/types/components/common/layout/item-layout-sections.d.ts +1 -1
- package/dist/types/components/search/atomic-result/atomic-result.d.ts +29 -38
- package/dist/types/components/search/atomic-search-interface/atomic-search-interface.d.ts +0 -1
- package/dist/types/components/search/index.d.ts +0 -10
- package/dist/types/components/search/{atomic-result-section-actions → result-template-components/atomic-result-sections}/atomic-result-section-actions.d.ts +3 -9
- package/dist/types/components/search/{atomic-result-section-badges → result-template-components/atomic-result-sections}/atomic-result-section-badges.d.ts +3 -9
- package/dist/types/components/search/{atomic-result-section-bottom-metadata → result-template-components/atomic-result-sections}/atomic-result-section-bottom-metadata.d.ts +3 -9
- package/dist/types/components/search/result-template-components/atomic-result-sections/atomic-result-section-children.d.ts +10 -0
- package/dist/types/components/search/result-template-components/atomic-result-sections/atomic-result-section-emphasized.d.ts +12 -0
- package/dist/types/components/search/{atomic-result-section-excerpt → result-template-components/atomic-result-sections}/atomic-result-section-excerpt.d.ts +3 -9
- package/dist/types/components/search/result-template-components/atomic-result-sections/atomic-result-section-title-metadata.d.ts +13 -0
- package/dist/types/components/search/{atomic-result-section-title → result-template-components/atomic-result-sections}/atomic-result-section-title.d.ts +3 -9
- package/dist/types/components/search/result-template-components/atomic-result-sections/atomic-result-section-visual.d.ts +20 -0
- package/dist/types/components.d.ts +521 -2
- package/dist/types/mixins/item-section-mixin.d.ts +3 -3
- package/docs/atomic-docs.json +609 -1
- package/package.json +3 -3
- package/dist/atomic/components/components/search/atomic-result/atomic-result.js +0 -218
- package/dist/atomic/components/components/search/atomic-result/atomic-result.tw.css.js +0 -3
- package/dist/atomic/components/components/search/atomic-result-section-actions/atomic-result-section-actions.js +0 -25
- package/dist/atomic/components/components/search/atomic-result-section-badges/atomic-result-section-badges.js +0 -24
- package/dist/atomic/components/components/search/atomic-result-section-bottom-metadata/atomic-result-section-bottom-metadata.js +0 -25
- package/dist/atomic/components/components/search/atomic-result-section-children/atomic-result-section-children.js +0 -21
- package/dist/atomic/components/components/search/atomic-result-section-emphasized/atomic-result-section-emphasized.js +0 -23
- package/dist/atomic/components/components/search/atomic-result-section-excerpt/atomic-result-section-excerpt.js +0 -24
- package/dist/atomic/components/components/search/atomic-result-section-title/atomic-result-section-title.js +0 -24
- package/dist/atomic/components/components/search/atomic-result-section-title-metadata/atomic-result-section-title-metadata.js +0 -24
- package/dist/atomic/components/components/search/atomic-result-section-visual/atomic-result-section-visual.js +0 -29
- package/dist/atomic/components/components/search/result-template-component-utils/context/result-context-controller.js +0 -14
- package/dist/atomic/p-8641e3a9.entry.js +0 -2
- package/dist/atomic/p-8641e3a9.entry.js.map +0 -1
- package/dist/atomic/p-d63acdc6.entry.js +0 -2
- package/dist/atomic/p-d63acdc6.entry.js.map +0 -1
- package/dist/cjs/atomic-result-placeholder_2.cjs.entry.js.map +0 -1
- package/dist/esm/atomic-result-placeholder_2.entry.js.map +0 -1
- package/dist/types/components/search/atomic-result/atomic-result.tw.css.d.ts +0 -2
- package/dist/types/components/search/atomic-result-section-children/atomic-result-section-children.d.ts +0 -16
- package/dist/types/components/search/atomic-result-section-emphasized/atomic-result-section-emphasized.d.ts +0 -18
- package/dist/types/components/search/atomic-result-section-title-metadata/atomic-result-section-title-metadata.d.ts +0 -19
- package/dist/types/components/search/atomic-result-section-visual/atomic-result-section-visual.d.ts +0 -26
- /package/dist/atomic/{p-7303a7dc.entry.js.map → p-1491d8e3.entry.js.map} +0 -0
@@ -5,7 +5,7 @@
|
|
5
5
|
* It contains typing information for all components that exist in this project.
|
6
6
|
*/
|
7
7
|
import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
|
8
|
-
import { AutomaticFacet, CategoryFacetSortCriterion, DateFilterRange, DateRangeRequest, FacetResultsMustMatch, FacetSortCriterion, GeneratedAnswer, GeneratedAnswerCitation, InlineLink, InteractiveCitation, NumericFilter, NumericFilterState, RangeFacetRangeAlgorithm, RangeFacetSortCriterion, RelativeDateUnit, Result, ResultTemplate, ResultTemplateCondition, SearchStatus } from "@coveo/headless";
|
8
|
+
import { AutomaticFacet, CategoryFacetSortCriterion, DateFilterRange, DateRangeRequest, FacetResultsMustMatch, FacetSortCriterion, FoldedResult, GeneratedAnswer, GeneratedAnswerCitation, InlineLink, InteractiveCitation, InteractiveResult, NumericFilter, NumericFilterState, RangeFacetRangeAlgorithm, RangeFacetSortCriterion, RelativeDateUnit, Result, ResultTemplate, ResultTemplateCondition, SearchStatus } from "@coveo/headless";
|
9
9
|
import { AtomicInterface } from "./utils/initialization-utils";
|
10
10
|
import { AnyBindings } from "./components/common/interface/bindings";
|
11
11
|
import { NumberInputType } from "./components/common/facets/facet-number-input/number-input-type";
|
@@ -19,9 +19,10 @@ import { RecommendationEngine, InteractiveResult as RecsInteractiveResult, LogLe
|
|
19
19
|
import { i18n } from "i18next";
|
20
20
|
import { RecsInitializationOptions } from "./components/recommendations/atomic-recs-interface/atomic-recs-interface";
|
21
21
|
import { RecsStore } from "./components/recommendations/atomic-recs-interface/store";
|
22
|
+
import { SearchStore } from "./components/search/atomic-search-interface/store";
|
22
23
|
import { RedirectionPayload } from "./components/common/search-box/redirection-payload";
|
23
24
|
import { SearchBoxSuggestionElement } from "./components/common/suggestions/suggestions-types";
|
24
|
-
export { AutomaticFacet, CategoryFacetSortCriterion, DateFilterRange, DateRangeRequest, FacetResultsMustMatch, FacetSortCriterion, GeneratedAnswer, GeneratedAnswerCitation, InlineLink, InteractiveCitation, NumericFilter, NumericFilterState, RangeFacetRangeAlgorithm, RangeFacetSortCriterion, RelativeDateUnit, Result, ResultTemplate, ResultTemplateCondition, SearchStatus } from "@coveo/headless";
|
25
|
+
export { AutomaticFacet, CategoryFacetSortCriterion, DateFilterRange, DateRangeRequest, FacetResultsMustMatch, FacetSortCriterion, FoldedResult, GeneratedAnswer, GeneratedAnswerCitation, InlineLink, InteractiveCitation, InteractiveResult, NumericFilter, NumericFilterState, RangeFacetRangeAlgorithm, RangeFacetSortCriterion, RelativeDateUnit, Result, ResultTemplate, ResultTemplateCondition, SearchStatus } from "@coveo/headless";
|
25
26
|
export { AtomicInterface } from "./utils/initialization-utils";
|
26
27
|
export { AnyBindings } from "./components/common/interface/bindings";
|
27
28
|
export { NumberInputType } from "./components/common/facets/facet-number-input/number-input-type";
|
@@ -35,6 +36,7 @@ export { RecommendationEngine, InteractiveResult as RecsInteractiveResult, LogLe
|
|
35
36
|
export { i18n } from "i18next";
|
36
37
|
export { RecsInitializationOptions } from "./components/recommendations/atomic-recs-interface/atomic-recs-interface";
|
37
38
|
export { RecsStore } from "./components/recommendations/atomic-recs-interface/store";
|
39
|
+
export { SearchStore } from "./components/search/atomic-search-interface/store";
|
38
40
|
export { RedirectionPayload } from "./components/common/search-box/redirection-payload";
|
39
41
|
export { SearchBoxSuggestionElement } from "./components/common/suggestions/suggestions-types";
|
40
42
|
export namespace Components {
|
@@ -1758,6 +1760,57 @@ export namespace Components {
|
|
1758
1760
|
*/
|
1759
1761
|
"collapseFacetsAfter": number;
|
1760
1762
|
}
|
1763
|
+
/**
|
1764
|
+
* The `atomic-result` component is used internally by the `atomic-result-list` component.
|
1765
|
+
*/
|
1766
|
+
interface AtomicResult {
|
1767
|
+
/**
|
1768
|
+
* The classes to add to the result element.
|
1769
|
+
*/
|
1770
|
+
"classes": string;
|
1771
|
+
/**
|
1772
|
+
* The result content to display.
|
1773
|
+
*/
|
1774
|
+
"content"?: ParentNode;
|
1775
|
+
/**
|
1776
|
+
* How large or small results should be.
|
1777
|
+
*/
|
1778
|
+
"density": ItemDisplayDensity;
|
1779
|
+
/**
|
1780
|
+
* How results should be displayed.
|
1781
|
+
*/
|
1782
|
+
"display": ItemDisplayLayout;
|
1783
|
+
/**
|
1784
|
+
* The size of the visual section in result list items. This is overwritten by the image size defined in the result content, if it exists.
|
1785
|
+
*/
|
1786
|
+
"imageSize": ItemDisplayImageSize;
|
1787
|
+
/**
|
1788
|
+
* The InteractiveResult item.
|
1789
|
+
*/
|
1790
|
+
"interactiveResult": InteractiveResult;
|
1791
|
+
/**
|
1792
|
+
* The result link to use when the result is clicked in a grid layout.
|
1793
|
+
* @default - An `atomic-result-link` without any customization.
|
1794
|
+
*/
|
1795
|
+
"linkContent": ParentNode;
|
1796
|
+
"loadingFlag"?: string;
|
1797
|
+
/**
|
1798
|
+
* Internal function used by atomic-recs-list in advanced setups, which lets you bypass the standard HTML template system. Particularly useful for Atomic React
|
1799
|
+
*/
|
1800
|
+
"renderingFunction": ItemRenderingFunction;
|
1801
|
+
/**
|
1802
|
+
* The result item.
|
1803
|
+
*/
|
1804
|
+
"result": Result | FoldedResult;
|
1805
|
+
/**
|
1806
|
+
* Whether an atomic-result-link inside atomic-result should stop click event propagation.
|
1807
|
+
*/
|
1808
|
+
"stopPropagation"?: boolean;
|
1809
|
+
/**
|
1810
|
+
* Global Atomic state.
|
1811
|
+
*/
|
1812
|
+
"store"?: SearchStore;
|
1813
|
+
}
|
1761
1814
|
/**
|
1762
1815
|
* The `atomic-result-badge` element renders a badge to highlight special features of a result.
|
1763
1816
|
* A badge can either display:
|
@@ -2038,6 +2091,100 @@ export namespace Components {
|
|
2038
2091
|
*/
|
2039
2092
|
"maxValueInIndex": number;
|
2040
2093
|
}
|
2094
|
+
/**
|
2095
|
+
* This section allows the information seeker to perform an action on an item without having to view its details.
|
2096
|
+
* For example, in Commerce you can add an item to the cart directly or add it to a wish list to view at a later time.
|
2097
|
+
* Behavior:
|
2098
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
2099
|
+
* ** You should ensure that elements inside of it have `height: var(--line-height)`.
|
2100
|
+
* * Is a wrapping flexbox with a gap.
|
2101
|
+
* * May appear over, next to, or beneath the visual section.
|
2102
|
+
*/
|
2103
|
+
interface AtomicResultSectionActions {
|
2104
|
+
}
|
2105
|
+
/**
|
2106
|
+
* This section provides badges that highlight special features of the item.
|
2107
|
+
* Behavior:
|
2108
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
2109
|
+
* ** You should ensure that elements inside of it have `height: var(--line-height)`.
|
2110
|
+
* * Is a wrapping flexbox with a gap.
|
2111
|
+
* * May appear over, next to, or beneath the visual section.
|
2112
|
+
*/
|
2113
|
+
interface AtomicResultSectionBadges {
|
2114
|
+
}
|
2115
|
+
/**
|
2116
|
+
* This section displays additional descriptive information about the item.
|
2117
|
+
* Behavior:
|
2118
|
+
* * Has a maximum height of two lines.
|
2119
|
+
* ** We recommend that you use `atomic-result-fields-list` to ensure that the fields in this section don’t overflow.
|
2120
|
+
* * Exposes the `--line-height` variable so child elements can adjust to the current line height.
|
2121
|
+
* * Has a defined CSS `color` property for text.
|
2122
|
+
* * Has a font weight.
|
2123
|
+
*/
|
2124
|
+
interface AtomicResultSectionBottomMetadata {
|
2125
|
+
}
|
2126
|
+
/**
|
2127
|
+
* This section displays the folded results, available when using the <atomic-result-children> component.
|
2128
|
+
* Behavior:
|
2129
|
+
* * Shows children at the bottom of the result, indented and wrapped in a border.
|
2130
|
+
*/
|
2131
|
+
interface AtomicResultSectionChildren {
|
2132
|
+
}
|
2133
|
+
/**
|
2134
|
+
* This section displays the field that's important for its search criteria.
|
2135
|
+
* For example, in Commerce, a product's cost is often more important than the title itself.
|
2136
|
+
* Behavior:
|
2137
|
+
* * Has a very large font size.
|
2138
|
+
* * Is the second closest element beneath the title section.
|
2139
|
+
*/
|
2140
|
+
interface AtomicResultSectionEmphasized {
|
2141
|
+
}
|
2142
|
+
/**
|
2143
|
+
* This section contains an informative summary of the item's content.
|
2144
|
+
* Behavior:
|
2145
|
+
* * Has a fixed height of one to three lines, depending on the layout and density.
|
2146
|
+
* * Ellipses overflowing text.
|
2147
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
2148
|
+
* * Has a defined CSS `color` property for text.
|
2149
|
+
*/
|
2150
|
+
interface AtomicResultSectionExcerpt {
|
2151
|
+
}
|
2152
|
+
/**
|
2153
|
+
* This section identifies the item by its name, and its main use is to make the result list scannable.
|
2154
|
+
* This is usually the page title.
|
2155
|
+
* Behavior:
|
2156
|
+
* * Has a fixed height of two lines on grid layouts.
|
2157
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
2158
|
+
* * Has a defined CSS `color` property for text.
|
2159
|
+
*/
|
2160
|
+
interface AtomicResultSectionTitle {
|
2161
|
+
}
|
2162
|
+
/**
|
2163
|
+
* This section surfaces some fields that are directly related to the title of the item.
|
2164
|
+
* For example, in Commerce, this could be the item's rating, which is tied to the nature of the product itself,
|
2165
|
+
* rather than to the product's description.
|
2166
|
+
* Behavior:
|
2167
|
+
* * Has a very small font size.
|
2168
|
+
* * Is the closest element beneath the title section.
|
2169
|
+
*/
|
2170
|
+
interface AtomicResultSectionTitleMetadata {
|
2171
|
+
}
|
2172
|
+
/**
|
2173
|
+
* This section provides visual information about the item.
|
2174
|
+
* For example, in Commerce, an image is a great shorthand for a product category.
|
2175
|
+
* An icon can quickly show the item type, or an avatar can help identify to whom it is related.
|
2176
|
+
* Behavior:
|
2177
|
+
* * Has a fixed size that depends on the specified image size, the layout, the density, and the screen size.
|
2178
|
+
* ** When the image size is set to `icon`, this section stays very small.
|
2179
|
+
* ** You should ensure that elements inside of it take the available space.
|
2180
|
+
* * Always has a 1:1 aspect ratio.
|
2181
|
+
*/
|
2182
|
+
interface AtomicResultSectionVisual {
|
2183
|
+
/**
|
2184
|
+
* How large or small the visual section of results using this template should be.
|
2185
|
+
*/
|
2186
|
+
"imageSize"?: ItemDisplayImageSize;
|
2187
|
+
}
|
2041
2188
|
/**
|
2042
2189
|
* The `atomic-result-table-placeholder` component provides an intermediate visual state that is rendered before the first results are available.
|
2043
2190
|
*/
|
@@ -3369,6 +3516,15 @@ declare global {
|
|
3369
3516
|
prototype: HTMLAtomicRefineToggleElement;
|
3370
3517
|
new (): HTMLAtomicRefineToggleElement;
|
3371
3518
|
};
|
3519
|
+
/**
|
3520
|
+
* The `atomic-result` component is used internally by the `atomic-result-list` component.
|
3521
|
+
*/
|
3522
|
+
interface HTMLAtomicResultElement extends Components.AtomicResult, HTMLStencilElement {
|
3523
|
+
}
|
3524
|
+
var HTMLAtomicResultElement: {
|
3525
|
+
prototype: HTMLAtomicResultElement;
|
3526
|
+
new (): HTMLAtomicResultElement;
|
3527
|
+
};
|
3372
3528
|
/**
|
3373
3529
|
* The `atomic-result-badge` element renders a badge to highlight special features of a result.
|
3374
3530
|
* A badge can either display:
|
@@ -3557,6 +3713,132 @@ declare global {
|
|
3557
3713
|
prototype: HTMLAtomicResultRatingElement;
|
3558
3714
|
new (): HTMLAtomicResultRatingElement;
|
3559
3715
|
};
|
3716
|
+
/**
|
3717
|
+
* This section allows the information seeker to perform an action on an item without having to view its details.
|
3718
|
+
* For example, in Commerce you can add an item to the cart directly or add it to a wish list to view at a later time.
|
3719
|
+
* Behavior:
|
3720
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
3721
|
+
* ** You should ensure that elements inside of it have `height: var(--line-height)`.
|
3722
|
+
* * Is a wrapping flexbox with a gap.
|
3723
|
+
* * May appear over, next to, or beneath the visual section.
|
3724
|
+
*/
|
3725
|
+
interface HTMLAtomicResultSectionActionsElement extends Components.AtomicResultSectionActions, HTMLStencilElement {
|
3726
|
+
}
|
3727
|
+
var HTMLAtomicResultSectionActionsElement: {
|
3728
|
+
prototype: HTMLAtomicResultSectionActionsElement;
|
3729
|
+
new (): HTMLAtomicResultSectionActionsElement;
|
3730
|
+
};
|
3731
|
+
/**
|
3732
|
+
* This section provides badges that highlight special features of the item.
|
3733
|
+
* Behavior:
|
3734
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
3735
|
+
* ** You should ensure that elements inside of it have `height: var(--line-height)`.
|
3736
|
+
* * Is a wrapping flexbox with a gap.
|
3737
|
+
* * May appear over, next to, or beneath the visual section.
|
3738
|
+
*/
|
3739
|
+
interface HTMLAtomicResultSectionBadgesElement extends Components.AtomicResultSectionBadges, HTMLStencilElement {
|
3740
|
+
}
|
3741
|
+
var HTMLAtomicResultSectionBadgesElement: {
|
3742
|
+
prototype: HTMLAtomicResultSectionBadgesElement;
|
3743
|
+
new (): HTMLAtomicResultSectionBadgesElement;
|
3744
|
+
};
|
3745
|
+
/**
|
3746
|
+
* This section displays additional descriptive information about the item.
|
3747
|
+
* Behavior:
|
3748
|
+
* * Has a maximum height of two lines.
|
3749
|
+
* ** We recommend that you use `atomic-result-fields-list` to ensure that the fields in this section don’t overflow.
|
3750
|
+
* * Exposes the `--line-height` variable so child elements can adjust to the current line height.
|
3751
|
+
* * Has a defined CSS `color` property for text.
|
3752
|
+
* * Has a font weight.
|
3753
|
+
*/
|
3754
|
+
interface HTMLAtomicResultSectionBottomMetadataElement extends Components.AtomicResultSectionBottomMetadata, HTMLStencilElement {
|
3755
|
+
}
|
3756
|
+
var HTMLAtomicResultSectionBottomMetadataElement: {
|
3757
|
+
prototype: HTMLAtomicResultSectionBottomMetadataElement;
|
3758
|
+
new (): HTMLAtomicResultSectionBottomMetadataElement;
|
3759
|
+
};
|
3760
|
+
/**
|
3761
|
+
* This section displays the folded results, available when using the <atomic-result-children> component.
|
3762
|
+
* Behavior:
|
3763
|
+
* * Shows children at the bottom of the result, indented and wrapped in a border.
|
3764
|
+
*/
|
3765
|
+
interface HTMLAtomicResultSectionChildrenElement extends Components.AtomicResultSectionChildren, HTMLStencilElement {
|
3766
|
+
}
|
3767
|
+
var HTMLAtomicResultSectionChildrenElement: {
|
3768
|
+
prototype: HTMLAtomicResultSectionChildrenElement;
|
3769
|
+
new (): HTMLAtomicResultSectionChildrenElement;
|
3770
|
+
};
|
3771
|
+
/**
|
3772
|
+
* This section displays the field that's important for its search criteria.
|
3773
|
+
* For example, in Commerce, a product's cost is often more important than the title itself.
|
3774
|
+
* Behavior:
|
3775
|
+
* * Has a very large font size.
|
3776
|
+
* * Is the second closest element beneath the title section.
|
3777
|
+
*/
|
3778
|
+
interface HTMLAtomicResultSectionEmphasizedElement extends Components.AtomicResultSectionEmphasized, HTMLStencilElement {
|
3779
|
+
}
|
3780
|
+
var HTMLAtomicResultSectionEmphasizedElement: {
|
3781
|
+
prototype: HTMLAtomicResultSectionEmphasizedElement;
|
3782
|
+
new (): HTMLAtomicResultSectionEmphasizedElement;
|
3783
|
+
};
|
3784
|
+
/**
|
3785
|
+
* This section contains an informative summary of the item's content.
|
3786
|
+
* Behavior:
|
3787
|
+
* * Has a fixed height of one to three lines, depending on the layout and density.
|
3788
|
+
* * Ellipses overflowing text.
|
3789
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
3790
|
+
* * Has a defined CSS `color` property for text.
|
3791
|
+
*/
|
3792
|
+
interface HTMLAtomicResultSectionExcerptElement extends Components.AtomicResultSectionExcerpt, HTMLStencilElement {
|
3793
|
+
}
|
3794
|
+
var HTMLAtomicResultSectionExcerptElement: {
|
3795
|
+
prototype: HTMLAtomicResultSectionExcerptElement;
|
3796
|
+
new (): HTMLAtomicResultSectionExcerptElement;
|
3797
|
+
};
|
3798
|
+
/**
|
3799
|
+
* This section identifies the item by its name, and its main use is to make the result list scannable.
|
3800
|
+
* This is usually the page title.
|
3801
|
+
* Behavior:
|
3802
|
+
* * Has a fixed height of two lines on grid layouts.
|
3803
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
3804
|
+
* * Has a defined CSS `color` property for text.
|
3805
|
+
*/
|
3806
|
+
interface HTMLAtomicResultSectionTitleElement extends Components.AtomicResultSectionTitle, HTMLStencilElement {
|
3807
|
+
}
|
3808
|
+
var HTMLAtomicResultSectionTitleElement: {
|
3809
|
+
prototype: HTMLAtomicResultSectionTitleElement;
|
3810
|
+
new (): HTMLAtomicResultSectionTitleElement;
|
3811
|
+
};
|
3812
|
+
/**
|
3813
|
+
* This section surfaces some fields that are directly related to the title of the item.
|
3814
|
+
* For example, in Commerce, this could be the item's rating, which is tied to the nature of the product itself,
|
3815
|
+
* rather than to the product's description.
|
3816
|
+
* Behavior:
|
3817
|
+
* * Has a very small font size.
|
3818
|
+
* * Is the closest element beneath the title section.
|
3819
|
+
*/
|
3820
|
+
interface HTMLAtomicResultSectionTitleMetadataElement extends Components.AtomicResultSectionTitleMetadata, HTMLStencilElement {
|
3821
|
+
}
|
3822
|
+
var HTMLAtomicResultSectionTitleMetadataElement: {
|
3823
|
+
prototype: HTMLAtomicResultSectionTitleMetadataElement;
|
3824
|
+
new (): HTMLAtomicResultSectionTitleMetadataElement;
|
3825
|
+
};
|
3826
|
+
/**
|
3827
|
+
* This section provides visual information about the item.
|
3828
|
+
* For example, in Commerce, an image is a great shorthand for a product category.
|
3829
|
+
* An icon can quickly show the item type, or an avatar can help identify to whom it is related.
|
3830
|
+
* Behavior:
|
3831
|
+
* * Has a fixed size that depends on the specified image size, the layout, the density, and the screen size.
|
3832
|
+
* ** When the image size is set to `icon`, this section stays very small.
|
3833
|
+
* ** You should ensure that elements inside of it take the available space.
|
3834
|
+
* * Always has a 1:1 aspect ratio.
|
3835
|
+
*/
|
3836
|
+
interface HTMLAtomicResultSectionVisualElement extends Components.AtomicResultSectionVisual, HTMLStencilElement {
|
3837
|
+
}
|
3838
|
+
var HTMLAtomicResultSectionVisualElement: {
|
3839
|
+
prototype: HTMLAtomicResultSectionVisualElement;
|
3840
|
+
new (): HTMLAtomicResultSectionVisualElement;
|
3841
|
+
};
|
3560
3842
|
/**
|
3561
3843
|
* The `atomic-result-table-placeholder` component provides an intermediate visual state that is rendered before the first results are available.
|
3562
3844
|
*/
|
@@ -3974,6 +4256,7 @@ declare global {
|
|
3974
4256
|
"atomic-recs-result-template": HTMLAtomicRecsResultTemplateElement;
|
3975
4257
|
"atomic-refine-modal": HTMLAtomicRefineModalElement;
|
3976
4258
|
"atomic-refine-toggle": HTMLAtomicRefineToggleElement;
|
4259
|
+
"atomic-result": HTMLAtomicResultElement;
|
3977
4260
|
"atomic-result-badge": HTMLAtomicResultBadgeElement;
|
3978
4261
|
"atomic-result-children": HTMLAtomicResultChildrenElement;
|
3979
4262
|
"atomic-result-children-template": HTMLAtomicResultChildrenTemplateElement;
|
@@ -3990,6 +4273,15 @@ declare global {
|
|
3990
4273
|
"atomic-result-placeholder": HTMLAtomicResultPlaceholderElement;
|
3991
4274
|
"atomic-result-printable-uri": HTMLAtomicResultPrintableUriElement;
|
3992
4275
|
"atomic-result-rating": HTMLAtomicResultRatingElement;
|
4276
|
+
"atomic-result-section-actions": HTMLAtomicResultSectionActionsElement;
|
4277
|
+
"atomic-result-section-badges": HTMLAtomicResultSectionBadgesElement;
|
4278
|
+
"atomic-result-section-bottom-metadata": HTMLAtomicResultSectionBottomMetadataElement;
|
4279
|
+
"atomic-result-section-children": HTMLAtomicResultSectionChildrenElement;
|
4280
|
+
"atomic-result-section-emphasized": HTMLAtomicResultSectionEmphasizedElement;
|
4281
|
+
"atomic-result-section-excerpt": HTMLAtomicResultSectionExcerptElement;
|
4282
|
+
"atomic-result-section-title": HTMLAtomicResultSectionTitleElement;
|
4283
|
+
"atomic-result-section-title-metadata": HTMLAtomicResultSectionTitleMetadataElement;
|
4284
|
+
"atomic-result-section-visual": HTMLAtomicResultSectionVisualElement;
|
3993
4285
|
"atomic-result-table-placeholder": HTMLAtomicResultTablePlaceholderElement;
|
3994
4286
|
"atomic-result-template": HTMLAtomicResultTemplateElement;
|
3995
4287
|
"atomic-result-text": HTMLAtomicResultTextElement;
|
@@ -5651,6 +5943,44 @@ declare namespace LocalJSX {
|
|
5651
5943
|
*/
|
5652
5944
|
"collapseFacetsAfter"?: number;
|
5653
5945
|
}
|
5946
|
+
/**
|
5947
|
+
* The `atomic-result` component is used internally by the `atomic-result-list` component.
|
5948
|
+
*/
|
5949
|
+
interface AtomicResult {
|
5950
|
+
/**
|
5951
|
+
* The classes to add to the result element.
|
5952
|
+
*/
|
5953
|
+
"classes"?: string;
|
5954
|
+
/**
|
5955
|
+
* The result content to display.
|
5956
|
+
*/
|
5957
|
+
"content"?: ParentNode;
|
5958
|
+
/**
|
5959
|
+
* How large or small results should be.
|
5960
|
+
*/
|
5961
|
+
"density"?: ItemDisplayDensity;
|
5962
|
+
/**
|
5963
|
+
* How results should be displayed.
|
5964
|
+
*/
|
5965
|
+
"display"?: ItemDisplayLayout;
|
5966
|
+
/**
|
5967
|
+
* The size of the visual section in result list items. This is overwritten by the image size defined in the result content, if it exists.
|
5968
|
+
*/
|
5969
|
+
"imageSize"?: ItemDisplayImageSize;
|
5970
|
+
/**
|
5971
|
+
* The result link to use when the result is clicked in a grid layout.
|
5972
|
+
* @default - An `atomic-result-link` without any customization.
|
5973
|
+
*/
|
5974
|
+
"linkContent"?: ParentNode;
|
5975
|
+
/**
|
5976
|
+
* The result item.
|
5977
|
+
*/
|
5978
|
+
"result": Result | FoldedResult;
|
5979
|
+
/**
|
5980
|
+
* Whether an atomic-result-link inside atomic-result should stop click event propagation.
|
5981
|
+
*/
|
5982
|
+
"stopPropagation"?: boolean;
|
5983
|
+
}
|
5654
5984
|
/**
|
5655
5985
|
* The `atomic-result-badge` element renders a badge to highlight special features of a result.
|
5656
5986
|
* A badge can either display:
|
@@ -5922,6 +6252,100 @@ declare namespace LocalJSX {
|
|
5922
6252
|
*/
|
5923
6253
|
"maxValueInIndex"?: number;
|
5924
6254
|
}
|
6255
|
+
/**
|
6256
|
+
* This section allows the information seeker to perform an action on an item without having to view its details.
|
6257
|
+
* For example, in Commerce you can add an item to the cart directly or add it to a wish list to view at a later time.
|
6258
|
+
* Behavior:
|
6259
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
6260
|
+
* ** You should ensure that elements inside of it have `height: var(--line-height)`.
|
6261
|
+
* * Is a wrapping flexbox with a gap.
|
6262
|
+
* * May appear over, next to, or beneath the visual section.
|
6263
|
+
*/
|
6264
|
+
interface AtomicResultSectionActions {
|
6265
|
+
}
|
6266
|
+
/**
|
6267
|
+
* This section provides badges that highlight special features of the item.
|
6268
|
+
* Behavior:
|
6269
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
6270
|
+
* ** You should ensure that elements inside of it have `height: var(--line-height)`.
|
6271
|
+
* * Is a wrapping flexbox with a gap.
|
6272
|
+
* * May appear over, next to, or beneath the visual section.
|
6273
|
+
*/
|
6274
|
+
interface AtomicResultSectionBadges {
|
6275
|
+
}
|
6276
|
+
/**
|
6277
|
+
* This section displays additional descriptive information about the item.
|
6278
|
+
* Behavior:
|
6279
|
+
* * Has a maximum height of two lines.
|
6280
|
+
* ** We recommend that you use `atomic-result-fields-list` to ensure that the fields in this section don’t overflow.
|
6281
|
+
* * Exposes the `--line-height` variable so child elements can adjust to the current line height.
|
6282
|
+
* * Has a defined CSS `color` property for text.
|
6283
|
+
* * Has a font weight.
|
6284
|
+
*/
|
6285
|
+
interface AtomicResultSectionBottomMetadata {
|
6286
|
+
}
|
6287
|
+
/**
|
6288
|
+
* This section displays the folded results, available when using the <atomic-result-children> component.
|
6289
|
+
* Behavior:
|
6290
|
+
* * Shows children at the bottom of the result, indented and wrapped in a border.
|
6291
|
+
*/
|
6292
|
+
interface AtomicResultSectionChildren {
|
6293
|
+
}
|
6294
|
+
/**
|
6295
|
+
* This section displays the field that's important for its search criteria.
|
6296
|
+
* For example, in Commerce, a product's cost is often more important than the title itself.
|
6297
|
+
* Behavior:
|
6298
|
+
* * Has a very large font size.
|
6299
|
+
* * Is the second closest element beneath the title section.
|
6300
|
+
*/
|
6301
|
+
interface AtomicResultSectionEmphasized {
|
6302
|
+
}
|
6303
|
+
/**
|
6304
|
+
* This section contains an informative summary of the item's content.
|
6305
|
+
* Behavior:
|
6306
|
+
* * Has a fixed height of one to three lines, depending on the layout and density.
|
6307
|
+
* * Ellipses overflowing text.
|
6308
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
6309
|
+
* * Has a defined CSS `color` property for text.
|
6310
|
+
*/
|
6311
|
+
interface AtomicResultSectionExcerpt {
|
6312
|
+
}
|
6313
|
+
/**
|
6314
|
+
* This section identifies the item by its name, and its main use is to make the result list scannable.
|
6315
|
+
* This is usually the page title.
|
6316
|
+
* Behavior:
|
6317
|
+
* * Has a fixed height of two lines on grid layouts.
|
6318
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
6319
|
+
* * Has a defined CSS `color` property for text.
|
6320
|
+
*/
|
6321
|
+
interface AtomicResultSectionTitle {
|
6322
|
+
}
|
6323
|
+
/**
|
6324
|
+
* This section surfaces some fields that are directly related to the title of the item.
|
6325
|
+
* For example, in Commerce, this could be the item's rating, which is tied to the nature of the product itself,
|
6326
|
+
* rather than to the product's description.
|
6327
|
+
* Behavior:
|
6328
|
+
* * Has a very small font size.
|
6329
|
+
* * Is the closest element beneath the title section.
|
6330
|
+
*/
|
6331
|
+
interface AtomicResultSectionTitleMetadata {
|
6332
|
+
}
|
6333
|
+
/**
|
6334
|
+
* This section provides visual information about the item.
|
6335
|
+
* For example, in Commerce, an image is a great shorthand for a product category.
|
6336
|
+
* An icon can quickly show the item type, or an avatar can help identify to whom it is related.
|
6337
|
+
* Behavior:
|
6338
|
+
* * Has a fixed size that depends on the specified image size, the layout, the density, and the screen size.
|
6339
|
+
* ** When the image size is set to `icon`, this section stays very small.
|
6340
|
+
* ** You should ensure that elements inside of it take the available space.
|
6341
|
+
* * Always has a 1:1 aspect ratio.
|
6342
|
+
*/
|
6343
|
+
interface AtomicResultSectionVisual {
|
6344
|
+
/**
|
6345
|
+
* How large or small the visual section of results using this template should be.
|
6346
|
+
*/
|
6347
|
+
"imageSize"?: ItemDisplayImageSize;
|
6348
|
+
}
|
5925
6349
|
/**
|
5926
6350
|
* The `atomic-result-table-placeholder` component provides an intermediate visual state that is rendered before the first results are available.
|
5927
6351
|
*/
|
@@ -6502,6 +6926,7 @@ declare namespace LocalJSX {
|
|
6502
6926
|
"atomic-recs-result-template": AtomicRecsResultTemplate;
|
6503
6927
|
"atomic-refine-modal": AtomicRefineModal;
|
6504
6928
|
"atomic-refine-toggle": AtomicRefineToggle;
|
6929
|
+
"atomic-result": AtomicResult;
|
6505
6930
|
"atomic-result-badge": AtomicResultBadge;
|
6506
6931
|
"atomic-result-children": AtomicResultChildren;
|
6507
6932
|
"atomic-result-children-template": AtomicResultChildrenTemplate;
|
@@ -6518,6 +6943,15 @@ declare namespace LocalJSX {
|
|
6518
6943
|
"atomic-result-placeholder": AtomicResultPlaceholder;
|
6519
6944
|
"atomic-result-printable-uri": AtomicResultPrintableUri;
|
6520
6945
|
"atomic-result-rating": AtomicResultRating;
|
6946
|
+
"atomic-result-section-actions": AtomicResultSectionActions;
|
6947
|
+
"atomic-result-section-badges": AtomicResultSectionBadges;
|
6948
|
+
"atomic-result-section-bottom-metadata": AtomicResultSectionBottomMetadata;
|
6949
|
+
"atomic-result-section-children": AtomicResultSectionChildren;
|
6950
|
+
"atomic-result-section-emphasized": AtomicResultSectionEmphasized;
|
6951
|
+
"atomic-result-section-excerpt": AtomicResultSectionExcerpt;
|
6952
|
+
"atomic-result-section-title": AtomicResultSectionTitle;
|
6953
|
+
"atomic-result-section-title-metadata": AtomicResultSectionTitleMetadata;
|
6954
|
+
"atomic-result-section-visual": AtomicResultSectionVisual;
|
6521
6955
|
"atomic-result-table-placeholder": AtomicResultTablePlaceholder;
|
6522
6956
|
"atomic-result-template": AtomicResultTemplate;
|
6523
6957
|
"atomic-result-text": AtomicResultText;
|
@@ -6804,6 +7238,10 @@ declare module "@stencil/core" {
|
|
6804
7238
|
* When this component is added to the `atomic-search-interface`, an `atomic-refine-modal` component is automatically created.
|
6805
7239
|
*/
|
6806
7240
|
"atomic-refine-toggle": LocalJSX.AtomicRefineToggle & JSXBase.HTMLAttributes<HTMLAtomicRefineToggleElement>;
|
7241
|
+
/**
|
7242
|
+
* The `atomic-result` component is used internally by the `atomic-result-list` component.
|
7243
|
+
*/
|
7244
|
+
"atomic-result": LocalJSX.AtomicResult & JSXBase.HTMLAttributes<HTMLAtomicResultElement>;
|
6807
7245
|
/**
|
6808
7246
|
* The `atomic-result-badge` element renders a badge to highlight special features of a result.
|
6809
7247
|
* A badge can either display:
|
@@ -6912,6 +7350,87 @@ declare module "@stencil/core" {
|
|
6912
7350
|
* The `atomic-result-rating` element renders a star rating.
|
6913
7351
|
*/
|
6914
7352
|
"atomic-result-rating": LocalJSX.AtomicResultRating & JSXBase.HTMLAttributes<HTMLAtomicResultRatingElement>;
|
7353
|
+
/**
|
7354
|
+
* This section allows the information seeker to perform an action on an item without having to view its details.
|
7355
|
+
* For example, in Commerce you can add an item to the cart directly or add it to a wish list to view at a later time.
|
7356
|
+
* Behavior:
|
7357
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
7358
|
+
* ** You should ensure that elements inside of it have `height: var(--line-height)`.
|
7359
|
+
* * Is a wrapping flexbox with a gap.
|
7360
|
+
* * May appear over, next to, or beneath the visual section.
|
7361
|
+
*/
|
7362
|
+
"atomic-result-section-actions": LocalJSX.AtomicResultSectionActions & JSXBase.HTMLAttributes<HTMLAtomicResultSectionActionsElement>;
|
7363
|
+
/**
|
7364
|
+
* This section provides badges that highlight special features of the item.
|
7365
|
+
* Behavior:
|
7366
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
7367
|
+
* ** You should ensure that elements inside of it have `height: var(--line-height)`.
|
7368
|
+
* * Is a wrapping flexbox with a gap.
|
7369
|
+
* * May appear over, next to, or beneath the visual section.
|
7370
|
+
*/
|
7371
|
+
"atomic-result-section-badges": LocalJSX.AtomicResultSectionBadges & JSXBase.HTMLAttributes<HTMLAtomicResultSectionBadgesElement>;
|
7372
|
+
/**
|
7373
|
+
* This section displays additional descriptive information about the item.
|
7374
|
+
* Behavior:
|
7375
|
+
* * Has a maximum height of two lines.
|
7376
|
+
* ** We recommend that you use `atomic-result-fields-list` to ensure that the fields in this section don’t overflow.
|
7377
|
+
* * Exposes the `--line-height` variable so child elements can adjust to the current line height.
|
7378
|
+
* * Has a defined CSS `color` property for text.
|
7379
|
+
* * Has a font weight.
|
7380
|
+
*/
|
7381
|
+
"atomic-result-section-bottom-metadata": LocalJSX.AtomicResultSectionBottomMetadata & JSXBase.HTMLAttributes<HTMLAtomicResultSectionBottomMetadataElement>;
|
7382
|
+
/**
|
7383
|
+
* This section displays the folded results, available when using the <atomic-result-children> component.
|
7384
|
+
* Behavior:
|
7385
|
+
* * Shows children at the bottom of the result, indented and wrapped in a border.
|
7386
|
+
*/
|
7387
|
+
"atomic-result-section-children": LocalJSX.AtomicResultSectionChildren & JSXBase.HTMLAttributes<HTMLAtomicResultSectionChildrenElement>;
|
7388
|
+
/**
|
7389
|
+
* This section displays the field that's important for its search criteria.
|
7390
|
+
* For example, in Commerce, a product's cost is often more important than the title itself.
|
7391
|
+
* Behavior:
|
7392
|
+
* * Has a very large font size.
|
7393
|
+
* * Is the second closest element beneath the title section.
|
7394
|
+
*/
|
7395
|
+
"atomic-result-section-emphasized": LocalJSX.AtomicResultSectionEmphasized & JSXBase.HTMLAttributes<HTMLAtomicResultSectionEmphasizedElement>;
|
7396
|
+
/**
|
7397
|
+
* This section contains an informative summary of the item's content.
|
7398
|
+
* Behavior:
|
7399
|
+
* * Has a fixed height of one to three lines, depending on the layout and density.
|
7400
|
+
* * Ellipses overflowing text.
|
7401
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
7402
|
+
* * Has a defined CSS `color` property for text.
|
7403
|
+
*/
|
7404
|
+
"atomic-result-section-excerpt": LocalJSX.AtomicResultSectionExcerpt & JSXBase.HTMLAttributes<HTMLAtomicResultSectionExcerptElement>;
|
7405
|
+
/**
|
7406
|
+
* This section identifies the item by its name, and its main use is to make the result list scannable.
|
7407
|
+
* This is usually the page title.
|
7408
|
+
* Behavior:
|
7409
|
+
* * Has a fixed height of two lines on grid layouts.
|
7410
|
+
* * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
|
7411
|
+
* * Has a defined CSS `color` property for text.
|
7412
|
+
*/
|
7413
|
+
"atomic-result-section-title": LocalJSX.AtomicResultSectionTitle & JSXBase.HTMLAttributes<HTMLAtomicResultSectionTitleElement>;
|
7414
|
+
/**
|
7415
|
+
* This section surfaces some fields that are directly related to the title of the item.
|
7416
|
+
* For example, in Commerce, this could be the item's rating, which is tied to the nature of the product itself,
|
7417
|
+
* rather than to the product's description.
|
7418
|
+
* Behavior:
|
7419
|
+
* * Has a very small font size.
|
7420
|
+
* * Is the closest element beneath the title section.
|
7421
|
+
*/
|
7422
|
+
"atomic-result-section-title-metadata": LocalJSX.AtomicResultSectionTitleMetadata & JSXBase.HTMLAttributes<HTMLAtomicResultSectionTitleMetadataElement>;
|
7423
|
+
/**
|
7424
|
+
* This section provides visual information about the item.
|
7425
|
+
* For example, in Commerce, an image is a great shorthand for a product category.
|
7426
|
+
* An icon can quickly show the item type, or an avatar can help identify to whom it is related.
|
7427
|
+
* Behavior:
|
7428
|
+
* * Has a fixed size that depends on the specified image size, the layout, the density, and the screen size.
|
7429
|
+
* ** When the image size is set to `icon`, this section stays very small.
|
7430
|
+
* ** You should ensure that elements inside of it take the available space.
|
7431
|
+
* * Always has a 1:1 aspect ratio.
|
7432
|
+
*/
|
7433
|
+
"atomic-result-section-visual": LocalJSX.AtomicResultSectionVisual & JSXBase.HTMLAttributes<HTMLAtomicResultSectionVisualElement>;
|
6915
7434
|
/**
|
6916
7435
|
* The `atomic-result-table-placeholder` component provides an intermediate visual state that is rendered before the first results are available.
|
6917
7436
|
*/
|
@@ -1,11 +1,11 @@
|
|
1
1
|
import type { CSSResultGroup, LitElement } from 'lit';
|
2
2
|
import type { Constructor } from './mixin-common.js';
|
3
3
|
/**
|
4
|
-
* Mixin for
|
5
|
-
* All
|
4
|
+
* Mixin for product section components that provides common functionality.
|
5
|
+
* All product section components extend LitElement and call hideEmptySection in updated().
|
6
6
|
*
|
7
7
|
* @param superClass - The base class to extend
|
8
8
|
* @param styles - The styles to apply to the section.
|
9
|
-
* @returns A class that extends the superClass with
|
9
|
+
* @returns A class that extends the superClass with product section functionality
|
10
10
|
*/
|
11
11
|
export declare function ItemSectionMixin<T extends Constructor<LitElement>>(superClass: T, styles?: CSSResultGroup): T;
|