Releases: empathyco/x
Releases · empathyco/x
4.0.1 EthixSirius
⚠ BREAKING CHANGES
- components: remove deprecated origins from #1344
- facets: The 'unknown-facet' value for a facetId has been removed: it has been replaced by the UNKNOWN_FACET_KEY constant, whose value is 'unknown'. #1351
Features
- migrate from
vue-clitovite#1350 - extra-params: allow currency to be an extra param as default (319851d)
- components: remove deprecated origins #1355
- facets: Unify unknown and unknown-facet in a constant #1351
Bug Fixes
- history-queries: map selected filters correctly when coming from Query Preview #1325
- x-plugin: improve ResultFeature type values #1344
Documentation
- integration: how to track
add2cartevent #1349 - fix
@empathyco/x-componentsimport path in examples #1353 - static-docs: added redirections in static docs metadata #1341
- fix identation error in search-box.md #1343
https://github.com/empathyco/x/commits/@empathyco/x-components@4.0.1
3.0.0 JoyfulPulsar
What's Changed
⚠ BREAKING CHANGES
- design-system: Design system styles have now to be imported from
@empathy/x-components/design-systeminstead of@empathy/x-components/css - components: Remove
hideIntegerDecimalsfromcurrency-formatterutil,base-currencycomponent. - facets-next: Rename
EmpathyFilterMappertoEmpathyFacetFilterMapper. Response filter mappers now map the API value in theidfilters property.EmpathyHierarchicalFacetMappernow flattens and stores all the filters in thefilterproperty.EmpathyHierarchicalFacetMappernow only maps filters ids inHierarchicalFilterchildren. Bump up@empathyco/x-typesmajor version in@empathyco/x-adapter. - facets: Rename
Filterscomponent toFiltersList. - facets: Remove
MultiSelectFilterscomponent. Filters are multi-select by default. Apply theSingleSelectModifierusing theFilterEntityFactoryto make the desiredFacetsingle select. - facets: Refactor
HierarchicalFilter.childrenfield. Now, this field is list of theFilter.idsof the children filter. AllHierarchicalFilters are flattened in theFacet.filterslist. - facets: Remove
facetsprop in theFacetscomponent to provideFacetsto the state. Use theFacetsProvidercomponent instead. - facets: Remove
UserChangedSelectedFiltersevent fromFacetscomponent. UseFacetsProvidercomponent instead. - facets: Remove
UserClickedClearFacetFiltersevent.UserClickedClearAllFiltersis emitted instead. Its payload is now list ofFacet.ids. - facets: Rename
UserClickedFacetAllFilterevent toUserClickedAllFilter. Its payload is now list ofFacet.ids. - facets: Remove
BackendFacetsChangedevent. UseFacetsChangedevent instead. - facets: Remove
BackendFacetsProvidedevent. UseFacetsGroupProvidedinstead. - facets: Remove
FrontendFacetsChangedevent. UseFacetsGroupProvidedinstead. - facets: Remove
FacetMultiSelectChangedevent.Filters are multi-select by default. Apply theSingleSelectModifierusing theFilterEntityFactoryto make the desiredFacetsingle select. - facets: Change
UserModifiedEditableNumberRangeFilterpayload. Now it is theEditableNumberRangeFilterfilter with the new range value. - Slots that are created using properties like the
modelNameor theidof different objects, now are named using the kebab-case version of those values. This affects the following components:
BaseGrid,FacetsandSelectedFiltersList. Examples:<template #Result="{ ... }">now is
<template #result="{ ... }"><template #NextQueriesGroup="{ ... }">now is
<template #next-queries-group="{ ... }"><template #hierarchical_category="{ ... }">now is
<template #hierarchical-category="{ ... }"> - storage-service:
StorageServicehas been renamed toBrowserStorageService. - components:
SlidingPanelbuttons do not have the round variant set by default. - facets: Remove
BaseFiltercomponent. UseRenderlessFilterinstead. - components: Removed
CollapseFromTopAnimation. UseanimateScale()instead. - components: Removed
TranslateFromLeftandTranslateFromRightcomponents. UseanimateTranslate('left')andanimateTranslate('right')instead. - related-tags: Remove
selectedandpreviouslogic from related tags. - related-tags: Remove
EmpathyRequestRelatedTagsQueryMapper. - Request types moved to
x-typespackage. Change the imports fromx-adaptertox-type. - Removed
TaggingInfotype. UseTaggingRequestfrom@empathyco/x-typesinstead. - facets: Renamed method
registerFilterModifierinFilterEntityFactorytoregisterModifierByFacetId. - facets: Changed
modifiersparameter ofregisterFilterModifierinFilterEntityFactoryfrom single array in favour of rest parameters. --x-number-aspect-ratio-pictureis now inverted. Previously value of 2 meant that it was twice taller than wider. Now it means twice wider than taller.- facets: Removed the
setFiltermutation fromfacetsX-Module. UsemutateFilterinstead. - facets: Modified the
HierarchicalFilter.childrenModel type. Now it is anArray<HierarchicalFilter>instead of an array of ids. - result:
Resultmodel properties are optional, exceptid,modelNameandtagging. - tagging:
taggingproperty ofTaggableandqueryTaggingproperty ofSearchResponseare optional. - components:
facetsare now optional inSuggestion. - design-system: the old design system button styles are now located in the
deprecated-full-theme.css, if setup is not using the new design system, it must import this file. - components: Renamed prop
animationofBaseResultImagetoloadAnimation. - search: the event
SearchResponseProvidedwas renamed toSearchResponseChanged - Removes
queryHTMLslot scope prop fromBaseSuggestion,PopularSearchQuerySuggestionandHistoryQuery. Use the newHighlightcomponent instead. - next-queries: Rename
NextQueryPreviewMountedtoNextQueryPreviewMountedHookandQueryPreviewRemovedtoQueryPreviewUnmountedHook - design-system: suggestion and suggestion group styles are now deprecated. To continue using them import from
deprecated-full-theme.css. - Rename
x-gridclass tox-grid-list. - Rename
x-grid__itemclass tox-grid-list__item. - Rename
x-grid--cols-{cols}class tox-grid-list--cols-{cols}. - history-queries: Renamed
removeHistoryQueryClassprop toremoveButtonClass. - design-system:
pictureand someresultstyles related are now deprecated. To continue using them import fromdeprecated-full-theme.css. - Rename
x-result-picture__imagetox-result-picture-image. - components: Renamed
SlidingPanelcss classesx-sliding-panel--at-startandx-sliding-panel--at-endtox-sliding-panel-at-startandx-sliding-panel-at-endrespectively. - components: Renamed
SlidingPanelbuttons css classesx-sliding-panel__button-leftandx-sliding-panel__button-righttox-sliding-panel-button-leftandx-sliding-panel-button-rightrespectively. - components: Old design-system
SlidingPanelstyles (including the updated button classes) are now located in thedeprecated-full-theme.cssfile. - components: class
x-picture__imagerenamed tox-picture-image, deprecate classesx-picture__image--placeholderandx-picture__image--fallback - design-system: Old design-system
Iconstyles are now located in thedeprecated-full-theme.cssfile. Removedcheckbox-card,nq1,nq2,nq3, andnq4 icons. - design-system: design system scroll styles are deprecated. To continue using them import from deprecated-full-theme.css
- design-system: Old
design-systemTagstyles are now located in thedeprecated-full-theme.cssfile. - design-system: Old
x-tag--is-curatedandx-tag--is-selectedclasses are no longer used byRelatedTagcomponent. base-column-picker-liststructure changes. It now wraps the buttons in div instead of using ul and li. Additionally, the class for the selected option has been changed tox-selected.- design-system: Old
design-systemprogress-barstyles are now located in thedeprecated-full-theme.cssfile. - design-system: Renamed
x-progress-bar__lineclass tox-progress-bar-fill. - design-system: The
x-componentsdesign system has been deprecated. The exported theme is no longer available. If you need support for the old design system you should import@empathyco/x-components/design-system deprecated-full-theme.css. - design-system:
x-grid-listandx-grid-list__itemclasses have been removed fromBaseGridcomponent. - design-system:
x-grid-list--cols-{columns}has been renamed tox-base-grid--cols-{columns} - design-system:
x-listclass has been removed from the following components:
BaseModal,BaseSuggetions,BaseTabsPanel,Facets,FiltersList,FiltersSearch,IdentifierResults,MyHistory,PartialResultList,ResultVariantSelector,Recommendations,RelatedTags,SlidingPanel,SelectedFiltersList. - design-system:
FixedHeaderAndAsidesLayoutMultiColumnMaxWidthLayoutandSingleColumnLayouthave been deprecated. - design-system:
BaseModaldefault opacity has changed from0.7to0.3. - design-system:
x-list__itemclass has been removed fromBaseTabsPanelcomponent. - design-system:
x-messageclass has been removed fromRedirectioncomponent. - deps: minimum version required is node v18
- the property 'querySuggestions' in 'x-plugin' now returns the query suggestions that should be displayed based on the module's config. new property called 'fullQuerySuggestions' returns all the query suggestions in the module
- queries-preview: the
QueryPreviewListcomponentqueriesprop has changed name toqueriesPreviewInfoand the type is an array ofQueryPreviewInfoas instead of an array of strings. The QueryPreview componentqueryprop has changed name toqueryPreviewInfoand the type isQueryPreviewInfoinstead ofstring.QueryPreviewInfotype is now exported from the module. - setPageSize search module mutation has been replaced by the
setConfigmutation.setTaggingConfigtagging module mutation andsetFacetsConfigfacets module mutation have been replaced by themergeConfigmutation.