mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-30 06:09:34 +08:00
882cec62d6
* docs: Add components overview page * fix detail * remove ContributorsList form overview page * fix components url * improve code style * remove extra file * fix detail * fix lint * fix lint * docs: Finish components overview page * fix lint * docs: Update cover * fix lint * update cover * update menu * improve overview page * refactor code * fix order * update title * add components count * fix overview page ssr bug * move less file * update title margin Co-authored-by: arvinxx <arvinx@foxmail.com>
128 lines
4.3 KiB
Markdown
128 lines
4.3 KiB
Markdown
---
|
||
category: Components
|
||
subtitle: 布局
|
||
type: 布局
|
||
cols: 1
|
||
title: Layout
|
||
cover: https://gw.alipayobjects.com/zos/alicdn/hzEndUVEx/Layout.svg
|
||
---
|
||
|
||
协助进行页面级整体布局。
|
||
|
||
## 设计规则
|
||
|
||
### 尺寸
|
||
|
||
一级导航项偏左靠近 logo 放置，辅助菜单偏右放置。
|
||
|
||
- 顶部导航（大部分系统）：一级导航高度 `64px`，二级导航 `48px`。
|
||
- 顶部导航（展示类页面）：一级导航高度 `80px`，二级导航 `56px`。
|
||
- 顶部导航高度的范围计算公式为：`48+8n`。
|
||
- 侧边导航宽度的范围计算公式：`200+8n`。
|
||
|
||
### 交互
|
||
|
||
- 一级导航和末级的导航需要在可视化的层面被强调出来；
|
||
- 当前项应该在呈现上优先级最高；
|
||
- 当导航收起的时候，当前项的样式自动赋予给它的上一个层级；
|
||
- 左侧导航栏的收放交互同时支持手风琴和全展开的样式，根据业务的要求进行适当的选择。
|
||
|
||
### 视觉
|
||
|
||
导航样式上需要根据信息层级合理的选择样式：
|
||
|
||
- **大色块强调**
|
||
|
||
建议用于底色为深色系时，当前页面父级的导航项。
|
||
|
||
- **高亮火柴棍**
|
||
|
||
当导航栏底色为浅色系时使用，可用于当前页面对应导航项，建议尽量在导航路径的最终项使用。
|
||
|
||
- **字体高亮变色**
|
||
|
||
从可视化层面，字体高亮的视觉强化力度低于大色块，通常在当前项的上一级使用。
|
||
|
||
- **字体放大**
|
||
|
||
`12px`、`14px` 是导航的标准字号，14 号字体用在一、二级导航中。字号可以考虑导航项的等级做相应选择。
|
||
|
||
## 组件概述
|
||
|
||
- `Layout`：布局容器，其下可嵌套 `Header` `Sider` `Content` `Footer` 或 `Layout` 本身，可以放在任何父容器中。
|
||
- `Header`：顶部布局，自带默认样式，其下可嵌套任何元素，只能放在 `Layout` 中。
|
||
- `Sider`：侧边栏，自带默认样式及基本功能，其下可嵌套任何元素，只能放在 `Layout` 中。
|
||
- `Content`：内容部分，自带默认样式，其下可嵌套任何元素，只能放在 `Layout` 中。
|
||
- `Footer`：底部布局，自带默认样式，其下可嵌套任何元素，只能放在 `Layout` 中。
|
||
|
||
> 注意：采用 flex 布局实现，请注意[浏览器兼容性](http://caniuse.com/#search=flex)问题。
|
||
|
||
## API
|
||
|
||
```jsx
|
||
<Layout>
|
||
<Header>header</Header>
|
||
<Layout>
|
||
<Sider>left sidebar</Sider>
|
||
<Content>main content</Content>
|
||
<Sider>right sidebar</Sider>
|
||
</Layout>
|
||
<Footer>footer</Footer>
|
||
</Layout>
|
||
```
|
||
|
||
### Layout
|
||
|
||
布局容器。
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 |
|
||
| --- | --- | --- | --- |
|
||
| className | 容器 className | string | - |
|
||
| hasSider | 表示子元素里有 Sider，一般不用指定。可用于服务端渲染时避免样式闪动 | boolean | - |
|
||
| style | 指定样式 | CSSProperties | - |
|
||
|
||
> `Layout.Header` `Layout.Footer` `Layout.Content` API 与 `Layout` 相同
|
||
|
||
### Layout.Sider
|
||
|
||
侧边栏。
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 |
|
||
| --- | --- | --- | --- |
|
||
| breakpoint | 触发响应式布局的[断点](/components/grid-cn/#Col) | `xs` \| `sm` \| `md` \| `lg` \| `xl` \| `xxl` | - |
|
||
| className | 容器 className | string | - |
|
||
| collapsed | 当前收起状态 | boolean | - |
|
||
| collapsedWidth | 收缩宽度，设置为 0 会出现特殊 trigger | number | 80 |
|
||
| collapsible | 是否可收起 | boolean | false |
|
||
| defaultCollapsed | 是否默认收起 | boolean | false |
|
||
| reverseArrow | 翻转折叠提示箭头的方向，当 Sider 在右边时可以使用 | boolean | false |
|
||
| style | 指定样式 | CSSProperties | - |
|
||
| theme | 主题颜色 | `light` \| `dark` | `dark` |
|
||
| trigger | 自定义 trigger，设置为 null 时隐藏 trigger | string\|ReactNode | - |
|
||
| width | 宽度 | number\|string | 200 |
|
||
| onCollapse | 展开-收起时的回调函数，有点击 trigger 以及响应式反馈两种方式可以触发 | (collapsed, type) => {} | - |
|
||
| onBreakpoint | 触发响应式布局[断点](/components/grid#API)时的回调 | (broken) => {} | - |
|
||
| zeroWidthTriggerStyle | 指定当 `collapsedWidth` 为 0 时出现的特殊 trigger 的样式 | object | - |
|
||
|
||
#### breakpoint width
|
||
|
||
```js
|
||
{
|
||
xs: '480px',
|
||
sm: '576px',
|
||
md: '768px',
|
||
lg: '992px',
|
||
xl: '1200px',
|
||
xxl: '1600px',
|
||
}
|
||
```
|
||
|
||
<style>
|
||
[data-theme="dark"] .site-layout-background {
|
||
background: #141414;
|
||
}
|
||
[data-theme="dark"] .site-layout-header-background {
|
||
background: #1f1f1f;
|
||
}
|
||
</style>
|