提示词组件

简介

提示词组件用于在表格顶部显示提示信息,用于展示重要说明或操作提示。

用法示例

基础用法

use plugin\xbCode\builder\Builder;

// 创建表格
Builder::crud(function($builder) {
  // 添加提示词
  $builder->addHeaderPrompt('这是一条重要提示信息');
});

自定义配置

Builder::crud(function($builder) {
  // 使用回调函数自定义提示词
  $builder->addHeaderPrompt('请注意:数据每天凌晨自动更新', function($component) {
    $component->type('info'); // 提示类型
    $component->closable(true); // 可关闭
    $component->showIcon(true); // 显示图标
  });
  
  // 警告提示
  $builder->addHeaderPrompt('警告:此操作不可撤销!', function($component) {
    $component->type('warning');
  });
  
  // 成功提示
  $builder->addHeaderPrompt('操作成功提示', function($component) {
    $component->type('success');
  });
});

组件参数

参数名类型默认值说明
contentstring必填提示内容

提示词组件属性

属性名类型默认值说明
typestringprimary提示类型:'primary'、'info'、'success'、'warning'、'danger'
closableboolfalse是否可关闭(默认不可关闭)
contentstring-提示内容
showIconbool-是否显示图标
iconstring-自定义图标
classNamestring-CSS 类名

提示类型说明

类型说明适用场景
primary主要提示(蓝色)一般信息提示
info信息提示(浅蓝色)辅助说明信息
success成功提示(绿色)成功状态提示
warning警告提示(黄色)警告性信息
danger危险提示(红色)重要警告或错误提示

使用场景

  • 操作说明提示
  • 功能使用说明
  • 数据更新提示
  • 注意事项说明
  • 临时公告通知

注意事项

  1. 提示词显示在表格顶部
  2. 默认不可关闭,需要手动设置 closable(true)
  3. 支持HTML格式内容
  4. 可以添加多个提示词,按添加顺序显示
  5. 建议提示内容简洁明了