• Drawer 抽屉
    • 基本用法
    • 不添加 Title
    • 自定义内容
    • 多层嵌套
    • Drawer Attributes
    • Drawer Slot
    • Drawer Methods
    • Drawer Events

    Drawer 抽屉

    有些时候, Dialog 组件并不满足我们的需求, 比如你的表单很长, 亦或是你需要临时展示一些文档, Drawer 拥有和 Dialog 几乎相同的 API, 在 UI 上带来不一样的体验.

    基本用法

    呼出一个临时的侧边栏, 可以从多个方向呼出

    Drawer 抽屉 - 图1

    需要设置 visible 属性,它的类型boolean,当为 true 时显示 Drawer。Drawer 分为两个部分:titlebodytitle 需要具名为 titleslot, 也可以通过 title 属性来定义,默认值为空。需要注意的是, Drawer 默认是从右往左打开, 当然可以设置对应的 direction, 详细请参考 direction 用法 最后,本例还展示了 before-close 的用法

    1. <el-radio-group v-model="direction">
    2. <el-radio label="ltr">从左往右开</el-radio>
    3. <el-radio label="rtl">从右往左开</el-radio>
    4. <el-radio label="ttb">从上往下开</el-radio>
    5. <el-radio label="btt">从下往上开</el-radio>
    6. </el-radio-group>
    7. <el-button @click="drawer = true" type="primary" style="margin-left: 16px;">
    8. 点我打开
    9. </el-button>
    10. <el-drawer
    11. title="我是标题"
    12. :visible.sync="drawer"
    13. :direction="direction"
    14. :before-close="handleClose">
    15. <span>我来啦!</span>
    16. </el-drawer>
    17. <script>
    18. export default {
    19. data() {
    20. return {
    21. drawer: false,
    22. direction: 'rtl',
    23. };
    24. },
    25. methods: {
    26. handleClose(done) {
    27. this.$confirm('确认关闭?')
    28. .then(_ => {
    29. done();
    30. })
    31. .catch(_ => {});
    32. }
    33. }
    34. };
    35. </script>

    不添加 Title

    当你不需要标题到时候, 你还可以去掉标题

    Drawer 抽屉 - 图2

    当遇到不需要 title 的场景时, 可以通过 withHeader 这个属性来关闭掉 title 的显示, 这样可以留出更大的空间给到用户, 为了用户的可访问性, 请务必设定 title 的值

    1. <el-button @click="drawer = true" type="primary" style="margin-left: 16px;">
    2. 点我打开
    3. </el-button>
    4. <el-drawer
    5. title="我是标题"
    6. :visible.sync="drawer"
    7. :with-header="false">
    8. <span>我来啦!</span>
    9. </el-drawer>
    10. <script>
    11. export default {
    12. data() {
    13. return {
    14. drawer: false,
    15. };
    16. }
    17. };
    18. </script>

    自定义内容

    Dialog 组件一样, Drawer 同样可以在其内部嵌套各种丰富的操作

    Drawer 抽屉 - 图3

    1. <el-button type="text" @click="table = true">打开嵌套表格的 Drawer</el-button>
    2. <el-button type="text" @click="dialog = true">打开嵌套 Form 的 Drawer</el-button>
    3. <el-drawer
    4. title="我嵌套了表格!"
    5. :visible.sync="table"
    6. direction="rtl"
    7. size="50%">
    8. <el-table :data="gridData">
    9. <el-table-column property="date" label="日期" width="150"></el-table-column>
    10. <el-table-column property="name" label="姓名" width="200"></el-table-column>
    11. <el-table-column property="address" label="地址"></el-table-column>
    12. </el-table>
    13. </el-drawer>
    14. <el-drawer
    15. title="我嵌套了 Form !"
    16. :before-close="handleClose"
    17. :visible.sync="dialog"
    18. direction="ltr"
    19. custom-class="demo-drawer"
    20. ref="drawer"
    21. >
    22. <div class="demo-drawer__content">
    23. <el-form :model="form">
    24. <el-form-item label="活动名称" :label-width="formLabelWidth">
    25. <el-input v-model="form.name" autocomplete="off"></el-input>
    26. </el-form-item>
    27. <el-form-item label="活动区域" :label-width="formLabelWidth">
    28. <el-select v-model="form.region" placeholder="请选择活动区域">
    29. <el-option label="区域一" value="shanghai"></el-option>
    30. <el-option label="区域二" value="beijing"></el-option>
    31. </el-select>
    32. </el-form-item>
    33. </el-form>
    34. <div class="demo-drawer__footer">
    35. <el-button @click="cancelForm">取 消</el-button>
    36. <el-button type="primary" @click="$refs.drawer.closeDrawer()" :loading="loading">{{ loading ? '提交中 ...' : '确 定' }}</el-button>
    37. </div>
    38. </div>
    39. </el-drawer>
    40. <script>
    41. export default {
    42. data() {
    43. return {
    44. table: false,
    45. dialog: false,
    46. loading: false,
    47. gridData: [{
    48. date: '2016-05-02',
    49. name: '王小虎',
    50. address: '上海市普陀区金沙江路 1518 弄'
    51. }, {
    52. date: '2016-05-04',
    53. name: '王小虎',
    54. address: '上海市普陀区金沙江路 1518 弄'
    55. }, {
    56. date: '2016-05-01',
    57. name: '王小虎',
    58. address: '上海市普陀区金沙江路 1518 弄'
    59. }, {
    60. date: '2016-05-03',
    61. name: '王小虎',
    62. address: '上海市普陀区金沙江路 1518 弄'
    63. }],
    64. form: {
    65. name: '',
    66. region: '',
    67. date1: '',
    68. date2: '',
    69. delivery: false,
    70. type: [],
    71. resource: '',
    72. desc: ''
    73. },
    74. formLabelWidth: '80px',
    75. timer: null,
    76. };
    77. },
    78. methods: {
    79. handleClose(done) {
    80. if (this.loading) {
    81. return;
    82. }
    83. this.$confirm('确定要提交表单吗?')
    84. .then(_ => {
    85. this.loading = true;
    86. this.timer = setTimeout(() => {
    87. done();
    88. // 动画关闭需要一定的时间
    89. setTimeout(() => {
    90. this.loading = false;
    91. }, 400);
    92. }, 2000);
    93. })
    94. .catch(_ => {});
    95. },
    96. cancelForm() {
    97. this.loading = false;
    98. this.dialog = false;
    99. clearTimeout(this.timer);
    100. }
    101. }
    102. }
    103. </script>

    多层嵌套

    Drawer 组件也拥有多层嵌套的方法

    Drawer 抽屉 - 图4

    同样, 如果你需要嵌套多层 Drawer 请一定要设置 append-to-body 属性为 true

    
    <el-button @click="drawer = true" type="primary" style="margin-left: 16px;">
      点我打开
    </el-button>
    
    <el-drawer
      title="我是外面的 Drawer"
      :visible.sync="drawer"
      size="50%">
      <div>
       <el-button @click="innerDrawer = true">打开里面的!</el-button>
       <el-drawer
         title="我是里面的"
         :append-to-body="true"
         :before-close="handleClose"
         :visible.sync="innerDrawer">
         <p>_(:зゝ∠)_</p>
       </el-drawer>
      </div>
    </el-drawer>
    
    <script>
      export default {
        data() {
          return {
            drawer: false,
            innerDrawer: false,
          };
        },
        methods: {
          handleClose(done) {
            this.$confirm('还有未保存的工作哦确定关闭吗?')
              .then(_ => {
                done();
              })
              .catch(_ => {});
          }
        }
      };
    </script>
    
    

    Drawer 的内容是懒渲染的,即在第一次被打开之前,传入的默认 slot 不会被渲染到 DOM 上。因此,如果需要执行 DOM 操作,或通过 ref 获取相应组件,请在 open 事件回调中进行。

    Drawer 提供一个 destroyOnClose API, 用来在关闭 Drawer 时销毁子组件内容, 例如清理表单内的状态, 在必要时可以将该属性设置为 true 用来保证初始状态的一致性

    如果 visible 属性绑定的变量位于 Vuex 的 store 内,那么 .sync 不会正常工作。此时需要去除 .sync 修饰符,同时监听 Drawer 的 openclose 事件,在事件回调中执行 Vuex 中对应的 mutation 更新 visible 属性绑定的变量的值。

    Drawer Attributes

    参数说明类型可选值默认值
    append-to-bodyDrawer 自身是否插入至 body 元素上。嵌套的 Drawer 必须指定该属性并赋值为 truebooleanfalse
    before-close关闭前的回调,会暂停 Drawer 的关闭function(done),done 用于关闭 Drawer
    close-on-press-escape是否可以通过按下 ESC 关闭 Drawerbooleantrue
    custom-classDrawer 的自定义类名string
    destroy-on-close控制是否在关闭 Drawer 之后将子元素全部销毁boolean-false
    modal是否需要遮罩层booleantrue
    modal-append-to-body遮罩层是否插入至 body 元素上,若为 false,则遮罩层会插入至 Drawer 的父元素上booleantrue
    directionDrawer 打开的方向Directionrtl / ltr / ttb / bttrtl
    show-close是否显示关闭按钮booleantrue
    sizeDrawer 窗体的大小, 当使用 number 类型时, 以像素为单位, 当使用 string 类型时, 请传入 'x%', 否则便会以 number 类型解释number / string-'30%'
    titleDrawer 的标题,也可通过具名 slot (见下表)传入string
    visible是否显示 Drawer,支持 .sync 修饰符booleanfalse
    wrapperClosable点击遮罩层是否可以关闭 Drawerboolean-true
    withHeader控制是否显示 header 栏, 默认为 true, 当此项为 false 时, title attribute 和 title slot 均不生效boolean-true

    Drawer Slot

    name说明
    Drawer 的内容
    titleDrawer 标题区的内容

    Drawer Methods

    name说明
    closeDrawer用于关闭 Drawer, 该方法会调用传入的 before-close 方法

    Drawer Events

    事件名称说明回调参数
    openDrawer 打开的回调
    openedDrawer 打开动画结束时的回调
    closeDrawer 关闭的回调
    closedDrawer 关闭动画结束时的回调