element-plus/docs/en-US/component/container.md

140 lines
3.6 KiB
Markdown

# Container
Container components for scaffolding basic structure of the page:
`<el-container>`: wrapper container. When nested with a `<el-header>` or `<el-footer>`, all its child elements will be vertically arranged. Otherwise horizontally.
`<el-header>`: container for headers.
`<el-aside>`: container for side sections (usually a side nav).
`<el-main>`: container for main sections.
`<el-footer>`: container for footers.
:::tip
These components use flex for layout, so please make sure your browser supports it. Besides, `<el-container>`'s direct child elements have to be one or more of the latter four components. And father element of the latter four components must be a `<el-container>`.
:::
## Common layouts
:::demo
container/basic
:::
## Example
:::demo
container/example
:::
## Container Attributes
| Attribute | Description | Type | Accepted Values | Default |
| --------- | ----------------------------------- | ------ | --------------------- | -------------------------------------------------------------------------- |
| direction | layout direction for child elements | string | horizontal / vertical | vertical when nested with `el-header` or `el-footer`; horizontal otherwise |
## Container Slots
| Name | Description | Subtags |
| ---- | ------------------------- | ------------------------------------------ |
| — | customize default content | Container / Header / Aside / Main / Footer |
## Header Attributes
| Attribute | Description | Type | Accepted Values | Default |
| --------- | -------------------- | ------ | --------------- | ------- |
| height | height of the header | string | — | 60px |
## Header Slots
| Name | Description |
| ---- | ------------------------- |
| — | customize default content |
## Aside Attributes
| Attribute | Description | Type | Accepted Values | Default |
| --------- | ------------------------- | ------ | --------------- | ------- |
| width | width of the side section | string | — | 300px |
## Aside Slots
| Name | Description |
| ---- | ------------------------- |
| — | customize default content |
## Main Slots
| Name | Description |
| ---- | ------------------------- |
| — | customize default content |
## Footer Attributes
| Attribute | Description | Type | Accepted Values | Default |
| --------- | -------------------- | ------ | --------------- | ------- |
| height | height of the footer | string | — | 60px |
## Footer Slots
| Name | Description |
| ---- | ------------------------- |
| — | customize default content |
<style lang="scss">
.example-showcase {
.el-header,
.el-footer {
background-color: #b3c0d1;
color: var(--el-text-color-primary);
line-height: 60px;
}
.el-aside {
color: var(--el-text-color-primary);
}
.common-layout {
.el-header,
.el-footer {
text-align: center;
}
.el-aside {
background-color: #d3dce6;
text-align: center;
line-height: 200px;
}
.el-main {
background-color: #e9eef3;
color: var(--el-text-color-primary);
text-align: center;
line-height: 160px;
}
.el-container {
margin-bottom: 40px;
&:last-child {
margin-bottom: 0;
}
&:nth-child(5) .el-aside,
&:nth-child(6) .el-aside {
line-height: 260px;
}
&:nth-child(7) .el-aside {
line-height: 320px;
}
}
}
}
</style>