ant-design/components/page-header/index.en-US.md

1.6 KiB

category type title cols subtitle cover
Components Navigation PageHeader 1 https://gw.alipayobjects.com/zos/alicdn/6bKE0Cq0R/PageHeader.svg

A header with common actions and design elements built in.

When To Use

PageHeader can be used to highlight the page topic, display important information about the page, and carry the action items related to the current page (including page-level operations, inter-page navigation, etc.) It can also be used as inter-page navigation.

API

Param Description Type Default value Version
title Custom title text ReactNode -
subTitle Custom subtitle text ReactNode -
ghost PageHeader type, will change background color boolean true
avatar Avatar next to the title bar AvatarProps -
backIcon Custom back icon, if false the back icon will not be displayed ReactNode | boolean <ArrowLeft />
tags Tag list next to title Tag[] | Tag -
extra Operating area, at the end of the line of the title line ReactNode -
breadcrumb Breadcrumb configuration Breadcrumb -
footer PageHeader's footer, generally used to render TabBar ReactNode -
onBack Back icon click event ()=>void ()=>history.back()