A simple module that adds voice search capabilities to the Magento 2 global search. An icon will be displayed in the search bar if the module is enabled.
Installation via composer is recommended.
composer require aimes/module-voice-searchphp bin/magento module:enable Aimes_VoiceSearchphp bin/magento setup:upgrade
Alternatively, if for whatever reason you are not using composer, put the contents of this repository in <magento_directory>/app/code/Aimes/VoiceSearch
- Enable Voice Search
Default: Yes- When disabled this module will have no effect
- Skip Suggestions
Default: No- With this value set to
Nothe search autocomplete suggestions will display to the user - With this value set to
Yesthe user will be directed to the relevant catalogsearch page and will not fire an AJAX request to get autocomplete results
- With this value set to
This module is tested and developed on an unmodified Magento 2.3.5 Open Source instance with Luma theme and sample data. Results may vary using a custom theme.
The voice search functionality is powered by a jQuery widget $.aimes.voiceSearch which exposes 2 public methods for convenience.
startSpeechRecognition- Start listening for user speechstopSpeechRecognition- Stop listening for user speech
Example:
$('#search').voiceSearch('startSpeechRecognition');
$('#search').voiceSearch('stopSpeechRecognition');The widget has multiple functions for extension. One for each event. It is suggested you use mixins to add additional functionality where appropriate.
This module makes use of the SpeechRecognition API. Browser support can be seen on this page or on caniuse.