ant-design/components/layout/index.en-US.md
偏右 0062867274 Feature 2.6 (#4429)
* new Layout Component (#4087)

* change Anchor type

* new Layout

* Component update && add snap

* Revert "new Layout Component" (#4131)

* add Layout (#4169)

* add Layout

* update

* fix snapshot

* Improve layout component

1. update demo code
2. drop `position` of Sider
3. improve demo style
2016-12-30 21:41:28 +08:00

1.8 KiB

category type cols title
Components Layout 1 Layout

When you are handling the overall layout of a page, this component might be helpfull.

Overview

  • Layout: The layout wrapper, in which Header Sider Content Footer or Layout itself can be nested.
  • Header: The top layout with default style.
  • Sider: The sidebar with default style and basic functions.
  • Content: The content layout with default style.
  • Footer: The bottom layout with default style.

Base on flex layout, please pay attention to the compatibility.

API

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

Layout

The wrapper.

Property Description Type Default
style to custom the styles Object -
className container className string -

API of Layout.Header Layout.Footer Layout.Content is the same with Layout.

Layout.Sider

The sidebar.

Property Description Type Default
collapsible whether can be collapsed Boolean false
defaultCollapsed to set the initial status Boolean false
collapsed to set the current status Boolean -
onCollapse the callback function, can be executed when you switch the sidebar, available only collapsible: true (collapsed) => {} -
trigger specify the customized trigger, set to null to hide the trigger React.ReactNode or null -
width width of the sidebar Number or String 200
collapsedWidth width of the collapsed sidebar, available only collapsible: true Number 64
style to custom the styles Object -
className container className string -