CHANGELOG.md

1.6.0 (2018-05-03)

Features

• Update client and helper (#429) (c533527)
• search-client: Add support for Custom Search Clients (#432) (c3d35bc)

1.5.2 (2018-03-15)

Bug Fixes

• RangeInput: also update footer slot (#407) (831de9a)
• RangeInput: make the header slot valid (#406) (f43f19f), closes #405

Features

• store: expose userData through a new getter (1d943d4)

1.5.1 (2018-03-06)

Bug Fixes

• refinementList: avoid unwanted spacing (#384) (8d12317)

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)