ant-design/components/page-header/index.zh-CN.md
偏右 882cec62d6
docs: 🌈 Add Components overview page (#24491)
* 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>
2020-05-31 11:48:34 +08:00

1.6 KiB

category type title cols subtitle cover
Components 导航 PageHeader 1 页头 https://gw.alipayobjects.com/zos/alicdn/Uh-BJWMqm/PageHeader.svg

页头位于页容器中,页容器顶部,起到了内容概览和引导页级操作的作用。包括由面包屑、标题、页面内容简介、页面级操作等、页面级导航组成。

何时使用

当需要使用户快速理解当前页是什么以及方便用户使用页面功能时使用,通常也可被用作页面间导航。

API

参数 说明 类型 默认值 版本
title 自定义标题文字 ReactNode -
subTitle 自定义的二级标题文字 ReactNode -
ghost pageHeader 的类型,将会改变背景颜色 boolean true
avatar 标题栏旁的头像 avatar props -
backIcon 自定义 back icon ,如果为 false 不渲染 back icon ReactNode | boolean <ArrowLeft />
tags title 旁的 tag 列表 Tag[] | Tag -
extra 操作区,位于 title 行的行尾 ReactNode -
breadcrumb 面包屑的配置 breadcrumb -
footer PageHeader 的页脚,一般用于渲染 TabBar ReactNode -
onBack 返回按钮的点击事件 ()=>void ()=>history.back()