表单弹窗

数据表单弹窗

通过Form::dialog方法可以快速构建一个基于数据表单的表单弹窗,仅需增加数行代码。

{tip} 表单弹窗的实现原理是:通过createedit页面获取构建好的表单HTML字符,然后使用弹窗插件把这部分HTML字符渲染出来。 如果期间需要加载新的js脚本,则会等待脚本加载完毕再执行表单初始化js代码。

简单示例

开启表单弹窗

  1. <?php
  2. use App\Http\Controllers\Controller;
  3. use Dcat\Admin\Form;
  4. use Dcat\Admin\Layout\Content;
  5. class ModalFormController extends Controller
  6. {
  7. public function index(Content $content)
  8. {
  9. return $content
  10. ->header('Modal Form')
  11. ->body($this->build());
  12. }
  13. protected function build()
  14. {
  15. Form::dialog('新增角色')
  16. ->click('.create-form') // 绑定点击按钮
  17. ->url('auth/roles/create') // 表单页面链接,此参数会被按钮中的 “data-url” 属性替换。。
  18. ->width('700px') // 指定弹窗宽度,可填写百分比,默认 720px
  19. ->height('650px') // 指定弹窗高度,可填写百分比,默认 690px
  20. ->success('Dcat.reload()'); // 新增成功后刷新页面
  21. Form::dialog('编辑角色')
  22. ->click('.edit-form')
  23. ->success('Dcat.reload()'); // 编辑成功后刷新页面
  24. // 当需要在同个“class”的按钮中绑定不同的链接时,把链接放到按钮的“data-url”属性中即可
  25. $editPage = admin_base_path('auth/roles/1/edit');
  26. return "
  27. <div style='padding:30px 0'>
  28. <span class='btn btn-success create-form'> 新增表单弹窗 </span> &nbsp;&nbsp;
  29. <span class='btn btn-blue edit-form' data-url='{$editPage}'> 编辑表单弹窗 </span>
  30. </div>
  31. ";
  32. }
  33. }

表单构建以及保存数据

  1. <?php
  2. use App\Admin\Repositories\Role;
  3. use Dcat\Admin\Controllers\HasResourceActions;
  4. use Dcat\Admin\Form;
  5. use Dcat\Admin\Layout\Content;
  6. use Dcat\Admin\Admin;
  7. class RoleController
  8. {
  9. use HasResourceActions;
  10. /**
  11. * Edit interface.
  12. *
  13. * @param mixed $id
  14. * @param Content $content
  15. *
  16. * @return Content
  17. */
  18. public function edit($id, Content $content)
  19. {
  20. return $content
  21. ->header(trans('admin.roles'))
  22. ->description(trans('admin.edit'))
  23. ->body($this->form()->edit($id));
  24. }
  25. /**
  26. * Create interface.
  27. *
  28. * @param Content $content
  29. *
  30. * @return Content
  31. */
  32. public function create(Content $content)
  33. {
  34. return $content
  35. ->header(trans('admin.roles'))
  36. ->description(trans('admin.create'))
  37. ->body($this->form());
  38. }
  39. /**
  40. * Make a form builder.
  41. *
  42. * @return Form
  43. */
  44. protected function form()
  45. {
  46. return Form::make(new Role(), function (Form $form) {
  47. $form->display('id', 'ID');
  48. $form->text('slug', trans('admin.slug'))->required()->prepareForSave(function ($value) {
  49. return $value;
  50. });
  51. $form->text('name', trans('admin.name'))->required();
  52. $form->tree('permissions')
  53. ->nodes(function () {
  54. $permissionModel = config('admin.database.permissions_model');
  55. $permissionModel = new $permissionModel;
  56. return $permissionModel->allNodes();
  57. })
  58. ->customFormat(function ($v) {
  59. if (!$v) return [];
  60. return array_column($v, 'id');
  61. });
  62. $form->display('created_at', trans('admin.created_at'));
  63. $form->display('updated_at', trans('admin.updated_at'));
  64. });
  65. }
  66. }

