简介
侧边栏组件用于在表格左侧显示分类导航菜单,实现数据分类筛选功能。
用法示例
基础用法
use plugin\xbCode\builder\Builder;
// 创建表格
Builder::crud(function($builder) {
// 使用侧边栏(指定URL参数名)
$builder->useSidebar('category');
// 添加侧边栏项
$builder->addSidebar('全部', '');
$builder->addSidebar('分类A', 'a');
$builder->addSidebar('分类B', 'b');
$builder->addSidebar('分类C', 'c');
});
带图标的侧边栏
Builder::crud(function($builder) {
$builder->useSidebar('type');
// 添加带图标的侧边栏项
$builder->addSidebar('全部', '', 'fa fa-list');
$builder->addSidebar('文档', 'doc', 'fa fa-file-text');
$builder->addSidebar('图片', 'image', 'fa fa-image');
$builder->addSidebar('视频', 'video', 'fa fa-video-camera');
});
批量添加侧边栏
Builder::crud(function($builder) {
$builder->useSidebar('status');
// 批量添加
$builder->addSidebars([
['label' => '全部', 'value' => '', 'icon' => 'fa fa-list'],
['label' => '待审核', 'value' => 'pending', 'icon' => 'fa fa-clock-o'],
['label' => '已通过', 'value' => 'approved', 'icon' => 'fa fa-check'],
['label' => '已拒绝', 'value' => 'rejected', 'icon' => 'fa fa-times']
]);
});
自定义侧边栏
Builder::crud(function($builder) {
// 使用侧边栏组件实例进行高级配置
$sidebar = $builder->useSidebar('nav');
$sidebar->stacked(true); // 堆叠显示
$builder->addSidebar('所有项目', '');
$builder->addSidebar('进行中', 'active', 'fa fa-spinner');
$builder->addSidebar('已完成', 'completed', 'fa fa-check-circle');
$builder->addSidebar('已归档', 'archived', 'fa fa-archive');
});
可用方法
| 方法名 | 参数 | 返回值 | 说明 |
|---|
| useSidebar | active | Nav | 启用侧边栏并指定URL参数名 |
| addSidebar | label, value, icon, props | this | 添加单个侧边栏项 |
| addSidebars | sidebars | this | 批量添加侧边栏项 |
方法参数说明
useSidebar
| 参数名 | 类型 | 默认值 | 说明 |
|---|
| active | string | '_nav' | URL参数名,用于标识选中的菜单项 |
addSidebar
| 参数名 | 类型 | 默认值 | 说明 |
|---|
| label | string | 必填 | 菜单项显示文本 |
| value | mixed | 必填 | 菜单项的值 |
| icon | string | '' | 图标类名 |
| props | array | [] | 其他属性 |
addSidebars
| 参数名 | 类型 | 默认值 | 说明 |
|---|
| sidebars | array | 必填 | 侧边栏项数组,每项包含 label、value、icon 等字段 |
侧边栏项配置
| 字段名 | 类型 | 必填 | 说明 |
|---|
| label | string | 是 | 显示文本 |
| value | mixed | 是 | 值(将作为URL参数) |
| icon | string | 否 | 图标类名 |
| active | bool | 否 | 是否选中(自动计算) |
使用场景
注意事项
- 侧边栏显示在表格左侧
- 点击侧边栏项会自动更新URL参数并刷新数据
- 当前选中项会自动高亮显示
- 如果未设置图标,默认使用 'fa-regular fa-folder-open'
- URL参数会保留其他筛选条件
- 侧边栏值为空字符串表示"全部"或不筛选