CHANGELOG.md

4.7.0 (2022-12-21)

Bug Fixes

• state-results: provide rendering variables for initial render (#1156) (0d718d5), closes #1154

Features

• update PoweredBy component logo (#1158) (751ffda)

4.6.0 (2022-10-04)

Features

• ais-hierarchical-menu: add css class for link of selected menu item (#1150) (93dfdc1)
• InstantSearch: support onStateChange (#1149) (badf815), closes #1148
• StateResults: give access to status and error (#1151) (03dea3a)

4.5.0 (2022-09-07)

Bug Fixes

• nuxt: only write $nuxt if it's writable (#1117) (bdecca9), closes /github.com/algolia/vue-instantsearch/commit/acda29326475bd1b73f12b058a0c02df00b8b239#commitcomment-67430759

Features

• can-refine: provide canRefine for multiple widget slots (#1141) (424316d)

4.4.2 (2022-07-25)

Bug Fixes

• SearchBox: forward missing prop queryHook (#1136) (7f8754d)
• VoiceSearch: forward missing props language and additionalQueryParameters (#1136) (7f8754d), closes #1135

4.4.1 (2022-07-19)

Bug Fixes

• searchbox: prevent concurrent query updates from state while input is focused (#1133) (c468c0a)

4.4.0 (2022-06-28)

Bug Fixes

• ais-hierarchical-menu: show full hierarchical parent values (#1126) (51aadf0)
• pagination: add page class for "page" item (#1129) (afacf8b)
• ssr: allow component without mixins to be extended (#1127) (3b8b887)

Features

• core: update instantsearch (69a3aa8)
• widgets: pass $$widgetType (#1121) (7696acc)

4.3.3 (2022-02-10)

Bug Fixes

• esm: mark esm exports as type: module (#1111) (71c25d4)
• nuxt3: forward $nuxt on the instance by default (#1112) (acda293)

4.3.2 (2022-01-31)

Bug Fixes

• ssr: extend component correctly if at root (vue2) (#1104) (08b7124), closes #1054

4.3.1 (2022-01-11)

Bug Fixes

• dependencies: update instantsearch.js requirement (a36ae2b), closes #1096

4.3.0 (2021-12-16)

Features

• dynamicWidgets: pass parameters to connector (#1093) (247ed0f)

4.2.0 (2021-12-13)

Features

• dynamicWidgets: release as production (#1086) (9e0902b)
• instantsearch: update version (dbf485f)
• ssr: prevent initial network request (#1090) (d97eea2)

4.1.1 (2021-10-27)

Bug Fixes

• vue3: disable automatic plugin registration (#1081) (6077413)

4.1.0 (2021-10-26)

Features

• dependencies: update downstream (#1075) (ede11a5)

4.0.1 (2021-09-15)

Bug Fixes

• dynamic-widgets: use non-experimental connector (5629957)
• ssr: pass parent index to render in __forceRender (25284aa)

4.0.0 (2021-08-23)

Vue InstantSearch now supports Vue 3 (#990).

It has a few breaking changes that you can easily migrate. You can read the upgrade guide.

You can try these examples:

• Vue 3 + Vue CLI: GitHub | CodeSandbox
• Vue 3 + Vite: GitHub
• Vue 3 + SSR + Vue CLI: GitHub
• Vue 3 + SSR + Vite: GitHub

3.8.1 (2021-07-12)

Features

• props: remove defaults (#1016) (1029500)

3.8.0 (2021-07-12)

Features

• dynamic-widgets: add the ais-experimental-dynamic-widgets (#922)
• facet ordering: apply result from facet ordering in facet widgets (#922)

3.7.0 (2021-04-27)

Features

• insights: expose send-event in widgets (#953) (e2e42a4)
• middlewares: add middlewares prop to ais-instant-search (#939) (513017a)

3.6.0 (2021-03-31)

Bug Fixes

• ssr: correctly pass scopedResults.results (#943) (118e0a3), closes #940

Features

• ssr: expose clone component (#937) (4741c7b), closes #936

3.5.0 (2021-03-03)

Bug Fixes

• ratingMenu: correct URL (3c3f7e2)

Features

• ais-relevant-sort: add widget (#918) (4fe5745)

3.4.3 (2020-12-22)

Bug Fixes

• ssr: forward slots of the AisInstantSearchSsr component (#898) (60b595e)

3.4.2 (2020-10-05)

Bug Fixes

• panel: safely access state in mapStateToCanRefine (#876) (435c7d3), closes #874

3.4.1 (2020-09-30)

Bug Fixes

• panel: react to changes on initial render (#871) (56917a0)

Features

• ssr: forward propsData to recreated component (#865) (6c18a10), closes /github.com/vuejs/vue/blob/7912f75c5eb09e0aef3e4bfd8a3bb78cad7540d7/src/core/util/options.js#L34-L44

3.3.0 (2020-09-28)

Bug Fixes

• RatingMenu: use unique keys (80ff944)
• Tree Shaking: allow modern bundlers to remove parts of Vue InstantSearch which aren't used ((#866))

Features

• ssr: forward router instance to findResultsState clone (#863) (84f79eb)
• ssr: forward vuex instance to findResultsState clone (#864) (986a992)

3.2.0 (2020-08-12)

Bug Fixes

• highlight: don't remove whitespace-only nodes (#827) (1358b6a), closes #826
• range-input: fix range input min and max values fallbacks (#835) (0e900ef), closes #833
• routing: do not warn when router or stateMapping is missing (#809) (a9335c1)
• ssr: fix missing scopedResults during render (#830) (74cf685), closes #829
• widgetMixin: remove when InstantSearch is not yet started (e94af00), closes #502

3.1.0 (2020-07-02)

Bug Fixes

• ssr: allow getWidgetState to be empty for createURL (#805) (0528b55)

Features

• ais-toggle-refinement: allow multiple values for "on" and "off" (#780) (6ee1404)
• InfiniteHits: support cache (#804) (918c92d)

3.0.3 (2020-06-12)

Bug Fixes

• server: make vue-server-renderer not a dependency unless you're using it (#801) (1acc3df)

3.0.1 (2020-06-11)

Bug Fixes

• make vue-server-renderer temporarily a dependency (84fc47c)

3.0.0 (2020-06-11)

Features

• index: add multi-index widget (#745) (3c32cfe)
• server side rendering: support ais-index (#764) (3e74a8c), closes #784
• widgets: introduce ConfigureRelatedItems as experimental (#751) (f00513e)

BREAKING CHANGES

• index: this introduces the dependency on InstantSearch v4, which has its own breaking changes you might see if you're using methods on helper. See more here: https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/#upgrade-from-v3-to-v4
• server-side rendering: the API has changed to avoid having to repeat information between template & fetching. See more here: https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/vue/

2.7.1 (2020-06-10)

Bug Fixes

• Highlight, Snippet: prevent XSS via routing (#783) (f35446b)
• RangeInput: refine correctly when start is given (#777) (6eb46c8)

2.7.0 (2020-01-23)

Features

• algoliasearch: add support for algoliasearch v4 (#756) (571b1fc)
• StateResults: give access to search parameters (#627) (9870e85)

2.6.0 (2019-10-14)

Bug Fixes

• Snippet: switch tag replacement to mark (#729) (7f30331), closes #727

Features

• core: expose source files (#726) (ede5852)

2.5.0 (2019-09-18)

Features

• expose createSuitMixin to use for class names in custom widgets (#721) (5063ce1)

2.4.0 (2019-09-03)

Features

• searchbox: Adds events to hook on to focus, blur, and reset (#711) (0149d2f)

2.3.0 (2019-07-30)

Bug Fixes

• core: prevent duplicating facet values (#705) (7573be1), closes #663
• error: correct suggestion (44f2d9c)
• ssr: clearer error message when using ssr without the component (#698) (20c2153), closes #697

Features

• RefinementList: forward class names to input (#696) (793eaf2), closes #644

2.2.2 (2019-07-11)

Bug Fixes

• highlight: change expected tag to replace (#679) (4aa06fb)

2.2.1 (2019-05-21)

Features

• panel: provide hasRefinement scope to slots (#670) (2a21b52), closes #347
• voiceSearch: add voice search component (#668) (84efffc)

2.1.0 (2019-04-30)

Bug Fixes

• stories: update range slider component to v3 (#648) (e3010f6), closes #647
• toggle-refinement: display label (#649) (84c909d)
• ua: change the User-Agent to use the new specs lib (version) (#650) (6942979)

Features

• infiniteHits: add previous button (#659) (3d2eec9)
• insights: add insights support to Hits widget (#665) (2efa8c0)
• insights: add insights support to InfiniteHits widget (#666) (b3302cf)
• insights: add insightsClient support on storybook (#664) (5ad4d3e)
• query-rules: add new widgets (#652) (cec815d)

2.0.1 (2019-03-13)

Bug Fixes

• umd: prevent inclusion of Vue in bundle (#635) (a90cbce)

2.0.0 (2019-02-18)

Features

• core: update to InstantSearch.js v3 (#612) (fbf818e), closes #619
• deps: remove transitive dependencies (6fa3169)

2.0.0-beta.3 (2019-01-23)

Bug Fixes

• components: remove faulty whitespace (#606) (c7541b1)
• core: hydrated always is false on dispose (8851dec)
• errors: less whitespace (1dbd177)

Features

• server side rendering (#596) (a875bd9), closes #603 #605 #607 algolia/instantsearch.js#3415

2.0.0-beta.2 (2018-12-20)

Bug Fixes

• CurrentRefinements: compute unique key (#577) (4e941ca), closes #574
• PoweredBy: new design & colors (#578) (e1ea477), closes #571
• rating-menu: remove nonfunctional min prop (#597) (26891e6)
• RefinementList: allow overriding of searchable placeholder (#576) (d293b83), closes #572

Features

• MenuSelect: use a slot for "defaultOption" (#595) (2ca65f0)

2.0.0-beta.1 (2018-11-06)

Bug Fixes

• CurrentRefinements: use existing key (5d0b72f)
• example: add codesandbox config (#556) (e7492eb)
• Panel: make body class name computed (589f076)
• RefinementList: give canToggleShowMore to default slot (08c325f)
• RefinementList: pass createURL to item (6834766)
• SortBy: label & value instead of label & name (be42471)

Features

• CurrentRefinements: consolidate API (#550) (2b08b76)
• CurrentRefinements: expose createURL (c0bf7e5)
• CurrentRefinements: give createURL to slot (#557) (00c2865)
• InfiniteHits: add loadMore slot (d313acb)
• IS: allow change of stalled search delay and search function (1d38d5e)
• MenuSelect: add createURL in slot (d61fc82)
• MenuSelect: add item slot (#555) (1071eea)
• RangeInput: refine & currentRefinement sync (#560) (433e88b)
• RatingMenu: add slot for & up (6717db6)
• RatingMenu: createURL & stars (038ec56)
• RefinementList: provide SFFV query to default stot (a32e38c)
• router: force object form (#562) (5f1976d)
• SearchBox: forward class-names & slots (#553) (b2122dd)

2.0.0-alpha.3 (2018-10-02)

Features

• InstantSearch: call addAlgoliaAgent if possible (#537) (0f3079b)

1.5.0 (2018-03-02)

Bug Fixes

• menu: avoid error when no facet values are retrieved (0dbb683)

Features

• Pagination: pass in the page when emitting the page change event (#394) (a349e19)

1.4.0 (2018-02-06)

Bug Fixes

• Highlight: only warn once for possibly missing highlighting (#386) (92ab6c4), closes #385

Features

• loading-indicator: add API (148577f)
• loading-indicator: initial implementation (6bdf9a7)

1.3.4 (2018-01-24)

Bug Fixes

• doc: queryParameters is not a function (#377) (cd87cad)

Features

• Results: add index (position) (#382) (16c2c64)

1.3.3 (2017-12-04)

Bug Fixes

• Powered-by component is not SSR compatible #367 (f372bd4)

1.3.2 (2017-11-15)

Bug Fixes

• avoid query when components are destroyed (c41c606)

1.3.1 (2017-11-02)

Bug Fixes

• menu: avoid multiple Algolia calls when created (f1ac0a7)

Performance Improvements

• menu: use facet name as key (b496fd8)

1.3.0 (2017-10-25)

Bug Fixes

• menu: mark attribute as required (4b08b2d)
• menu: use same default sortby as specified (81a7781)
• Menu: apply correctly css class (cf996ae)
• results: remove key from slot (d63c70b)
• store: update typo in test (1430840)

Features

• docs: add RangeInput section (483583a)
• Menu: set maxValuesPerFacet from limit prop (6f9f7a7)
• RangeInput: add className on separator (d9b9b21)
• RangeInput: add className on submit (de8702a)
• RangeInput: add widget (cbc1e1b)
• store: add method for retrieve facetStats (c0c83aa)
• widgets: add Menu widget (50c4c14)

1.2.2 (2017-10-17)

Bug Fixes

• results: remove key from slot (8270847)

1.2.1 (2017-10-17)

Bug Fixes

• stats: only use toLocaleString in display (62699e9)

1.2.0 (2017-10-13)

Features

• stats: update stats component to use toLocaleString() (3b41db3)

1.1.0 (2017-10-10)

Bug Fixes

• pagination: remove class duplicates (c56ea2b)

Features

• component: add an option to bem utility to not output element class (6d4e690)
• pagination: add classes on link elements (d39da3e)

1.0.1 (2017-09-25)

Bug Fixes

• instantsearch: allow to treeshake es module (f419329)

1.0.0 (2017-08-23)

Features

• highlight: get attribute value by dot separated path (6ddc7c7)
• highlight: throw error if missing config in Algolia (09d8d3d)
• snippet: throw error if missing configuration in Algolia (6988cb2)

0.7.0 (2017-08-15)

Bug Fixes

• helper-serializer: allow to serialize a helper that has no results (cf2add9)

Code Refactoring

• store: remove searchParameters getter and setter (c146b16)

Features

• store: improve query parameters merge strategy (0472627)

Reverts

• store: have highlighting tags return the current value (3d65391)

BREAKING CHANGES

• store: if you previously used the store.searchParameters getters and setters of the store, you should now use store.queryParameters instead.

0.6.0 (2017-08-08)

Bug Fixes

• refinement-list: remove duplicated class (728314c)
• sort-by-selector: make SSR ready (e50c38a)
• store: avoid mutating query parameters (cb8cfb7)
• make all components SSR ready (4db0720)

Features

• index: add a prop to enable/disable cache (268c0b6)
• index: add a prop to toggle auto search on load (3c85017)
• store: add methods to interact with cache (98406fb)
• store: do not automatically refresh when using start() (cda198c)
• store: do not register facet if already existing (6370bd1)

Performance Improvements

• use unique keys in all v-for loops (fdbf56a)

BREAKING CHANGES

• store: using store.start() will no longer trigger an Algolia call. if you were using store.stop()/store.start() you should now also call store.refresh() if you want your store to stay in sync with Algolia.

0.5.0 (2017-08-05)

Features

• pagination: emit "page-change" event after page has changed (a259cc5)
• refinement-list: add BEM classes for labels and checkboxes (5c4f463)

0.4.0 (2017-08-02)

Bug Fixes

• component: avoid raising injection failure warning (3185548)
• index: trigger error message when index context is missing (edbabdd)
• powered-by: ensure search store is not required (bc0a19f)
• spelling: run most code through a spell checker (#226) (640fec3)

Code Refactoring

• store: do not expose highlighting tags (d3ee912)
• store: remove pagination utility methods (3bdf759), closes #228

Features

• add keys to all for loops (a36a493)

BREAKING CHANGES

• store: pagination utility methods have been removed. This includes goToFirstPage, goToPreviousPage, goToNextPage and goToLastPage.
• store: HIGHLIGHT_PRE_TAG and HIGHLIGHT_POST_TAG are no longer exported.

0.3.2 (2017-07-30)

Bug Fixes

• rating: correct star counts (a499be4)

0.3.1 (2017-07-26)

Update the readme on npm website.

0.3.0 (2017-07-21)

Bug Fixes

• pagination: ensure page never drops below first page (e851553)
• pagination: hide pagination if there are not results (f4dac58)
• store: catch errors on facet values retrieval (a51a547)
• store: make sure serialization contains hl tags (4e8a7de)
• store: reject wait sync if error occurs (9568ddf)

Features

• sanitize-results: add a module to sanitize results (e78cacd)
• search-box: add autofocus capabilities (0c91334)
• store: allow to use custom highlight tags (c77f336)
• store: escape results when fetched (61341a9)

Performance Improvements

• store: cache sanitized results (62858b2)

BREAKING CHANGES

• Highlight and Snippet components no longer accept tag-name nor escape-html as props. Highlighted values are now escaped as responses are received. The highlighting tags can now be configured on the store itself.

0.2.1 (2017-05-29)

0.2.0 (2017-05-29)

Bug Fixes

• bem: make sure blockClassName is provided by component (826bbc9)
• build: build cjs and es builds before UMD to satisfy inheritance chain (78545f9)
• build: fix build scripts (42beeb2)
• clear: use clearsQuery instead of clearQuery (#91) (74e8dcb)
• clear-search: remove "label" prop and inline it (c1e74db)
• empty-results: prefix container class name (6bd49ea)
• examples: rename attribute to attribute-name (6dc4740)
• highlight: gracefully display empty string if attr is not available (3976dca)
• highlight: support replacing multiple highlighting tags (84478c2)
• input: better mobile experience (c58980b)
• input: revert back to input as root element (b293ac7)
• navigation-tree: fix invalid scss rule (33f07ee)
• navigation-tree: make style rules less specific (1570fac)
• navigation-tree: remove non generic style rule (a166d9e)
• navigation-tree: use more concise style rule (5699228)
• pagination: avoids underlining disabled button (312b06c)
• powered-by: set a default width for the SVG logo (5304df5)
• powered-by: use shorter version of SVG logo (5d4f760)
• price-range-facet: add missing props and respect class naming conventions (99741db)
• ranged-pagination: make pagination start at 1 (7c4864f)
• ranged-pagination: make style rules less specific (7e284fc)
• ranged-pagination: removed non generic style rule from component (cba0e5d)
• rating: HTML UTF-8 characters (b8012e9)
• rating: renamed StarsFacet to RatingFacet (13b6ea7)
• rating-facet: make style rule less specific (60cbeb0)
• scss: make price range component css less specific (e5ea957)
• search-facet: make style rules less specific (a1f8e14)
• search-facet: remove non generic style rule (3cace70)
• search-results: make page start at 1 (b284957)
• search-store: make page start at 1 (917706b)
• snippet: gracefully handle missing snippet attribute (d888f97)
• snippet: support replacing multiple highlighting tags (15280ee)
• store: better handle facet addition and removal (bda4dc1)
• store: make page search parameter start at 1 (062f09c)
• store: remove SearchParameters explicit import (4c665fe)
• travis: switch to npm client (5065718)
• tree-menu: correct mis-usage of bem syntax (d511d03)

Features

• bem: support block modifier class names (7bde05c)
• component-scss: add the styles to the components (372d635)
• components: add powered by support (1f750b8)
• e-commerce: add powered by (4666392)
• empty-results: expose the "query" inside of the slot (4206d89)
• example-simple: bootstrap a simple example using UMD build (bb68c7c)
• examples: add multi-index example (cf9746d)
• highlight: add a functional Highlight component (f411394)
• highlight: add an option to disable escaping the html (988b572)
• highlight: add Highlight component to the InstantSearch plugin (993fa51)
• highlight: make examples use the new Highlight component (fa377c6)
• inline-scss: add the basic css to the components (1642a56)
• multi-index: add powered by (38bebb9)
• navigation-tree: introduce a slot to allow overriding of labels (1e278a0)
• pagination: use bem method to generate customizable classes (7e1c52d)
• playground: add example of search facet label ovverriding (7706f32)
• playground: add example on how to override empty results (302d1ad)
• playground: add slot overriding example for ranged pagination (dd084a8)
• playground: example of navigation tree custom label (512d4b4)
• playground: showcase stars in rating component (b46ae70)
• powered-by: add hostname to generated URL (01bc789)
• powered-by: create powered by component (5fc1915)
• ranged-pagination: better slots for ranged pagination (85ac789)
• rating: add example of label overriding to playground (0919170)
• rating: allow for easy override of rating labels (e51bb77)
• search-box: improve accessibility (20b2725)
• search-facet: add a slot to override label (f78b8a0)
• search-form: introduce SearchForm component (beb34e1)
• search-results: add header and footer slot and hide when no results (e5cb24a)
• search-store: make query reactive in search store component (e666ff3)
• search-store: override highlight tags and expose them (687ff2a)
• snippet: add a Snippet component (f62c78c)
• snippet: add an option to disable the html escaping (70abc28)
• snippet: add the Snippet component to the InstantSearch plugin (26483b6)
• sort-by-selector: add scoped properties to default slot (6d56622)
• stats: add scoped properties to default slot (abdf64b)
• store: add query parameters setter & getter (c6e09a5)
• store: add serializing capabilities (90f5347)
• store: add user agent to client (5b1e469)
• store: allow to set and get all search parameters at once (32cc1a1)
• store: allow to wait for the store to be in sync (279f2bb)
• store: throw an error if not constructed with a helper (cbec746)
• store: unset query parameter when value is null or undefined (801914e)
• store-component: add query parameters as a property (c54bd8c)
• tree-menu: add class to list element (578c9ab)
• tree-menu: allow infinite number of nested levels (b7217e9)
• url-sync-example: add URL sync example with Vue Router (ec70e91)

Performance Improvements

• store: use Algolia light client (4a58b57)