docs(components): [container] (#10680)

* docs(components): [container]

* docs(components): [container]

* docs(components): [container]
This commit is contained in:
Xc
2022-11-21 21:37:14 +08:00
committed by GitHub
parent 1d20619c50
commit cb66a20612
5 changed files with 58 additions and 36 deletions

View File

@@ -79,56 +79,66 @@ container/example
:::
## Container Attributes
## Container API
| Name | 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 Attributes
## Container Slots
| Name | Description | Type | Default |
| --------- | ----------------------------------- | ------------------------------------- | -------------------------------------------------------------------------- |
| direction | layout direction for child elements | ^[string]`'horizontal' \| 'vertical'` | vertical when nested with `el-header` or `el-footer`; horizontal otherwise |
| Name | Description | Subtags |
| ---- | ------------------------- | ------------------------------------------ |
| — | customize default content | Container / Header / Aside / Main / Footer |
### Container Slots
## Header Attributes
| Name | Description | Subtags |
| ------- | ------------------------- | ------------------------------------------ |
| default | customize default content | Container / Header / Aside / Main / Footer |
| Name | Description | Type | Accepted Values | Default |
| ------ | -------------------- | ------ | --------------- | ------- |
| height | height of the header | string | — | 60px |
## Header API
## Header Slots
### Header Attributes
| Name | Description |
| ---- | ------------------------- |
| — | customize default content |
| Name | Description | Type | Default |
| ------ | -------------------- | --------- | ------- |
| height | height of the header | ^[string] | 60px |
## Aside Attributes
### Header Slots
| Name | Description | Type | Accepted Values | Default |
| ----- | ------------------------- | ------ | --------------- | ------- |
| width | width of the side section | string | — | 300px |
| Name | Description |
| ------- | ------------------------- |
| default | customize default content |
## Aside Slots
## Aside API
| Name | Description |
| ---- | ------------------------- |
| — | customize default content |
### Aside Attributes
## Main Slots
| Name | Description | Type | Default |
| ----- | ------------------------- | --------- | ------- |
| width | width of the side section | ^[string] | 300px |
| Name | Description |
| ---- | ------------------------- |
| — | customize default content |
### Aside Slots
## Footer Attributes
| Name | Description |
| ------- | ------------------------- |
| default | customize default content |
| Name | Description | Type | Accepted Values | Default |
| ------ | -------------------- | ------ | --------------- | ------- |
| height | height of the footer | string | — | 60px |
## Main API
## Footer Slots
### Main Slots
| Name | Description |
| ---- | ------------------------- |
| — | customize default content |
| Name | Description |
| ------- | ------------------------- |
| default | customize default content |
## Footer API
### Footer Attributes
| Name | Description | Type | Default |
| ------ | -------------------- | --------- | ------- |
| height | height of the footer | ^[string] | 60px |
### Footer Slots
| Name | Description |
| ------- | ------------------------- |
| default | customize default content |

View File

@@ -13,6 +13,9 @@ defineOptions({
name: 'ElAside',
})
const props = defineProps({
/**
* @description width of the side section
*/
width: {
type: String,
default: null,

View File

@@ -13,6 +13,9 @@ defineOptions({
name: 'ElContainer',
})
const props = defineProps({
/**
* @description layout direction for child elements
*/
direction: {
type: String,
},

View File

@@ -13,6 +13,9 @@ defineOptions({
name: 'ElFooter',
})
const props = defineProps({
/**
* @description height of the footer
*/
height: {
type: String,
default: null,

View File

@@ -14,6 +14,9 @@ defineOptions({
})
const props = defineProps({
/**
* @description height of the header
*/
height: {
type: String,
default: null,