Files
mes-ui-d2/docs/zh/components/container.md

123 lines
2.5 KiB
Markdown
Raw Normal View History

# 页面容器
页面容器组件是每个页面的基础,为了在整个项目中统一效果,它应该是 `<template>` 组件的直接子组件
## 参数
| 参数名 | 介绍 | 必选 | 值类型 | 可选值 | 默认值 |
| --- | --- | --- | --- | --- | --- |
| type | 容器类型 | 非 | String | card ghost full | full |
| scroll | 滚动优化 | 非 | Boolean | | false |
## 使用方法
一个基础单文件页面组件的示例
``` vue
<template>
<d2-container>
<template slot="header">
可选的 header 内容 ...
</template>
主体内容 ...
</d2-container>
</template>
<script>
export default {
name: 'your-component-name'
}
</script>
<style lang="scss">
// 需要的话引入
@import '~@/assets/style/public.scss';
</style>
```
### 自适应填充页面容器
无论内容高度多少,都会自动撑满页面,并有可选的 `header``footer` 插槽
示例:
``` vue
<template>
<d2-container type="full">
<template slot="header">
可选的 header 内容 ...
</template>
主体内容 ...
<template slot="footer">
可选的 footer 内容 ...
</template>
</d2-container>
</template>
```
`v1.1.4` 新增
你可以通过设置 `scroll` 来启用自定义滚动条,看起来更美观一些
> 有些情况下使用滚动优化模式会有意外影响,例如页面内含有可拖拽的元素,这时候最好不要使用此模式
示例:
``` vue
<template>
<d2-container type="full" scroll>
<template slot="header">
可选的 header 内容 ...
</template>
主体内容 ...
<template slot="footer">
可选的 footer 内容 ...
</template>
</d2-container>
</template>
```
### 卡片型页面容器
高度根据内容适应
``` vue
<d2-container type="card">
主体内容
</d2-container>
```
使用 `slot`
> 卡片型容器只有 header 插槽
``` vue
<d2-container type="card">
<template slot="header">我是插入到 header 中的内容</template>
主体内容
</d2-container>
```
### 隐形页面容器
不显示任何背景色和边框,通常这个模式只有在极少情况下会使用
``` vue
<d2-container type="ghost">
主体内容
</d2-container>
```
使用 `slot`
> 隐形页面容器只有 header 插槽
``` vue
<d2-container type="ghost">
<template slot="header">我是插入到 header 中的内容</template>
主体内容
</d2-container>
```
如果你不希望内容紧贴上边,可以在内容外层容器设置 `class="d2-mt"`