简介
头部按钮行为用于在表格头部添加全局操作按钮,实现批量操作、新增数据等功能。
用法示例
基础用法
use plugin\xbCode\builder\Builder;
// 创建表格
Builder::crud(function($builder) {
// 添加新增按钮(弹窗)
$builder->addHeaderDialog('新增', '/api/add');
// 添加导出按钮
$builder->addHeaderDownload('导出数据', '/api/export');
});
完整示例
Builder::crud(function($builder) {
// 弹窗按钮
$builder->addHeaderDialog('新增数据', 'GET:/api/add', function($dialog) {
$dialog->title('添加新数据');
$dialog->size('lg');
$dialog->closeOnEsc(true);
});
// 抽屉按钮
$builder->addHeaderDrawer('批量导入', 'GET:/api/import', function($drawer) {
$drawer->title('批量导入数据');
$drawer->position('right');
});
// 确认框按钮
$builder->addHeaderConfirm('清空数据', '/api/clear', '确认清空所有数据吗?', '清空确认');
// 链接按钮
$builder->addHeaderLink('帮助文档', '/docs');
// URL按钮
$builder->addHeaderUrl('前往官网', 'https://example.com', true);
// 下载按钮
$builder->addHeaderDownload('下载模板', '/api/template');
});
按钮样式和图标
Builder::crud(function($builder) {
// 自定义样式的按钮
$builder->addHeaderDialog('新增', '/api/add', function($dialog) {
$dialog->title('新增数据');
})->level('primary')->icon('fa fa-plus');
// 成功样式按钮
$builder->addHeaderDownload('导出', '/api/export')
->level('success')
->icon('fa fa-download');
// 警告样式按钮
$builder->addHeaderConfirm('清空', '/api/clear')
->level('warning')
->icon('fa fa-trash');
});
可用方法
| 方法名 | 参数 | 返回值 | 说明 |
|---|
| addHeaderDialog | title, url, option | DialogAction | 添加弹窗按钮 |
| addHeaderDrawer | title, url, option | DrawerAction | 添加抽屉按钮 |
| addHeaderConfirm | title, url, content, cTitle | AjaxAction | 添加确认框按钮 |
| addHeaderDownload | title, url | DownloadAction | 添加下载按钮 |
| addHeaderLink | title, url | LinkAction | 添加链接按钮 |
| addHeaderUrl | title, url, target | UrlAction | 添加URL按钮 |
方法参数说明
addHeaderDialog
| 参数名 | 类型 | 默认值 | 说明 |
|---|
| title | string | 必填 | 按钮文本 |
| url | string | 必填 | 请求地址(支持 METHOD:URL 格式) |
| option | callable|array | [] | 弹窗配置 |
addHeaderConfirm
| 参数名 | 类型 | 默认值 | 说明 |
|---|
| title | string | 必填 | 按钮文本 |
| url | string | 必填 | 请求地址 |
| content | string | '是否确认操作该数据?' | 确认框内容 |
| cTitle | string | '温馨提示' | 确认框标题 |
addHeaderDownload
| 参数名 | 类型 | 默认值 | 说明 |
|---|
| title | string | 必填 | 按钮文本 |
| url | string | 必填 | 下载地址 |
addHeaderUrl
| 参数名 | 类型 | 默认值 | 说明 |
|---|
| title | string | 必填 | 按钮文本 |
| url | string | 必填 | 跳转地址 |
| target | bool | true | 是否新窗口打开 |
按钮样式
可以通过 level() 方法设置按钮样式:
| 样式值 | 说明 | 视觉效果 |
|---|
| primary | 主要按钮 | 蓝色 |
| success | 成功按钮 | 绿色 |
| warning | 警告按钮 | 黄色 |
| danger | 危险按钮 | 红色 |
| info | 信息按钮 | 浅蓝色 |
| default | 默认按钮 | 灰色 |
| link | 链接样式 | 文本链接 |
按钮图标
可以通过 icon() 方法设置按钮图标:
->icon('fa fa-plus') // FontAwesome 图标
->icon('fa fa-download') // 下载图标
->icon('fa fa-trash') // 删除图标
使用场景
- 新增数据
- 批量导入
- 数据导出
- 清空数据
- 刷新数据
- 帮助文档链接
注意事项
- 头部按钮显示在表格头部左侧
- 默认按钮样式可以通过 level() 方法修改
- 支持 METHOD:URL 格式指定请求方法
- 按钮会自动获取表格的筛选条件
- 建议为重要操作添加图标提升识别度
- 危险操作建议使用确认框按钮