README

yii2-widget-typeahead      

Typeahead扩展是Yii 2包装器小部件，用于Twitter Typeahead.js插件，并添加了某些自定义增强功能。最新版本使用来自corejavascript的typeahead.js分支。yii2-widget-typeahead扩展是基于jQuery的文本输入替代品，提供搜索和自动完成功能。它受到twitter.com的自动完成搜索功能的启发，并基于Twitter的typeahead.js，这是一种快速且功能齐全的自动完成库。小部件特别为Bootstrap 3.x、4.x或5.x进行样式设计。如果浏览器不支持JQuery，小部件可以优雅地降级为正常的HTML文本输入。您也可以为小部件设置与任何其他字段一样模型验证规则。扩展提供了两种小部件实现变体

• TypeaheadBasic：此小部件是typeahead.js插件的基本实现，没有任何建议引擎。它使用javascript子串匹配器和正则表达式匹配来查询和显示建议。查看演示

• Typeahead：此小部件是typeahead.js插件的先进实现，具有BloodHound建议引擎和Handlebars模板编译器。查看演示

注意：此扩展是yii2-widgets的子仓库拆分。拆分自2014年11月8日起完成，以便开发人员在需要时可以独立安装此特定小部件。也可以像以前一样使用整个yii2-widgets套件中的扩展。

安装

安装此扩展的首选方式是通过composer。检查此扩展的composer.json以获取扩展的要求和依赖项。阅读此web提示/wiki，了解如何设置应用程序composer.json中的minimum-stability设置。

要安装，请运行

$ php composer.phar require kartik-v/yii2-widget-typeahead "*"

或添加

"kartik-v/yii2-widget-typeahead": "*"

到您的composer.json文件的require部分。

最新发布版本

有关各发布版本更改的详细信息，请参阅变更日志。

演示

您可以参考有关 TypeaheadBasic 或 Typeahead 的详细文档和示例，以了解扩展的使用方法。

使用方法

use kartik\typeahead\TypeaheadBasic;
use kartik\typeahead\Typeahead;

// TypeaheadBasic usage with ActiveForm and model
echo $form->field($model, 'state_3')->widget(TypeaheadBasic::classname(), [
    'data' => $data,
    'pluginOptions' => ['highlight' => true],
    'options' => ['placeholder' => 'Filter as you type ...'],
]);

// Typeahead usage with ActiveForm and model
echo $form->field($model, 'state_4')->widget(Typeahead::classname(), [
    'dataset' => [
        [
            'local' => $data,
            'limit' => 10
        ]
    ],
    'pluginOptions' => ['highlight' => true],
    'options' => ['placeholder' => 'Filter as you type ...'],
]);

许可证

yii2-widget-typeahead 在 BSD-3-Clause 许可证下发布。有关详细信息，请参阅附带的 LICENSE.md 文件。