效果

表单弹窗 - 图1

功能接口

表单弹窗必须绑定一个可点击的页面元素,通过点击这个元素弹出弹窗。

设置弹窗标题

  1. $modal = Form::dialog('标题');

绑定点击按钮

通过ModalForm::click方法可以绑定点击按钮,绑定后当点击该按钮时会弹出弹窗

  1. Form::dialog('标题')
  2. ->click('#click-button');

设置URL

如果是创建类型的表单,则可以通过以下方法设置获取表单模板的url

  1. Form::dialog('新增角色')
  2. ->click('.create-form')
  3. ->url('auth/roles/create');

如果是编辑类型的表单,则需要多个url,因为点击每个按钮弹出弹窗的表单内容是不同的,所以每个按钮的链接也不同。

这个时候通过ModalForm::url方法设置的一个链接已经无法满足需求了,因而需要在点击按钮的data-url属性上保存url:

  1. Form::dialog('编辑角色')
  2. ->click('.edit-form')
  3. ->success('Dcat.reload()'); // 编辑成功后刷新页面
  4. // 当需要在同个“class”的按钮中绑定不同的链接时,把链接放到按钮的“data-url”属性中即可
  5. $editPage1 = admin_base_path('auth/roles/1/edit');
  6. $editPage2 = admin_base_path('auth/roles/2/edit');
  7. return "
  8. <div style='padding:30px 0'>
  9. <span class='btn btn-blue edit-form' data-url='{$editPage1}'> 编辑表单弹窗1 </span>
  10. <span class='btn btn-blue edit-form' data-url='{$editPage2}'> 编辑表单弹窗2 </span>
  11. </div>
  12. ";

表单保存成功回调

通过success方法可以设置表单保存成功之后执行的js代码,在这段js代码作用域内有一个response变量,通过这个变量可以获取服务端返回的json数据。

  1. Form::dialog('编辑角色')
  2. ->click('.edit-form')
  3. ->success(
  4. <<<JS
  5. // 打印服务端响应数据
  6. console.log(response);
  7. // 提示成功信息
  8. Dcat.success(response.message || '保存成功');
  9. // 保存成功之后刷新页面
  10. Dcat.reload();
  11. JS
  12. );

表单保存失败回调

通过error方法可以设置表单保存失败之后执行的js代码,在这段js代码作用域内有一个response变量,通过这个变量可以获取服务端返回的json数据。

  1. Form::dialog('编辑角色')
  2. ->click('.edit-form')
  3. ->error(
  4. <<<JS
  5. // 打印服务端响应数据
  6. console.log(response);
  7. JS
  8. );

表单保存之后回调

通过saved方法可以设置表单保存之后执行的js代码,在这段js代码作用域内有两个js变量:

  • success 值为真表示保存成功,否则失败
  • response 服务端返回的json数据
  1. Form::dialog('编辑角色')
  2. ->click('.edit-form')
  3. ->saved(
  4. <<<JS
  5. // 打印服务端响应数据
  6. console.log(response);
  7. if (success) {
  8. console.log('保存成功');
  9. } else {
  10. console.log('保存失败');
  11. }
  12. JS
  13. );

强制刷新

每次点击按钮都重新从服务端拉取新的模板数据

  1. Form::dialog('编辑角色')
  2. ->click('.edit-form')
  3. ->forceRefresh();

设置弹窗宽高

  1. Form::dialog('编辑角色')
  2. ->click('.edit-form')
  3. ->dimensions('50%', '400px');
  4. // 或
  5. Form::dialog('编辑角色')
  6. ->click('.edit-form')
  7. ->width('50%')
  8. ->height('400px');

工具表单弹窗

数据表单的弹窗功能通常需要结合一个资源控制器去实现,相对会比较复杂一点,所以系统也内置了另外一种更简便的表单弹窗功能,使用方法请参考工具表单-弹窗

表单弹窗 - 图2