4.46.3 (2022-09-27)

Bug Fixes

• currentRefinements: implement noRefinementRoot modifier class (#5114) (cb66830)

4.46.2 (2022-09-22)

Bug Fixes

• build: remove jsx pragma comments from build output (#5112) (6582083)
• imports: split out templating from ./utils (#5111) (fc765f3), closes #5109

4.46.1 (2022-09-15)

Bug Fixes

• hierarchicalMenu: use existing facet filters in multi queries for parent facet values (#5105) (10a83f1)
• insights: make sure change in userToken can't reset the search parameters (#5101) (b20c8dc)
• setUiState: call onStateChange handler (#5104) (231853d))

4.46.0 (2022-09-12)

Features

• html: deprecate Hogan.js and string-based templates (#5095) (a06ddf5)
• html: introduce html templating (#5081) (e55e224)

4.45.1 (2022-09-06)

Bug Fixes

• ratingMenu: fix undefined facet values error when disjunctiveFacets is empty (#5096) (dd870d5)

4.45.0 (2022-08-29)

Features

• connectors: deprecate hasNoResults in favor of canRefine (#5091) (1749a4e)

4.44.1 (2022-08-25)

Bug Fixes

• connectNumericMenu + connectRange: stop sending invalid clickedFilters event (#5085) (20996c7)

4.44.0 (2022-08-08)

Features

• geo-search: make GeoHit type generic (#5083) (3d3c7b2)

4.43.1 (2022-07-11)

Bug Fixes

• errors: rethrow error as error if it's an object (#5075) (34132bb)
• ratingMenu: don't warn if results are artificial (#5073) (d747d23)
• types: use correct case for _geoloc property (#5074) (6fed7d8)

4.43.0 (2022-06-28)

Features

• types: support algoliasearch v5 (#5066) (3eb4dc7)

4.42.0 (2022-06-21)

Bug Fixes

• es: update import path for infiniteHitsCache in depreciation message (#5068) (545cbaf)

Features

• core: sort parameters & support client.search for sffv (#5069) (34e2b00)

4.41.2 (2022-06-15)

Bug Fixes

• hierarchicalMenu: show full hierarchical parent values (#5063) (cd1db34)

4.41.1 (2022-06-14)

Bug Fixes

• insights: don't send view event if search is stalled (#5058) (1686dfb), closes /github.com/algolia/instantsearch.js/blob/99f6fe1dc51e4815e5b9efcfb30e3e2f3127e763/src/lib/utils/createSendEventForHits.ts#L168 /github.com/algolia/instantsearch.js/blob/55313e4ea4105b777f3f102e9f48a7e440496d25/src/middlewares/createInsightsMiddleware.ts#L144
• types: avoid inferring UiState type from initialUiState (#5061) (80ca07e), closes /github.com/Microsoft/TypeScript/issues/14829#issuecomment-504042546 #5060
• types: make all usages of UiState in InstantSearch generic (#5060) (2b9e76b)

4.41.0 (2022-06-01)

Features

• core: don't schedule search without widgets (#5056) (ea3d6d9)

4.40.6 (2022-05-24)

Bug Fixes

• types: only allow null for parent in getWidgetRenderState if widget is an index (#5052) (fe0fce0)

4.40.5 (2022-04-26)

Bug Fixes

• routing: prevent writing the same URL twice (#5045) (5d79d92)

4.40.4 (2022-04-13)

Bug Fixes

• currentRefinements: correctly show and allow for refining escaped values (#5041) (277f4df)

4.40.3 (2022-04-04)

Bug Fixes

• refinements: escape facet values starting with "-" (#5039) (6b6f4e8)

4.40.2 (2022-03-29)

Bug Fixes

• currentRefinements: more detailed type for item.type (#5034) (773e2c6)

4.40.1 (2022-03-21)

Bug Fixes

• types: update to latest algoliasearch-helper (6bbe790)

4.40.0 (2022-03-21)

Features

• infiniteHits: avoid caching artificial results (#5023) (e8c0145)

4.39.2 (2022-03-14)

Bug Fixes

• fix types of sortBy option (#5024) (3f7ea32)

4.39.1 (2022-03-01)

Bug Fixes

• insights: send view events after rendering (#5014) (e952abc)

4.39.0 (2022-02-23)

Features

• ts: allow Hits related connectors to be generic (#5019) (e986f7e)

4.38.1 (2022-02-08)

Bug Fixes

• routing: fix history router based on history length (#5004) (40541af)
• metadata: ensure safe user agent detection (#5009 15a6a9d)

4.38.0 (2022-01-28)

Bug Fixes

• typescript: remove non-existing UMD type definition (#5001) (c234374)

Features

• connectors: expose search results to transformItems when available (#5000) (58c2651)

4.37.3 (2022-01-25)

Bug Fixes

• helpers: display warning if attribute cannot be highlighted/snippeted (#4996) (e81bf59)

4.37.2 (2022-01-10)

Bug Fixes

• searchbox: make sure setting query to the initial doesn't cause a stale state (#4990) (3faca01)

4.37.1 (2022-01-05)

Bug Fixes

• connectBreadcrumb: returns an empty array if no hierarchicalFacets exist (#4980) (3ea9b91)
• es: mark inner package.json as side-effect free (#4984) (74f56f3), closes #4971
• events: emit error as typeof Error (#4983) (4adfaf2)

4.37.0 (2022-01-04)

Features

• build: expose /es as a real ES module (#4971) (e5b3434)

4.36.0 (2021-12-16)

Features

• dynamicWidgets: send facets * and maxValuesPerFacet by default (#4968) (969ae89)
• DynamicWidgets: throw when transformItems returns anything that isn't an array (#4975) (5c328c8)

4.35.0 (2021-12-13)

Features

• events: move to @algolia/events (#4961) (1c56726)

Bug Fixes

• deps: Add missing peer dependency (#4950) (468578da9)

4.34.0 (2021-12-07)

Features

• rely on state in getWidgetRenderState (#4960) (5006841)
• support initial results (experimental) (#4967) (db11c13)

4.33.2 (2021-11-16)

Bug Fixes

• connectNumericMenu: allow option for same start/end values (#4951) (18da714)

4.33.1 (2021-11-02)

Bug Fixes

• getUiState: support initialUiState (#4948) (532474d)

4.33.0 (2021-10-26)

Bug Fixes

• router: skip history push on browser back and forward actions (#4933) (7909da4)
• setUiState: reset UI state with empty object (#4944) (5faae4a)

Features

• router: support server environments (#4940) (a002962)

4.32.0 (2021-10-20)

Features

• dependencies: update algoliasearch-helper (#4936) (014a413)

4.31.1 (2021-10-19)

Bug Fixes

• types: export correct types from search-insights (#4930) (5ae7a5b)

4.31.0 (2021-10-14)

Features

• InstantSearch: defer initial search (#4925) (9a88115)

4.30.3 (2021-10-12)

Bug Fixes

• toggleRefinement: don't set off value in getWidgetRenderState (#4912) (69525bf)

4.30.2 (2021-09-21)

Bug Fixes

• es: add warning to typescript declaration of keys to be imported from helpers (#4908) (8cbd5fb)
• infinite/hits: stop saving the transformed results in cache (#4907) (82dc0ae), closes #4819

4.30.1 (2021-09-14)

Bug Fixes

• insightsMiddleware: throw an error when credentials can't be extracted (#4901) (55313e4)

4.30.0 (2021-09-07)

Bug Fixes

• insights: handle multiple setUserToken call before search.start() (#4897) (51a6f2b)

Features

• dynamicWidgets: add fallbackWidget (#4847) (7d99ab9)
• dynamicWidgets: mark as stable (#4899) (f97468f)

4.29.1 (2021-09-02)

Bug Fixes

• middleware: subscribe middleware before initializing main index (#4849) (0fc8f73)

4.29.0 (2021-08-31)

Features

• panel: render templates on init with render state (#4845) (0e151a9)

4.28.0 (2021-08-24)

Bug Fixes

• sendEvent: split > 20 objects in multiple calls (#4841) (44574bc)
• svg: remove xmlns (#4839) (932ae3a)

Features

• ts: expose built files in umd (#4844) (8578ae3)

4.27.2 (2021-08-18)

Bug Fixes

• types: export all types as "type" to avoid exporting in .js (#4837) (dcbbd88)

4.27.1 (2021-08-17)

Bug Fixes

• ts: export types from entry point (#4834) (3014e84)

4.27.0 (2021-08-17)

Bug Fixes

• ts: correct entry point (#4829) (24a45f9)
• ts: export PaginationConnector (d201322)

Features

• typescript: expose types at regular build (#4832) (4bea07b)

If you were using typescript via the experimental-typescript tag, you can now use regular InstantSearch.js.

4.26.0 (2021-08-10)

Features

• ts: allow custom ui state and route state in routing (#4816) (5f8ba5d)
• types: allow typed access to properties added to entry (#4814) (9000f16)

4.25.3 (2021-08-03)

Bug Fixes

• types: fix hits and results types in connectHits and connectInfiniteHits (#4820) (2bf987e)

4.25.2 (2021-07-20)

Bug Fixes

• build: ensure build fails when types building fails (#4812) (b37e23b)
• types: export widget's types (#4813) (e9764e9)

4.25.1 (2021-07-13)

Bug Fixes

• deps: force a lower version of qs (#4805) (07b7e08)

4.25.0 (2021-07-06)

Features

• facets: apply result from facet ordering (#4784) (9e9d839)

4.24.3 (2021-07-05)

Bug Fixes

• dynamicWidgets: read from facetOrdering.facets (42d6c6c)
• ts: make template types consistent (#4785) (e0fbd55)

4.24.2 (2021-06-29)

Bug Fixes

• index: export IndexWidgetParams type (#4793) (91bdea1)
• onStateChange: propagate change to middleware (#4796) (57c32c0)
• relevantSort: export RelevantSortWidgetParams type (#4794) (1a10b59)
• sortBy: do not write the default state (#4798) (1d8a40e)

4.24.1 (2021-06-23)

Bug Fixes

• mainHelper: allow a mainHelper to be set before start (#4790) (e8329ae)

4.24.0 (2021-06-15)

Bug Fixes

• clearRefinements: do not throw when widgetParams is not given (#4778) (6b1a375)
• ts: make CSSClasses types consistent (#4774) (99008a9)

Features

• dynamicWidgets: add default attributesToRender & transformItems (#4776) (44dab44)
• ts: convert pagination widget and component (#4765) (34eb950)
• ts: convert rangeInput widget and component (#4766) (40b1a82)

4.23.0 (2021-05-25)

Bug Fixes

• range: reset the page on refine (#4760) (24e3b34), closes #4759

Features

• ts: convert poweredBy widget (#4756) (142660a)

4.22.0 (2021-05-05)

Bug Fixes

• insights: do not throw when userToken is not given (#4724) (8241b29)
• insights: use getUserToken method instead of _get (#4744) (05d05a9)
• relevantSort: remove "relevantSort" nesting, since there's only one property (#4735) (f742083)
• connectToggleRefinement: nest getRenderState per attribute (#4743) (b9c884d)
• connectToggleRefinement: remove search parameters from render state (#4743) (b9c884d)

Features

• core: add getUiState function (#4750) (adce212)
• dynamicWidgets: implementation (#4687) (2e7ccc9)
• ts: migrate toggleRefinement & connectToggleRefinement (#4743) (b9c884d)
• widget: add access to "parent" in dispose (#4745) (3fca986)

4.21.0 (2021-04-12)

Bug Fixes

• infiniteHits: fix wrong behavior of showPrevious regarding cachedHits (#4725) (40b27b6)
• ratingMenu: use url in default template (#4728) (31d9c50)

Features

• middleware: accept partial methods (#4673) (8f2aad2)
• ts: convert hierarchical-menu to TypeScript (#4711) (870e2f7)
• ts: convert RefinementList component to TypeScript (#4702) (fd562de)
• ts: convert search-box to TypeScript (#4710) (e73257a)

4.20.0 (2021-04-06)

Features

• clearRefinements: implement canRefine (#4684) (a898f09)
• currentRefinements: implement canRefine (#4697) (4db75ba)
• hierarchicalMenu: implement canRefine (#4685) (0d2e450)
• middleware: add unuse method (#4708) (8e3c406)
• pagination: implement canRefine (#4683) (3ae51e6)
• range: implement canRefine (#4686) (a99ab6f)
• ratingMenu: implement canRefine (#4691) (42191a0)
• toggleRefinement: implement canRefine (#4689) (48dc7f8)
• ts: convert rating-menu to TypeScript (#4701) (f14ca08)
• ts: convert Template component to TypeScript (#4703) (0688571)

4.19.0 (2021-03-30)

Bug Fixes

• setUiState: make sure previous ui state is stored (#4699) (0f5d688)

Features

• relevantSort: implement canRefine (#4693) (24d9ded)
• currentRefinements: implement canRefine (#4690) (f02416c)
• ts: convert sortBy, connectSortBy (#4700) (86de1e0)

4.18.0 (2021-03-24)

Bug Fixes

• createURL: correctly remove page in state (#4679) (48c080e)
• utils: circular dependency in createSendEventForHits (#4680) (045f33b)

Features

• metadata: expose client's algolia agent (#4694) (3d0cb5b)
• ts: convert connectRefinementList, refinementList (#4658) (794b2d3)
• ts: convert stats, connectStats (#4681) (37bbd01)
• ts: update to typescript 4 (#4654) (638e437)

4.17.0 (2021-03-09)

Bug Fixes

• bindEvent: escape payload correctly (#4670) (c1cbaf4)

Features

• insights: add hits and attributes to InsightsEvent (#4667) (17ef71c)

4.16.1 (2021-03-03)

Bug Fixes

• relevantSort: rename smartSort to relevantSort (#4668) (579eee8)

4.16.0 (2021-03-01)

Bug Fixes

• relevantSort: export the widget and the connector (#4663) (e7aaa8c)

Features

• answers: add EXPERIMENTAL_answers widget (#4581) (e4c9070), closes #4635

4.15.0 (2021-02-23)

Features

• relevantSort: add widget (#4648) (89c6e86)
• stats: apply nbSortedHits (#4649) (34478c1)
• ts: convert menu (#4652) (2271b43)

4.14.2 (2021-02-17)

Bug Fixes

• insights: don't reset page (#4655) (2b31250)

4.14.1 (2021-02-16)

Bug Fixes

• compat: remove references to window (#4651) (1ede1ae), closes #4650

4.14.0 (2021-02-09)

Features

• queryRuleContext: allow to make refinements based on query (#4638) (dd033fc)

4.13.2 (2021-02-03)

Bug Fixes

• range: don't go out of bounds with min or max given (#4627) (8327ec0)

4.13.1 (2021-01-26)

Bug Fixes

• index: only set listeners on init once (#4634) (730b49d)

4.13.0 (2021-01-26)

Features

• ratingMenu: Add support for floats in values (#4611) (3f52784)

4.12.0 (2021-01-20)

Code Refactoring

• rename all references to widgetOptions as widgetParams (#4612) (ff9a18d)

Features

• core: expose metadata of widgets (#4604) (1fcf716)
• widgets: annotate widget instances with $$widgetType (#4624) (df3f478)

BREAKING CHANGES

• if you're using experimental-typescript and importing a type of the form ...WidgetOptions, this now becomes ...WidgetParams (eg. replace HitsWidgetOptions with HitsWidgetParams)

4.11.0 (2021-01-14)

Bug Fixes

• index: do not warn for nested index widget (#4620) (7502744)
• insights: don't quote values (#4619) (ac2444c)

Features

• insights: accept initParams for insightsClient (#4608) (0a0ae2b)

4.10.0 (2021-01-05)

Features

• index: expose createURL (#4603) (f57e9c5)
• index: expose scoped results getter (#4609) (a41b1e4)
• reverseHighlight/reverseSnippet: Implements reverseHighlight and reverseSnippet (#4592) (718bf45)

4.9.2 (2020-12-15)

Bug Fixes

• warn about invalid userToken (#4605) (5fce769)
• types: correct type for queryHook return (#4602) (acff8db)

4.9.1 (2020-12-08)

Bug Fixes

• range: consistently convert min & max to numbers (#4587) (ccf159e)

4.9.0 (2020-12-01)

Bug Fixes

• remove a warning about insights that is not relevant anymore (#4593) (b5f6a47)

Features

• autocomplete: implement getWidgetRenderState (#4466) (c215836)
• breadcrumb: implement getWidgetRenderState (#4467) (80b348e)
• clearRefinements: implement getWidgetRenderState (#4468) (2b3117c)
• configure: getRenderState for multiple configure widgets (#4582) (5432af1)
• configure: implement getWidgetRenderState (#4469) (3a1b325)
• connectPagination: add getWidgetRenderState & refactor to TS (#4574) (1553aa3)
• core: introduce getWidgetRenderState (2/n) (#4457) (4839bb6)
• core: introduce getWidgetUiState lifecycle hook (1/n) (#4454) (cf21ea4)
• currentRefinements: implement getWidgetRenderState (#4470) (b8df824)
• connectQueryRules: getWidgetRenderState (#4572) (edcc4a4)
• connectGeoSearch: support getWidgetRenderState (#4564) (8d06fba)
• hierarchicalMenu: implement getWidgetRenderState (#4471) (9fd3cd0)
• highlight: accept array for attribute (#4588) (b0c3a3a)
• hits: implement getWidgetRenderState (#4525) (3391ff7)
• hitsPerPage: implement getRenderState and getWidgetRenderState (#4532) (7ad10ea)
• infinite-hits: implement getRenderState and getWidgetRenderState (#4535) (98c70d9)
• menu: implement getRenderState and getWidgetRenderState (#4540) (239906c)
• panel: spread widgetRenderState in the options in panel (#4527) (8f82eaa), closes #4558
• poweredBy: getWidgetRenderState (#4551) (cd816a4)
• range: implement getRenderState and getWidgetRenderState (#4536) (d67bfcd)
• rating-menu: implement getRenderState and getWidgetRenderState (#4548) (166a96c)
• refinement-list: implement getRenderState and getWidgetRenderState (#4549) (c824bd0)
• numeric-menu: add getRenderState (#4550) (5385edf)
• sortBy: implement getRenderState and getWidgetRenderState (#4568) (fd249f7)
• stats: implement getRenderState and getWidgetRenderState (#4565) (b8dfd6d)
• toggleRefinement: implement getRenderState and getWidgetRenderState (#4569) (f2c9a10)
• voice-search: implement getRenderState and getWidgetRenderState (#4557) (d308da1)

4.8.7 (2020-11-19)

Bug Fixes

• insights: use internal find util method (#4580) (61b855b)

4.8.6 (2020-11-17)

Bug Fixes

• insights: do not throw when sending event right after creating insights middleware (#4575) (d963f8d)

4.8.5 (2020-11-10)

Bug Fixes

• configure: pass the latest state to onStateChange (#4555) (6ab76e8)

4.8.4 (2020-10-27)

Bug Fixes

• infiniteHits: do not cache the cached hits inside the connector (#4534) (c97395e)
• insights: show deprecation warnings for old insights related properties and functions (#4524) (c93e1cf)

4.8.3 (2020-09-29)

Bug Fixes

• middleware: rename EXPERIMENTAL_use to use (#4450) (87ecb99)
• refinementList: cap maxFacetHits to 100 for SFFV (#4523) (baf1f02)

4.8.2 (2020-09-22)

Bug Fixes

• insights: fix the regression that it didn't send events with instantsearch.insights() (#4519) (10e38df)

4.8.1 (2020-09-15)

Bug Fixes

• hitsPerPage: update link to hitsPerPage widget (#4513) (daa4bb9)
• infiniteHits: compute isLastPage based on cached pages (#4509) (b6fb1ab)

4.8.0 (2020-09-08)

Features

• insights: introduce insights middleware (#4446) (9bc6359)

4.7.2 (2020-08-31)

Bug Fixes

• bundlesize: remove prop-type imports (#4491) (8361cd6)
• router: skip router write on duplicate entries (#4487) (9296022)
• searchBox: pass "spellcheck" property correctly to input (#4483) (3cf43c7)

4.7.1 (2020-08-19)

Bug Fixes

• configureRelatedItems: support nested attributes (#4480) (2266004)
• connectToggleRefinement: fix onFacetValue/offFacetValue on render when using arrays for on/off (#4449) (fd3e83f)
• index: don't show a development warning for inconsistent UI state in connectRange (#4440) (eb8c8b3), closes #4437
• infiniteHits: work with controlled mode (#4435) (68b20f4)
• typescript: correct dummy v4 client (#4459) (ca0c394)
• typescript: jsDoc comments which conform to Connector definition (#4458) (5209bdb)
• typescript: export correct types (#4476) (5fb4c5b)

4.7.0 (2020-06-15)

Bug Fixes

• rangeInput: clear input when refinement is cleared (#4429) (a2c7663)

Features

• infiniteHits: support cache (#4431) (008c01c)

4.6.0 (2020-06-08)

Bug Fixes

• connectPagination: set isLastPage to true when no results (#4422) (92bcc02)
• rangeInput: support typing float numbers (#4418) (61b19b8)

Features

• connectToggleRefinement: add support for array values (#4420) (fe1fbee)

4.5.0 (2020-05-13)

Bug Fixes

• middleware: subscribe middleware after init (#4322) (f61fc4d)

Features

• index: support adding index widget with initial UI state (#4359) (5ff4c83)
• voice: allow custom voice helper (#4363) (4a00fa6)

4.4.1 (2020-04-29)

Bug Fixes

• range: fix range calculation when step is set (#4398) (a36b4e0)
• router: don't write an existing URL (#4392) (ee6a9c6)

4.4.0 (2020-04-08)

Features

• introduce controlled mode APIs with onStateChange and setUiState (#4362) (4953324)

4.3.1 (2020-03-06)

This versions fixes a Cross-Site Scripting (XSS) vulnerability (#4344) when using the refinementList widget when relying on its default item template and routing. We recommend all users to upgrade to this version. We now escape the refinementList item template by default, which avoids HTML to be injected. If ever you were relying on this behavior, which we do not recommend, you can copy the previous item template into your widget.

You were not vulnerable to this XSS if:

• You didn't use routing
• You didn't use use the refinementList widget (connectRefinementList is not subject to this issue)
• You used a custom item template for your refinementList widget that does not rely on the triple-brace Hogan.js syntax (e.g., {{{highlighted}}})

Bug Fixes

• refinementList: prevent XSS via routing (#4344) (8552221)

4.3.0 (2020-02-25)

Bug Fixes

• deps: update dependency algoliasearch-helper to v3.1.1 that fixes a case where refinements for a facet with a name that matches a substring of another facet could be cleared by mistake (algolia/algoliasearch-helper-js/pull/760) (#4335) (9bc66cf)

Features

• highlight: add cssClasses to snippet & highlight helper (#4306) (ece0aa6)

4.2.0 (2020-01-23)

Features

• algoliasearch: add support for algoliasearch v4 (#4294) (73f1584)
• insights: add getInsightsAnonymousUserToken helper (#4279) (4653f95)

4.1.1 (2019-12-20)

Bug Fixes

• configureRelatedItems: use facetFilters to exclude `obje… (#4264) (9bc66cf)
• index: fix warning for widgets sharing connectors (#4260) (ec97b4a)
• insights: export Insights helper in the ESM build (#4261) (20649af)
• insights: move 'insightsClient not provided error' to wrapper level (#4254) (15d38dd)

Features

• insights: add hogan helper (#4253) (85739d7)

4.1.0 (2019-12-10)

The 4.0.1 release contained experimental TypeScript definitions in the ESM build by accident. We rolled this back in 4.1.0 because types will first be released on an experimental tag: experimental-typescript.

Bug Fixes

• core: display correct object types in messages (#4249) (fb2c3c9)
• insights: detect clicks on children of [data-insights] HTML elements (#4197) (9cac5a3)
• insights: display docs URL when missing (#4231) (9df1e7f)
• widgets: override connectors' $$type (#4227) (50f4af3)

Features

• middleware: introduce EXPERIMENTAL_use to plug middleware into InstantSearch (#4224) (9d1f7be)
• router: plug router as a middleware (#4224) (9d1f7be)
• insights: detect window.aa when available on global scope and a function (#4191) (d6df5af)
• typescript: add declaration files (experimental) (#4220) (ebacfe5)
• widgets: introduce Related Items widgets as experimental (EXPERIMENTAL_configureRelatedItems and EXPERIMENTAL_connectConfigureRelatedItems) (#4233) (f811f4e)

4.0.1 (2019-11-28)

Bug Fixes

• widget name in documentation link for index (#4172) (fe7e588)
• helper: rely on stable version of algoliasearch-helper (#4200) (ff11731)
• infiniteHits: correct widget options types (#4222) (bb1b327)
• queryHook: restore behaviour of queryHook (#4202) (7bf96cb), closes /github.com/algolia/instantsearch.js/commit/c073a9acb51fff3c15278fcd563e47fec55c8365#diff-530222e0c4597f2110dc6ba173a306b0L98

Features

• transformers: add tests (#4153) (5a28415)

4.0.0 (2019-10-23)

This release is focused on two main features: Federated search, and bundle size reduction.

Federated search, is the feature where you search through multiple types of content with the same experience, but with separate result lists. In the past we have also called this feature "multi-index search". This feature helps you make more efficient UIs with multiple result lists, autocomplete, nested interfaces and query suggestions. You can read more about the new index widget in the documentation.

The second main feature is bundle size reduction. This is a bottom-up process where we started by removing Lodash from our bundle. While the library has many useful features, it was a major part of our compiled code. We have also updated to Preact X, the latest version of Preact internally. This allows us to use more modern (p)react features in the future, which have a more efficient bundling pattern.

You can read more details on our choices by following the original posts about the beta releases.

Even though all this internally were major refactors, this should not have a big impact on how you are using InstantSearch. For the few things which did change, a migration guide can be found in the documentation. Don't hesitate to reach out if anything is unclear from that guide, so we can fix it for everyone.

Note, if you are using the places.js InstantSearch widget, it is not compatible with InstantSearch v4. However, we took this opportunity to make it a real part of InstantSearch.js, and is now accessible as a widget of InstantSearch. You can use it with a placesReference.

Bug Fixes

• configure: merge with the previous parameters (#4085) (a215d0c)
• configure: update lifecycle state (#3994) (3d8d967)
• connectInfiniteHits: fix page state when adding or removing widgets (#4104) (1077340)
• connectInfiniteHits: fix state when navigating or adding/removing widgets (#4123) (9cbd24a)
• createURL: support multi-index (#4082) (179a6e5)
• defer: recover from error (#3933) (f22b9e2)
• helper: expose .lastResults to .helper (#4170) (236eb7b)
• history: avoid empty query string (#4130) (18fee7c)
• hits: update lifecycle state (#3977) (6e55ba6)
• hitsPerPage: avoid sync default value (#4086) (3f8b958)
• hitsPerPage: update lifecycle state (#3978) (d21d620)
• index: ensure that we always use the index set by widgets (#4125) (952dc70), closes /github.com/algolia/algoliasearch-helper-js/blob/5a0352aa233c5ea932df6b054a16989c8d302404/src/algoliasearch.helper.js#L124
• index: prevent render without results (#3932) (1b9b5f4)
• index: subscribe to state change only after init for uiState (#4003) (9490ca9)
• index: support custom UI params in UI state warning (#4165) (80d32fc)
• index: warn for inconsistent UI state in development mode (#4140) (7e277dc)
• infiniteHits: update lifecycle state (#3983) (4b8bee5)
• instantsearch: return instance in widgets methods (#4143) (77ffb93)
• InstantSearch: cancel scheduled operations (#3930) (3aafbad)
• InstantSearch: fix initialUIState when refinements are already present in the route (#4103) (079db57)
• InstantSearch: remove useless walk/duplicate request (#4127) (70163a8)
• menu: apply & remove refinement (#4027) (85de2cf)
• menu: prevent error on stale search (#3934) (5f9e138)
• numericMenu: take array into account for empty state (#4084) (2c05a01)
• pagination: update lifecycle state (#3979) (2b08344)
• pagination: update no refinement behavior (#4124) (8d222ad)
• range: clear widget state on empty refinements (#4157) (23cd112)
• ratingMenu: update lifecycle state (#3987) (ffadf64)
• RefinementList: remove root css class on sublists (#4117) (ceddd42), closes /github.com/algolia/instantsearch.js/blob/v2/src/decorators/headerFooter.js#L22
• searchBox: update lifecycle state (#3981) (0ea4950)
• sortBy: ensure a return value for getWidgetSearchParameters (#4126) (569d573)
• sortBy: read initial index name from parent index (#4079) (fe23c55)
• display warnings only in development (#4150) (44f69a0)
• remove useless types (#3958) (ddebf53)
• stories: hide Places (#4152) (7ff843f)
• toggleRefinement: update lifecycle state (#3993) (f1beff6)
• voiceSearch: update lifecycle state (#3982) (798e3c1)
• warnings: remove v3 warnings (#4134) (7eb6810)

Features

• autocomplete: leverage scoped results (#3975) (8f05968)
• autocomplete: participate in routing (#4029) (a9ca0c5)
• autocomplete: provide indexId (#4142) (b641e23)
• clearRefinements: support multiple indices (#4036) (3611b11)
• connectAutocomplete: add default value on getConfiguration (#3836) (724b83f)
• connectAutocomplete: clear the state on dispose (#3815) (8ae87d8)
• connectHierarchicalMenu: update getWidgetSearchParameters (#4053) (c99f822)
• connectHits: clear the state on dispose (#3816) (c4de730)
• connectHits: implement getWidgetSearchParameters (#4001) (c77cf66)
• connectHitsPerPage: clear the state on dispose (#3818) (d7a5c89)
• connectInfiniteHits: add default value on getConfiguration (#3837) (8c65249)
• connectInfiniteHits: clear the state on dispose (#3819) (60ce151)
• connectMenu: update getWidgetSearchParameters (#4054) (7d001e7)
• connectNumericMenu: update state lifecycle (#4013) (2620c90)
• connectPagination: add default value on getConfiguration (#3838) (aa4602c)
• connectPagination: clear the state on dispose (#3821) (5b8ef49)
• connectPagination: update getWidgetSearchParameters (#4004) (eed7e77)
• connectRange: default precision to 0 (#3953) (632e06b)
• connectRatingMenu: update getWidgetSearchParameters (#4008) (d3c96bf)
• connectRefinementList: update getWidgetSearchParameters (#4010) (ddc8fc4)
• connectSearchBox: clear the state on dispose (#3822) (940522c)
• connectSearchBox: mount with a default query (#3840) (c3a7d69)
• connectSearchBox: update getWidgetSearchParameters (#4002) (5c6fcd8)
• connectVoiceSearch: add default value on getConfiguration (#3841) (fb70363)
• connectVoiceSearch: clear the state on dispose (#3823) (705b3e6)
• connectVoiceSearch: update getWidgetSearchParameters (#4055) (b8c669f)
• core: deprecate addWidget & removeWidget (#4131) (e5dafef)
• currentRefinements: support multiple indices (#4012) (e997728)
• defer: implement cancellable callback (#3916) (43a0bf8)
• federated: keep a consistent state in the RefinementList life cycle (#3976) (31d0fd6)
• hitsPerPage: support new routing system (#4038) (02502cb), closes #4069
• index: accept indexId (#4070) (b74f8e3)
• index: add mergeSearchParameters function (#3917) (c0fe7bb)
• index: add widget (dbbda0f), closes #3892 #3893 #3914
• index: compute local uiState (#3997) (997c0f4)
• index: merge ruleContexts search parameter (#3944) (e94752d)
• index: provide scoped results to render hook (#3964) (37c6aad)
• index: replicate searchFunction hack (#4078) (1d2a816), closes /github.com/algolia/instantsearch.js/blob/509513c0feafaad522f6f18d87a441559f4aa050/src/lib/RoutingManager.ts#L113-L130
• index: reset page of child indexes (#3962) (131b1ce)
• index: resolve parent SearchParameters (#3937) (2611da5)
• index: use uiState driven SearchParameters (#4059) (b12bb9f)
• infiniteHits: support new routing system (#4040) (49315cf)
• instantsearch: add onStateChange method (#4080) (9f68da5)
• InstantSearch: switch to DerivedHelper only (#3885) (d6fc317)
• places: add Places widget (#4167) (1d754d1)
• drop support of searchParameters for initialUiState (#4081) (571efeb)
• range: support new routing system (#4039) (8cba05a)
• routing: add a "single index" compatibility mode (#4087) (842eb0f)
• RoutingManager: update state on route update (#4100) (88f2615)
• toggleRefinement: support new routing system (#4037) (6a9d99f)
• types: DerivedHelper (#3887) (0f38b4a)
• types: rename RenderOptions -> RendererOptions (#3867) (05c6f72)
• utils: implement defer (#3882) (8af470e)
• voice: add additional query parameters (#3738) (c555255)
• drop suppot for onHistoryChange (#3941) (697f609)
• introduce initialUiState option (#4074) (de00707)
• update UiState definition (#4075) (9e7d3d8)
• widgets: add $$type to widgets definition (#3960) (344d1b7)

3.7.0 (2019-10-08)

Bug Fixes

• clearRefinements: reset page to 0 (#3936) (7378a0a)
• connectSortBy: never update the initial index (#4015) (bc0f9e2)
• deps: update dependency instantsearch.js to v3.5.4 (#3929) (eff84c5)
• deps: update dependency instantsearch.js to v3.6.0 (#4021) (7719bba)
• enhanceConfiguration: deduplicate the hierarchicalFacets (#3966) (baf8a35)
• examples: fix IE11 compatibility for e-commerce demo (#4049) (dc6f350)
• examples: fix missing polyfill in e-commerce demo (#4076) (4bf3ab3)
• hierarchicalFacets: prevent different rootPath on same attribute (#3965) (5ee79fa)
• instantsearch: warn deprecated usage of searchParameters (#4151) (18e1c36)
• menuSelect: unmount component (#3911) (f6debce)
• rangeInput: unmount component (#3910) (f6c29e8)
• refinementList: fix showMore button to work after search (#3082) (23e46b6)
• pass noop as default value to unmountFn at connectors (#3955) (7c38744)

3.6.0 (2019-07-30)

Bug Fixes

• clearRefinements: reset page to 0 (#3936) (7378a0a)
• pass noop as default value to unmountFn at connectors (#3955) (7c38744)
• enhanceConfiguration: deduplicate the hierarchicalFacets (#3966) (baf8a35)
• hierarchicalFacets: prevent different rootPath on same attribute (#3965) (5ee79fa)
• menuSelect: unmount component (#3911) (f6debce)
• rangeInput: unmount component (#3910) (f6c29e8)
• refinementList: fix showMore button to work after search (#3082) (23e46b6)

3.5.4 (2019-07-01)

Bug Fixes

• connectSortBy: do not throw with wrong indexes (#3824) (2a84ee2)
• deps: update dependency instantsearch.js to v3.5.3 (#3877) (463f3bb)
• escape: make sure that __escaped does not get removed (#3830) (fbafd22)
• getRefinements: check for facet before accessing its data (#3842) (aadc769)
• panel: return value from dispose (#3895) (bceb78f)
• voiceSearch: remove event listeners on stop (#3845) (688e36a)

3.5.3 (2019-05-28)

Bug Fixes

• voiceSearch: let the connector handle the default value of searchAsYouSpeak when it's not given (#3817) (9d3e91b)
• getTag: use object version of toString (#3820) (a7348ea)
• types: fix cssClasses of voiceSearch (#3783) (f016326)

3.5.1 (2019-05-20)

Bug Fixes

• types: improve types for voiceSearch (#3778) (ed2d61a)
• types: update UiState type (#3777) (36e3a3d)
• voiceSearch: remove event listeners on dispose (#3779) (0e988cc)
• hitsPerPage: improve warning for missing state value (#3707) (93d8432)
• numericMenu: prevent refinement reset on checked radio click (#3749) (e4a6e75)
• rangeSlider: round the slider pit value (#3758) (6edee3e), closes #2904
• types: improve UiState types (#3763) (e8ea57b)
• voice: import correct noop (#3766) (6a80422)

Features

• voiceSearch: add connector and widget (#3601) (21e4d81)

Reverts

• chore(build): remove PropTypes from builds (#3697) (#3776) (1e6be79)

3.4.0 (2019-04-17)

Bug Fixes

• storybook: fix Hierarchical menu separator in Breadcrumb story (#3695) (b3bf8ac)
• tools: use commonjs in bump-package-version.js (#3699) (6a6dbe1)
• types: fix wrong typing in getWidgetState (#3693) (b3c2154)
• types: remove unused Without type (#3694) (656d000)

Features

• infiniteHits: add previous button (#3675) (2e6137b)
• Insights: Insights inside Instantsearch (#3598) (387f41f)

3.3.0 (2019-04-11)

Bug Fixes

• connectQueryRules: improve tracked refinement type (#3648) (e16ad57)
• currentRefinements: don't rely on _objectSpread (#3672) (cd64bcf)
• queryRuleCustomData: add default template (#3650) (83e9eaa)
• QueryRuleCustomData: pass data as object to templates (#3647) (b8f8b4e)
• queryRules: fix types and stories (#3670) (ba6e2e6)
• routing: apply windowTitle on first load (#3669) (d553502), closes #3667
• routing: support parsing URLs with up to 100 refinements (#3671) (6ddcfb6)
• RoutingManager: avoid stale uiState (#3630) (e1588aa)
• types: improve InstantSearch types (#3651) (db9b91e)
• ua: Update the User-Agent to use the new format (#3616) (ab84c57)

Features

• infiniteHits: add previous button (#3645) (2c9e38d)
• queryRules: add connectQueryRules connector (#3597) (924cd99), closes #3599 #3600
• queryRules: add context features to Query Rules (#3617) (922879e), closes #3602

Reverts

• feat(infiniteHits): add previous button (214c0fc)

3.2.1 (2019-03-18)

Bug Fixes

• connectToggleRefinement: keep user provided, but falsy values (#3526) (958a151)
• instantsearch: update usage errors (#3543) (a2a800b)
• panel: append panel body as a child element (#3561) (3de59a3)
• poweredBy: remove TypeScript extension in import (#3530) (99ecc0b), closes #3528
• release: update doctoc script (e07c654)
• searchbox: unmount component on dispose (#3563) (c3f0435)
• searchBox: add reusable SearchBox component (#3489) (c073a9a)

Features

• panel: implement collapsed feature (#3575) (e84b02b)

3.2.0 (2019-03-14)

Bug Fixes

• instantsearch: update usage errors (#3543) (a2a800b)
• searchBox: add reusable SearchBox component (#3489) (c073a9a)

Features

• panel: implement collapsed feature (#3575) (e84b02b)

3.1.1 (2019-02-14)

Bug Fixes

• connectToggleRefinement: keep user provided, but falsy values (#3526) (958a151)
• poweredBy: remove TypeScript extension in import (#3530) (99ecc0b), closes #3528
• release: update doctoc script (e07c654)

3.1.0 (2019-02-13)

Features

• connectCurrentRefinements: add a root label (#3515) (b8f774f)
• Update error messages (#3516)
• InstantSearch: remove event listeners on dispose (#3420)
• InstantSearch: set helper to null on dispose (#3415)
• utils: warn only in development (#3367)

Bug Fixes

• InstantSearch: set helper to null on dispose (#3415)
• utils: warn only in development (#3367)

3.0.0 (2018-12-20)

Check the migration guide.

2.10.4 (2018-10-30)

Bug Fixes

• getRefinements: provide attributeName for type: query (6a58b99), closes #3205

2.10.3 (2018-10-29)

Bug Fixes

• deps: unpin production dependencies (257ecb7)
• InstantSearch: avoid useless search on addWidgets (#3178) (961626d)
• numericselector: default value can be undefined (#3139) (39d22f5)

Features

• utils: add warn function (#3147) (9de87bb)

2.10.2 (2018-09-10)

Bug Fixes

• searchbox: Add missing color to searchbox input field (#3086) (62b852a), closes #3075
• Stats: let the widget render on all values (#3070) (cd8f17e), closes #3056

2.10.1 (2018-08-17)

Bug Fixes

• connectBreadcrumb: ensure that data is an array (#3067) (759f709)

2.10.0 (2018-08-08)

Bug Fixes

• release: provide interactive TTY for npm publish (#3053) (ede9460)

Features

• Implement transformItems API (#3042) (1510a94)

2.9.0 (2018-07-18)

Features

• infiniteHits: add showmoreButton to cssClasses (#3026) (8287de0)

2.8.1 (2018-07-03)

Bug Fixes

• connectHitsPerPage: default value should not break the API (#3006) (6635304), closes #2732
• connectRefinementList: throw error with usage (#2962) (f60222d)
• sourcemap: provide good url (#3011) (9632ade)
• warning: make sure suggested import is possible (#3014) (eb27152)

2.8.0 (2018-05-30)

Features

• connectors: add connectAutocomplete (#2841) (4bec81e), closes /github.com/algolia/instantsearch.js/pull/2841#discussion_r188383882 #2313
• search-client: Add support for Universal Search Clients (#2894) (5df3c74), closes #2905

2.7.6 (2018-05-29)

Bug Fixes

• connectConfigure: ensure we do not extend SearchParameters (#2945) (fdb4a7a)
• infinite-hits: fix #2543 (#2948) (bbf9f8f)

2.7.5 (2018-05-28)

Bug Fixes

• clear-all: apply excludeAttribute correctly with clearsQuery (#2935) (e782ab8)
• connectInfiniteHits: fix #2928 (#2939) (0293a31)

2.7.4 (2018-05-03)

Bug Fixes

• searchFunction: Fix unresolved returned Promise (#2913) (5286c7c)

2.7.3 (2018-04-26)

Bug Fixes

• index.es6: avoid use of Object.assign for IE (#2908) (228b02e)

2.7.2 (2018-04-18)

Bug Fixes

• routing: should apply stateMapping when doing initial write (#2892) (7f62e6dc)
• ie: do not rely on Object.assign (#2885) (88497e56)

2.7.1 (2018-04-11)

Bug Fixes

• history: provide location and use named parameters (#2877) (761ffa4)

2.7.0 (2018-04-09)

Bug Fixes

• pagination padding (#2866) (e8c58cc)
• geosearch: avoid reset map when it already moved (#2870) (f171b8a)
• removeWidget: check for widgets.length on next tick (#2831) (7e639d6)

Features

• connetConfigure: add a connector to create a connector widget (8fdf752)
• routing: provide a mechanism to synchronize the search (#2829) (75b2ca3), closes #2849 #2849
• size: add sideEffects false to package.json (#2861) (f5d1ab1), closes #2859

2.6.3 (2018-03-30)

Bug Fixes

• rangeSlider: handles were blocked (#2849) (a2af4f0)

2.6.2 (2018-03-29)

Bug Fixes

• connectGeoSearch: correctly dispose the connector (#2845) (a4eafd2)
• GeoSearch: correctly unmount the widget (#2846) (f31ef3c)

2.6.1 (2018-03-28)

Bug Fixes

• connectBreadcrumb: allow unmounting (#2815) (c6c353a)
• connectBreadcrumb: update typo in property type items (#2782) (79ebd66)
• docgen: pass the relatedTypes to the struct mixin in connectors layout (#2780) (f7f8b05)
• GeoSearch: update typo in property type cssClasses (#2781) (419c2ab)
• main: correctly import EventEmitter (#2814) (8fa3649), closes #2730

2.6.0 (2018-03-06)

Bug Fixes

• GeoSearch: add apiKey for Google Maps (#2773) (6c1846f)
• GeoSearch: override button style (#2772) (4d69b50)

Features

• configure: add the Configure widget (#2698) (94daabc)
• add GeoSearch widget & connector (#2743) (7fa17ff)

2.5.2 (2018-02-26)

Bug Fixes

• Template: harden Symbol checks (#2749) (fab66bc)
• yarnrc: use empty string for save-prefix (#2739) (979e0cd)

2.5.1 (2018-02-13)

Bug Fixes

• perf: only compute snappoints when step is provided (#2699) (ce9ca19), closes #2662

2.5.0 (2018-02-06)

Bug Fixes

• doc: add maximum width to images (fix #2685) (#2686) (f4b5377)

Features

• support for algolia insights (#2689) (96b8d61)

2.4.1 (2018-01-04)

Bug Fixes

• core: correct escape highlight for arrays and nested objects (#2646) (ed0ee73)

2.4.0 (2018-01-02)

Bug Fixes

• pagination: disable buttons if not results (#2643) (9017b72), closes #2014
• theme: fix height of pagination (#2641) (b3185e5)

Features

• core: add a reload method on the InstantSearch component (#2637) (e73ff13)
• core: add an error event to monitor error from Algolia (#2642) (71c2d68), closes #1585
• core: rename reload to refresh (#2645) (9b8ac65)
• wrapWithHits: enable async init (#2635) (08a8747)

2.3.3 (2017-12-11)

Bug Fixes

• core: search is stalled at init (#2623) (e3dd577), closes #2616

2.3.2 (2017-12-06)

Bug Fixes

• React reference: Breadcrumb & RangeInput components (#2618) (7f32161)

2.3.1 (2017-12-04)

Bug Fixes

• connectors: check facet is refined before removing it. hierarchicalMenu / menu (67ae035)
• poweredBy: minify slightly and make into correct URL (#2615) (2b7d747), closes #2613

2.3.0 (2017-11-30)

Bug Fixes

• InstantSearch.dispose: dont call getConfiguration of URLSync widget (#2604) (3234b12)
• connectors: prefer wrappers over bind (#2575) (f8e0e00)
• connectHierarchicalMenu: do not return if facet not set (#2521) (26e99fb)

Features

• core: provide information about stalled search to widgets (#2569) (d104be1)
• core: InstantSearch hot remove/add widgets (#2384) (cfc1710)
• refinementList: add escapeFacetHits parameter (#2507) (9b1b7ee)
• breadcrumb: Add the breadcrumb widget (#2451) (11d78f0), closes #2299
• connectRange: round the range based on precision (#2498) (d4df45d)
• rangeInput: add rangeInput widget (#2440) (7916d16)

2.2.5 (2017-11-20)

Bug Fixes

• searchbox: fix usage of custom reset template (#2585) (aad92b9), closes #2528

2.2.4 (2017-11-13)

Bug Fixes

• numericSelector: make default value possible (#2565) (5664f98)

2.2.3 (2017-11-07)

Bug Fixes

• connectRefinementList: add label to searched items (#2553) (ec810fa)
• refinementList: fix facet exhaustivity check (#2554) (0f1bf08), closes #2552
• theme: searchbar should have normal size input (#2545) (50d99f0)

2.2.2 (2017-10-30)

Bug Fixes

• connectRefinementList: set default value for limit (#2517) (32918c9)
• MenuSelect: switch from react to preact-compat (#2513) (06aa626)
• range-slider: add option collapsible (#2502) (e78399d), closes #2501
• url-sync: make URLSync consistent even if search is tampered (392927e), closes #2523

2.2.1 (2017-10-16)

Bug Fixes

• connectRangeSlider: only clear the refinement on the current attribute (#2459) (7cebf58)
• menuSelect: select in userCssClasses (#2455) (0eb3dc8)
• menuSelect: use preact instead of React (#2460) (35ccae8)
• test: correctly reset the wired dependency (#2461) (1f7f4ed)

2.2.0 (2017-10-03)

Bug Fixes

• build: minify css with csso instead of unminify css (#2419) (12f96b8), closes #2375
• clear-all: display the query when clearsQuery is true (#2414) (6921895)
• range-slider: Fix slider boundaries (#2408) (bea43db), closes #2386
• selector: root classname is applied twice (#2423) (44dca11), closes #2396 #2397
• webpack.dev: sourcemaps in dev (#2422) (ba6ca0a)

Features

• menu-select: add menu select widget (#2316) (680f9bd)

2.2.0-beta.1 (2017-09-18)

Features

• analytics: Push pagination (#2337) (94ce086)
• hitsPerPageSelector: default hits per page setting (4efd43e)
• hitsPerPageSelector: default hits per page setting (355f080)

2.1.6 (2017-09-26)

Bug Fixes

• deps: update dependency documentation to v^5.0.0 (#2355) (489647a)
• searchbox: use initial input value if provided in the dom (#2342) (180902a), closes #2289

2.1.5 (2017-09-25)

Bug Fixes

• deps: update dependency algolia-frontend-components to v^0.0.33 (#2341) (16994d8)
• price-ranges: update call to refine (#2377) (34915d7)
• slider: Fix range slider pips and value 0 (#2350) (fa0dc09), closes #2343

2.1.4 (2017-09-14)

Bug Fixes

• release-script: Add the generation of changelog for the release (#2333) (9a2f70b)
• slider: edge case when min > max (#2336) (8830ab0)
• slider: Fix range slider dev env (#2320) (e78de70)
• slider: use algolia fork of rheostat (#2335) (9eae009)

2.1.3 (2017-09-05)

Bug Fixes

• Pagination: add autohideContainerHOC to (#2296) (545f076)
• sffv: no error when not providing noResults and no results (#2310) (cc02b71), closes #2087

2.1.2 (2017-08-24)

Bug Fixes

• es: wrong path to files (#2295) (a437e19)

2.1.1 (2017-08-23)

Bug Fixes

• build: provide unminified css as well (#2292) (a79e067)

2.1.0 (2017-08-21)

Bug Fixes

• nvmrc: upgrade nodejs version (#2291) (94529d4)

2.0.2 (2017-07-24)

Bug Fixes

• doc: Cosmetic change (48bb128)
• search-box: fix magnifier and reset customization (4adfade)
• theme: enforce box-sizing: border-box (e26e50d)
• url-sync: remove is_v from url (f19a1d5), closes #2233

2.0.1 (2017-07-12)

2.0.0 (2017-07-01)

Bug Fixes

• argos-ci: blur the active element (66d0551)
• connectNumericRefinementList: reset page on refine (22ec08d)
• doc.build: watch & rebuild .pug (16d8542)
• doc.build/autoprefixer: update mtime for onlyChanged plugin (3b83e58)
• escapeHits: dont apply configuration if not requested (c89f99d)

Features

• searchFunction: make search function provide a better API (8fc0831)

2.0.0-beta.5 (2017-06-01)

Bug Fixes

• Slider: dont call refine() when it's disabled (f1eabc9)

Features

• hits: opt-in xss filtering for hits and infinite hits. FIX #2138 (4f67b48), closes #2138

2.0.0-beta.4 (2017-05-24)

Bug Fixes

• misc: IE 11 support (072edfe)
• misc: IE11 support without using transpiler (324f062)
• show-more: should hide button when show more is not available (#2161) (fbca3e6), closes #2160
• Slider: handle edge case where min === max (22a5614)
• Slider: restore slider--handle-lower && slider--handle-upper (64d7ad2)

2.0.0-beta.2 (2017-05-17)

Bug Fixes

• autoHideContainer: dont prevent render with shouldComponentUpdate (8c4b13f)
• clearsQuery: not applied when only the query was not empty (e7976ad)
• connectors: ensure widgetParams is at least an {} (0c0e98f)
• connectRefinementList: currentRefinements: return an array instead of first item (a53223a), closes #2102
• dev:docs: dont watch /docgen/rootFiles (ab1a7f5)
• doc: add doc for isFirstRendering (cea6739)
• docs: dont filter out p.type.type (881659a)
• documentation.js: Support for record types (219ecd9)
• documentationjs: add support litteral string types in type format (2a08e7d)
• documentationjs: deeper related types (6e3121e)
• documentationjs: find related type in TypeApplication (e0487ee)
• documentationjs: fix 2+ depth structs (4c8b7ec)
• documentationjs: fixed default value parameter (b62cbc7)
• documentationjs: records display with , (8a968f2)
• documentationjs: Updgrade to RC + fixes (e9f0361)
• infinite-hits: Remove hitsPerPage option (#2128) (c13e377)
• live-example: adapt regex for matching connectors (774254c)
• pagination: fix zealous find/replace (e269d87)
• price-ranges: fix test (fd65cb3)
• price-ranges: New API uses ranges (a5a6916)
• refinementList: reimplement show more on refinement list (72655ab)
• refinementList: sffv fix thanks @julienpa (30e0e9a)
• sffv: Fix exhaustive facets (0cadcc3)
• sortby: Consistent across widget / connectors + migration (8e366cc)
• widgets/price-ranges: wrong compute of templateProps (be5e063)

Features

• connectHierarchicalMenu: remove currentRefinement (3912aaf)
• connectHits: typo widgetOptions -> widgetParams (4420231)
• connector: Add hierarchical menu connector (f727949)
• connector: add infinite hits connector (cdf8675)
• connector: add instantsearchInstance to pagination render (4fa96dc)
• connector: add missing jsDoc descriptions (e26e8e2)
• connector: add range-slider (1a02798)
• connector: add tests for connectClearAll and connectHierarchicalMenu (0eb29ec)
• connector: Adds hits and menu connectors (77083b7)
• connector: Clear and CurrentRefinedValues (02f7d3e)
• connector: clearAll connector (iteration 2) (90aa02e)
• connector: clearAll jsDoc + eslint fixes (430a420)
• connector: complete jsdoc + pass instantsearch to view (e125931)
• connector: connectClearAll documentation (9b153aa)
• connector: connectClearAll iteration 2 (fix) (03653f1)
• connector: connectClearAll test (5409157)
• connector: connectCurrentRefinedValues (iteration 2) (68408de)
• connector: connectHierarchicalMenu (iteration 2) (589454c)
• connector: connectHierarchicalMenu jsDoc (e166090)
• connector: connectHits (iteration 2) (bca09af)
• connector: connectHitsPerPageSelector (iteration 2) (26bb273)
• connector: connectInfiniteHits (iteration 2) (410459c)
• connector: connectNumericRefinementList (iteration 2) (bfcf860)
• connector: connectNumericSelector (iteration 2) (1eda8a2)
• connector: connectNumericSelector jsDoc (760fcea)
• connector: connectRefinementList jsdoc + start document bool isFirstRendering (52d13de)
• connector: connectStats second iteration (82b1cb3)
• connector: connectToggle second iteration (73b0878)
• connector: fix createURL usage to generate correct urls (fdf59d7)
• connector: fix no param usage on custom infiniteHits (961348a)
• connector: fix parameter consistency in connectClearAll (9ddffd8)
• connector: Fix parameters for toggle connector (f96671c)
• connector: hits-per-page-selector connector refactoring (dd794e0)
• connector: jsDoc + check rendering function (86f9739)
• connector: jsDoc connectPagination (3b284de)
• connector: jsDoc for connectMenu (626d5f1)
• connector: jsDoc updates (c924043)
• connector: move clearAll as a rendering option (ce41cde)
• connector: Numeric selector (0dc42d2)
• connector: numericRefinementList connector (918d971)
• connector: pagination connector (7a876f3)
• connector: price ranges connector (d8bed96)
• connector: provide consistent interface for searchbox renderer (17d8301)
• connector: provide instantsearch instance at render (12a7935)
• connector: refactor search function (618dca2)
• connector: refinement list connector (c8fcf4e)
• connector: remove legacy implementation of toggle (04437b0)
• connector: remove non relevant instantsearch API from test (c5dce5c)
• connector: remove unused parameter to searchbox connector (e639f65)
• connector: searchbox connector (70f8e1f)
• connector: small internal refactoring for SFFV (cb5c1fa)
• connector: sort by selector connector (b9847cf)
• connector: star rating connector (9996b4d)
• connector: stats connector (680743b)
• connector: test connectHits (89c86a5)
• connector: test connectHitsPerPageSelector (9caab02)
• connector: test connectInfiniteHits (e67e75e)
• connector: test connectMenu (03c6f11)
• connector: test connectNumericRefinementList (2f26251)
• connector: test connectNumericSelector (182779b)
• connector: test connectPagination (6f125b7)
• connector: test connectPriceRanges (f5dfba7)
• connector: test connectRangeSlider (4f6c180)
• connector: test connectSearchBox (b4d7e1b)
• connector: test connectSortBySelector (e8825df)
• connector: test connectStarRating (0c16f15), closes #2002
• connector: test connectStats (c992288)
• connector: test connectToggle (441293d)
• connector: toggle connector (bf9a9c0)
• connector: update doc, move setValue to refine in SortBySelector (2486f36)
• connector: update jsDoc descriptions (f83022a)
• connectors: refinement-list widget (iteration2) (1c6c3a5)
• connectors: setValue() -> refine() / currentValue -> currentRefinement (ec7806c)
• connectors: sortBy to ['isRefined', 'count:desc'] (01219f1)
• connectors: add currentRefinement on hierarchical-menu (154cdb5)
• connectors: connectPagination (iteration2) (8a615f6)
• connectors: connectPriceRanges (iteration2) (e34968e)
• connectors: connectRangeSlider (iteration2) (6073d94)
• connectors: connectSearchBox (iteration2) (3161c9b)
• connectors: connectSortBySelector (iteration 2) (dec2d31)
• connectors: connectStarRating (iteration2) (7ef7b6b)
• connectors: connectToggle, forward initial options to render (704a455)
• connectors: dissociate logic & view for menu widget (5a02c88)
• connectors: expose connectors on instantsearch instance (ff799d0)
• connectors: forward widgetParams to renderFn (54222a3)
• connectors: jsDoc connectHitsPerPageSelector (75243b0)
• connectors: provide currentRefinement on menu (fb7bc5e)
• connectors: provide currentRefinement on numeric refinement list (91f7928)
• connectors.numeric-selector: currentValue -> currentRefinement / setValue() -> refine() (998faf1)
• connectors.price-ranges: provides currentRefiment value (39af437)
• connectors.refinement-list: provide currentRefinement to renderFn (7e86be3)
• connectors.star-rating: provide currentRefinement value (c08b3e4)
• connectRefinementList: first good iteration (88fd6d5)
• doc: re-bootstrap doc based on instantsearch-android (e4e816e)
• docs: bootstrap v2 docs (0db6caf)
• docs: pages structure (fe89dcf)
• getting-started: add .zip boilerplate (7d3769c)
• getting-started: add result example of guide (78d9017)
• live-example: add support of connectors (e4f3158)
• live-example: include jquery on connectors example pages (f32936f)
• main: export all the widgets at once (4bc2d21)
• numeric-refinement-list: facetValues -> items / toggleRefinement -> refine (eb2c993)
• pagination: setPage() -> refine() / currentPage -> currentRefinement (f783fea)
• range-slider: use rheostat as slider component (#2142) (910a0a0)
• searchFunction: Update API, fix #1924 (c7beb1d), closes #1924
• sort-by-selector: currentValue -> currentRefinement (e94c8c7)
• Template: remove support for react element (ca2ab44)

1.11.15 (2017-06-20)

Bug Fixes

• numeric-refinement-list: reset page on refine (ee55ccb)

1.11.14 (2017-06-19)

Bug Fixes

• powered-by: update logo (7e68b51), closes #2126

1.11.13 (2017-06-07)

Bug Fixes

• url-sync: reverting back to using change event (#2183) (07f4be0), closes #2173 #2171

1.11.12 (2017-05-30)

Bug Fixes

• sffv: when using a large limit, retain the search (#2163) (3d95d4c), closes #2156

1.11.10 (2017-05-17)

1.11.9 (2017-05-17)

1.11.8 (2017-05-16)

Bug Fixes

• url-sync: set firstRender to be class attribute (22dbaeb)

1.11.7 (2017-04-24)

Bug Fixes

• sffv: add class for disabled state at the form level (#2122) (029fa5f)
• sffv: fixes typo (: was left) (26d2845)

1.11.6 (2017-04-20)

Bug Fixes

• CONTRIBUTING: remove section about beta releases (#2109) (5640131)
• sffv: disable sffv input when few facet values FIX #2111 (1e33c10), closes #2111

1.11.5 (2017-04-12)

Bug Fixes

• url-sync: sync url on search (#2108) (7f33ffb)

1.11.4 (2017-03-29)

Bug Fixes

• autoHideContainer: dont prevent render with shouldComponentUpdate (#2076) (b520400)
• star-rating: make max value inclusive (f5fc41c), closes #2002

1.11.3 (2017-03-22)

Bug Fixes

• Slider: display disabled slider when min === max (#2041) (511fdfd), closes #2037

1.11.2 (2017-02-28)

Bug Fixes

• searchBox: avoid unwanted cursor jumps on hashchange (#2013) (d0103db), closes #2012

1.11.1 (2017-02-14)

Bug Fixes

• infinite-hits: disable load more button when no more pages (#1973) (745ed89), closes #1971

1.11.0 (2017-02-12)

Features

• analytics-widget: add a new parameter pushInitialSearch (#1963) (d777997)
• custom client: allows to provide a custom JS client instance (#1948) (cce4f2e)
• InfiniteHits: add new widget (2d77e4b)

1.10.5 (2017-02-06)

Bug Fixes

• urlSync: update url only after threshold (#1917) (b0f0cf1), closes #1856

1.10.4 (2017-01-25)

1.10.3 (2016-12-26)

Bug Fixes

• sffv-searchbox: update classnames to avoid conflicts (#1781) (f53e8fd)

1.10.2 (2016-12-23)

Bug Fixes

• url: clear timeout on pop (41ad9af)