You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -62,7 +63,7 @@ The easiest way to install the extension is to use [Composer](https://getcompose
62
63
63
64
If you would like to stay on a minor version, please upgrade your composer to only accept minor versions. The following example will keep you on the minor version and will update patches automatically.
64
65
65
-
`"algolia/algoliasearch-magento-2": "~3.14.2"`
66
+
`"algolia/algoliasearch-magento-2": "~3.15.0"`
66
67
67
68
### Customisation
68
69
@@ -71,30 +72,51 @@ The extension uses libraries to help assist with the frontend implementation for
71
72
These libraries are here to help add to your customisation but because the extension has already initialised these components, you should use hooks into the area between the extension and the libraries.
72
73
Please check our [Custom Extension](https://github.com/algolia/algoliasearch-custom-algolia-magento-2) for refrence
73
74
74
-
### The Extension JS Bundle
75
+
### Frontend JavaScript libraries
75
76
76
-
Knowing the version of the library will help you understand what is available in these libraries for you to leverage in terms of customisation. This table will help you determine which documentation to reference when you start working on your customisation.
77
+
> As of v3.15.x the JavaScript bundle `algoliaBundle` has been removed as a hard dependency for the Magento extension and will be removed entirely in the next minor release. Libraries can now be swapped independently and loaded via RequireJS.
| v3.x |[0.38.0](https://github.com/algolia/autocomplete.js/tree/v0.38.0)|[4.15.0](https://github.com/algolia/instantsearch.js/tree/v4.15.0)|[1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1)| NA |
Knowing the version of each Algolia JavaScript library will help you understand what is available for you to leverage in terms of customisation. This table will help you determine which documentation to reference when you start working on your customisation.
86
80
87
-
The autocomplete and instantsearch libraries are accessible in the `algoliaBundle` global. This bundle is a prepackage javascript file that contains it's dependencies. What is included in this bundle can be seen here:
| v3.x |[0.38.0](https://github.com/algolia/autocomplete.js/tree/v0.38.0)*|[4.15.0](https://github.com/algolia/instantsearch.js/tree/v4.15.0)*|[1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1)| NA |
* In earlier versions of the extension, the Autocomplete and InstantSearch libraries were accessible via the `algoliaBundle` global. This bundle was a prepackaged JavaScript file that contained dependencies for the frontend experience. What was included in this bundle can be seen here: https://github.com/algolia/algoliasearch-extensions-bundle/blob/ISv4/package.json
92
92
93
93
Refer to these docs when customising your Algolia Magento extension frontend features:
Libraries should be fully compatible with [standard JavaScript bundling](https://developer.adobe.com/commerce/frontend-core/guide/themes/js-bundling/). If using ["advanced bundling"](https://experienceleague.adobe.com/en/docs/commerce-operations/performance-best-practices/performance-best-practices/advanced-js-bundling) via the [RequireJS optimizer](https://requirejs.org/docs/optimization.html) it will be necessary to first apply the Babel transpiler to the underlying source code.
101
+
102
+
A sample transpiler configuration (`.babelrc`) might look as follows:
The extension does most of the heavy lifting when it comes to gathering and preparing the data needed for indexing to Algolia. In terms of interacting with the Algolia Search API, the extension leverages the PHP API Client for backend methods including indexing, configuration, and search queries.
0 commit comments