element-plus/docs/en-US/component/page-header.md

2.4 KiB

title lang
Page en-US

Page Header

If path of the page is simple, it is recommended to use PageHeader instead of the Breadcrumb.

Complete example

:::demo

page-header/complete

:::

Basic usage

Standard page header, for simply scenarios.

:::demo

page-header/basic

:::

Custom icon

The default icon might not meet your satisfaction, you can customize the icon by setting icon attribute like the example.

:::demo

page-header/custom-icon

:::

No icon

Sometimes the page is just full of elements, and you might not want the icon to show up on the page, you can set the icon attribute to null to get rid of it.

:::demo

page-header/no-icon

:::

Breadcrumbs

Page header allows you to add breadcrumbs for giving route information to the users by breadcrumb slot.

:::demo

page-header/breadcrumb

:::

Additional operation section

The header can be as complicated as needed, you may add additional sections to the header, to allow rich interactions.

:::demo

page-header/additional-sections

:::

Main content

Sometimes we want the head to show with some co-responding content, we can utilize the default slot for doing so.

:::demo

page-header/main-content

:::

Anatomy

The component is consisted of these parts

<template>
  <el-page-header>
    <!-- Line 1 -->
    <template #breadcrumb />
    <!-- Line 2 -->
    <template #icon />
    <template #title />
    <template #content />
    <template #extra />
    <!-- Lines after 2 -->
    <template #default />
  </el-page-header>
</template>

Attributes

Name Description Type Accepted Values Default
icon icon component string | Component Back
title main title string Back
content content string

Events

Name Description Parameters
back triggers when right side is clicked

Slots

Name Description
icon custom icon
title title content
content content
extra extra
breadcrumb breadcrumb content
default main content