Alpha component
Header component is subject to major changes and is for experimentation purposes only. Not recommended for use in production software.
Header component is subject to major changes and is for experimentation purposes only. Not recommended for use in production software.
The Header component exposes a way to build visually consistent hierarchy into apps that look and feel like part of the Contentful UI.
Note that the Header is not meant to be used when building navigation, for this case you will be better served by Navbar
.
import { Header } from '@contentful/f36-components';// orimport { Header } from '@contentful/f36-header';
Name | Type | Default |
---|---|---|
actions | ReactElement<any, string | JSXElementConstructor<any>> ReactElement<any, string | JSXElementConstructor<any>>[] Optional JSX children to display as complementary actions (e.g. buttons) related to the current page/route. | |
as | HTML Tag or React Component (e.g. div, span, etc) | |
backButtonProps | BackButtonProps | |
breadcrumbs | Breadcrumb[] An (optional) list of navigable links to prepend to the current title. | |
filters | ReactElement<any, string | JSXElementConstructor<any>> An (optional) element displayed in the center of the header, typically used to render refinement/search UI. | |
metadata | string number false true {} ReactElement<any, string | JSXElementConstructor<any>> ReactNodeArray ReactPortal | |
title | string ReactElement<any, string | JSXElementConstructor<any>> The title of the element this header pertains to. | |
withBackButton | false true If `true`, renders a leading back button within the header. |