index.md 2.2 KB
Newer Older
1
---
nikogu's avatar
nikogu committed
2 3
title:
  en-US: PageHeader
nikogu's avatar
nikogu committed
4
  zh-CN: PageHeader
5 6
subtitle: 页头
cols: 1
nikogu's avatar
nikogu committed
7
order: 11
8 9 10 11 12 13 14 15 16 17 18
---

页头用来声明页面的主题,包含了用户所关注的最重要的信息,使用户可以快速理解当前页面是什么以及它的功能。

## API

| 参数      | 说明                                      | 类型         | 默认值 |
|----------|------------------------------------------|-------------|-------|
| title | title 区域 | ReactNode | - |
| logo | logo区域 | ReactNode | - |
| action | 操作区,位于 title 行的行尾 | ReactNode | - |
陈帅's avatar
陈帅 committed
19
| home | 默认的主页说明文字 | ReactNode | - |
20 21
| content | 内容区 | ReactNode | - |
| extraContent | 额外内容区,位于content的右侧 | ReactNode | - |
ddcat1115's avatar
ddcat1115 committed
22
| breadcrumbList | 面包屑数据,配置了此属性时 `routes` `params` `location` `breadcrumbNameMap` 无效 | array<{title: ReactNode, href?: string}> | - |
23 24
| routes | 面包屑相关属性,router 的路由栈信息 | object[] | - |
| params | 面包屑相关属性,路由的参数 | object | - |
ddcat1115's avatar
ddcat1115 committed
25 26
| location | 面包屑相关属性,当前的路由信息 | object | - |
| breadcrumbNameMap | 面包屑相关属性,路由的地址-名称映射表 | object | - |
27
| tabList | tab 标题列表 | array<{key: string, tab: ReactNode}> | -  |
afc163's avatar
afc163 committed
28
| tabActiveKey | 当前高亮的 tab 项 | string | -  |
29
| tabDefaultActiveKey | 默认高亮的 tab 项 | string | 第一项  |
陈帅's avatar
陈帅 committed
30
| wide | 是否定宽 | boolean | false  |
31
| onTabChange | 切换面板的回调 | (key) => void | -  |
陈帅's avatar
陈帅 committed
32
| itemRender | 自定义节点方法 | (menuItem) => ReactNode | -  |
偏右's avatar
偏右 committed
33
| linkElement | 定义链接的元素,默认为 `a`,可传入 react-router 的 Link | string\|ReactElement | - |
34

ddcat1115's avatar
ddcat1115 committed
35
> 面包屑的配置方式有三种,一是直接配置 `breadcrumbList`,二是结合 `react-router@2` `react-router@3`,配置 `routes` 及 `params` 实现,类似 [面包屑 Demo](https://ant.design/components/breadcrumb-cn/#components-breadcrumb-demo-router),三是结合 `react-router@4`,配置 `location` `breadcrumbNameMap`,优先级依次递减,脚手架中使用最后一种。 对于后两种用法,你也可以将 `routes` `params` 及 `location` `breadcrumbNameMap` 放到 context 中,组件会自动获取。