aimes/module-voice-search

为 Magento 2 全局搜索添加语音搜索功能

维护者

详细信息

github.com/robaimes/module-voice-search

源代码

问题

安装: 3

依赖项: 0

建议者: 0

安全: 0

星级: 4

关注者: 0

分支: 0

开放问题: 1

语言:JavaScript

类型:magento2-module

1.0.0 2020-07-26 18:14 UTC

Requires

  • magento/module-catalog-search: ^101.0

proprietary d0d91b0cf9906b0c60386e147a312b935b6736e2

This package is auto-updated.

Last update: 2024-09-15 04:10:43 UTC

README

这是一个简单的模块，可以将语音搜索功能添加到 Magento 2 的全局搜索中。如果模块已启用，搜索栏中将显示一个图标。

安装

建议通过 composer 进行安装。

  • composer require aimes/module-voice-search
  • php bin/magento module:enable Aimes_VoiceSearch
  • php bin/magento setup:upgrade

或者，如果您由于任何原因不使用 composer，请将此存储库的内容放入 <magento_directory>/app/code/Aimes/VoiceSearch

配置

  • 启用语音搜索 默认值：是
    • 禁用时，此模块不会产生影响
  • 跳过建议 默认值：否
    • 将此值设置为 否 时，将向用户显示搜索自动完成建议
    • 将此值设置为 是 时，用户将被引导到相关的 catalogsearch 页面，并且不会触发 AJAX 请求以获取自动完成结果

此模块在未经修改的 Magento 2.3.5 Open Source 实例上进行了测试和开发，使用了 Luma 主题和示例数据。使用自定义主题时，结果可能会有所不同。

开发人员说明

语音搜索功能由一个 jQuery 小部件 $.aimes.voiceSearch 支持，该小部件提供了 2 个公共方法以方便使用。

  • startSpeechRecognition - 开始监听用户语音
  • stopSpeechRecognition - 停止监听用户语音

示例

$('#search').voiceSearch('startSpeechRecognition');
$('#search').voiceSearch('stopSpeechRecognition');

该小部件具有多个用于扩展的功能。每个 事件 都有一个。建议您使用 混合 在适当的位置添加额外的功能。

浏览器支持

此模块使用了 SpeechRecognition API。浏览器支持可以在本页或 caniuse 上查看。