README

yii2-checkbox-x      

基于Krajee的bootstrap-checkbox-x jQuery插件，为Yii Framework 2扩展的复选框小部件。该小部件允许三个复选框状态，并包含额外的样式。插件默认使用Bootstrap标记、符号和CSS 3样式，但可以使用任何其他标记覆盖。

注意：复选框插件将值存储为整数格式（而不是布尔格式）以表示选中状态和未选中状态。

特性

• 插件提供了以下三个状态和值供复选框使用（注意整数值）
  • 1：复选框被选中。
  • 0：复选框未被选中。
  • null：复选框处于不确定状态。
• 您可以设置插件允许复选框的三个状态或默认的两个状态。
• 特别使用Bootstrap样式和符号（支持3.x、4.x、5.x）。可以配置复选框的选中、未选中和不定图标。
• 特殊的CSS 3样式，增强控件看起来像任何Bootstrap表单控件。支持has-error、has-success、has-warning等样式状态，如其他Bootstrap表单控件。
• 插件CSS样式默认将复选框设置为内联显示。您也可以控制类似于复选框列表的块显示标记。
• 您可以在标签前或后添加一个带有for属性的label，并单击标签以更改复选框的值。或者，您也可以在label标签中包围输入。
• 可以通过键盘导航到复选框控件，并使用键盘上的空格键修改值。
• 可以调整复选框控件的大小。有五个预构建的大小模板可供选择：xl、lg、md、sm、和xs。
• 触发JQuery事件以进行高级开发。当通过点击更改复选框值时，插件会自动触发输入的change事件。目前可用的事件是change和reset。
• 可以通过javascript在运行时访问方法和动态刷新输入。
• 支持禁用和只读复选框输入。
• 当压缩和gzip时，整个插件（JS和CSS）的大小小于2KB。未压缩时，其大小约为6KB（JS约为3KB，CSS约为3KB）。

文档和演示

您可以在详细文档和演示以及API代码文档中找到有关扩展使用的详细信息。

版本变更

请参阅变更日志以了解不同版本的详细变更。

安装

安装此扩展的首选方法是使用composer。

注意：请检查此扩展的依赖和要求，查看 composer.json 文件。阅读有关设置应用程序 composer.json 中 minimum-stability 设置的此 web tip /wiki。

运行以下命令之一

$ php composer.phar require kartik-v/yii2-checkbox-x "@dev"

或将其添加到

"kartik-v/yii2-checkbox-x": "@dev"

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

用法

CheckboxX

use kartik\checkbox\CheckboxX;
echo CheckboxX::widget([
    'model' => $model,
    'attribute' => 'status',
    'pluginOptions' => [
        'threeState' => true,
        'size' => 'lg'
    ]
]); 

许可证

yii2-checkbox-x 采用 BSD-3-Clause 许可证发布。有关详细信息，请参阅捆绑的 LICENSE.md 文件。