头部按钮

简介

头部按钮行为用于在表格头部添加全局操作按钮,实现批量操作、新增数据等功能。

用法示例

基础用法

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');
});

可用方法

方法名参数返回值说明
addHeaderDialogtitle, url, optionDialogAction添加弹窗按钮
addHeaderDrawertitle, url, optionDrawerAction添加抽屉按钮
addHeaderConfirmtitle, url, content, cTitleAjaxAction添加确认框按钮
addHeaderDownloadtitle, urlDownloadAction添加下载按钮
addHeaderLinktitle, urlLinkAction添加链接按钮
addHeaderUrltitle, url, targetUrlAction添加URL按钮

方法参数说明

addHeaderDialog

参数名类型默认值说明
titlestring必填按钮文本
urlstring必填请求地址(支持 METHOD:URL 格式)
optioncallable|array[]弹窗配置

addHeaderConfirm

参数名类型默认值说明
titlestring必填按钮文本
urlstring必填请求地址
contentstring'是否确认操作该数据?'确认框内容
cTitlestring'温馨提示'确认框标题

addHeaderDownload

参数名类型默认值说明
titlestring必填按钮文本
urlstring必填下载地址

addHeaderUrl

参数名类型默认值说明
titlestring必填按钮文本
urlstring必填跳转地址
targetbooltrue是否新窗口打开

按钮样式

可以通过 level() 方法设置按钮样式:

样式值说明视觉效果
primary主要按钮蓝色
success成功按钮绿色
warning警告按钮黄色
danger危险按钮红色
info信息按钮浅蓝色
default默认按钮灰色
link链接样式文本链接

按钮图标

可以通过 icon() 方法设置按钮图标:

->icon('fa fa-plus')     // FontAwesome 图标
->icon('fa fa-download') // 下载图标
->icon('fa fa-trash')    // 删除图标

使用场景

  • 新增数据
  • 批量导入
  • 数据导出
  • 清空数据
  • 刷新数据
  • 帮助文档链接

注意事项

  1. 头部按钮显示在表格头部左侧
  2. 默认按钮样式可以通过 level() 方法修改
  3. 支持 METHOD:URL 格式指定请求方法
  4. 按钮会自动获取表格的筛选条件
  5. 建议为重要操作添加图标提升识别度
  6. 危险操作建议使用确认框按钮