ant-design/components/layout/index.zh-CN.md
ddcat1115 29fa65fcc9 Layout.Sider support responsive display (#4931)
* save

* Layout.Sider support responsive display

* improve

* fix wrong spelling
2017-03-05 21:10:34 +08:00

2.5 KiB
Raw Blame History

category subtitle type cols title
Components 布局 Layout 1 Layout

可协助进行页面级整体布局。

概述

  • Layout:布局容器,其下可嵌套 Header Sider Content FooterLayout 本身,可以放在任何父容器中。
  • Header:顶部布局,自带默认样式,其下可嵌套任何元素,只能放在 Layout 中。
  • Sider:侧边栏,自带默认样式及基本功能,其下可嵌套任何元素,只能放在 Layout 中。
  • Content:内容部分,自带默认样式,其下可嵌套任何元素,只能放在 Layout 中。
  • Footer:底部布局,自带默认样式,其下可嵌套任何元素,只能放在 Layout 中。

注意:采用 flex 布局实现,请注意浏览器兼容性问题。

API

<Layout>
  <Header>header</Header>
  <Layout>
    <Sider>left sidebar</Sider>
    <Content>main content</Content>
    <Sider>right sidebar</Sider>
  </Layout>
  <Footer>footer</Footer>
</Layout>

Layout

布局容器。

参数 说明 类型 默认值
style 指定样式 object -
className 容器 className string -

Layout.Header Layout.Footer Layout.Content API 与 Layout 相同

Layout.Sider

侧边栏。

参数 说明 类型 默认值
collapsible 是否可收起 boolean false
defaultCollapsed 是否默认收起 boolean false
collapsed 当前收起状态 boolean -
onCollapse 展开-收起时的回调函数,有点击 trigger 以及响应式反馈两种方式可以触发 (collapsed, type) => {} -
trigger 自定义 trigger设置为 null 时隐藏 trigger string|ReactNode -
width 宽度 number|string 200
collapsedWidth 收缩宽度,设置为 0 会出现特殊 trigger number 64
breakpoint 触发响应式布局的断点 Enum { 'xs', 'sm', 'md', 'lg', 'xl' } -
style 指定样式 object -
className 容器 className string -

注意:如果你想在 Sider 基础上进行包装,需要给自定义组件加上 __ANT_LAYOUT_SIDER = true 设置,例如:

const CustomizedSider = (props) => <Sider {...props} />
CustomizedSider.__ANT_LAYOUT_SIDER = true;
...
<CustomizedSider>Sider Content</CustomizedSider>