import Props from '@ionic-internal/component-api/v8/header/props.md'; import Events from '@ionic-internal/component-api/v8/header/events.md'; import Methods from '@ionic-internal/component-api/v8/header/methods.md'; import Parts from '@ionic-internal/component-api/v8/header/parts.md'; import CustomProps from '@ionic-internal/component-api/v8/header/custom-props.mdx'; import Slots from '@ionic-internal/component-api/v8/header/slots.md';

import EncapsulationPill from '@components/page/api/EncapsulationPill';

Header is a root component of a page that aligns itself to the top of the page. It is recommended to be used as a wrapper for one or more toolbars, but it can be used to wrap any element. When a toolbar is used inside of a header, the content will be adjusted so it is sized correctly, and the header will account for any device safe areas.

import Basic from '@site/static/usage/v8/header/basic/index.md';

Headers can match the transparency found in native iOS applications by setting the translucent property. In order to see the content scrolling behind the header, the fullscreen property needs to be set on the content. This effect will only apply when the mode is "ios" and the device supports backdrop-filter.

import Translucent from '@site/static/usage/v8/header/translucent/index.md';

Ionic provides the functionality found in native iOS applications to show a large toolbar title and then collapse it to a small title when scrolling. This can be done by adding two headers, one above the content and one inside of the content, and then setting the collapse property to "condense" on the header inside of the content. This effect will only apply when the mode is "ios".

import Condense from '@site/static/usage/v8/header/condense/index.md';

Many native iOS applications have a fade effect on the toolbar. This can be achieved by setting the collapse property on the header to "fade". When the page is first loaded, the background and border on the header will be hidden. As the content is scrolled, the header will fade back in. This effect will only apply when the mode is "ios".

This functionality can be combined with a Condensed Header as well. The collapse property with a value set to "fade" should be on the header outside of the content.

import Fade from '@site/static/usage/v8/header/fade/index.md';

A fade header requires a scroll container to work properly. When using a virtual scrolling solution, a custom scroll target needs to be provided. Scrolling on the content needs to be disabled and the .ion-content-scroll-host class needs to be added to the element responsible for scrolling.

import CustomScrollTarget from '@site/static/usage/v8/header/custom-scroll-target/index.md';

In "md" mode, the header will have a box-shadow on the bottom. In "ios" mode, it will receive a border on the bottom. These can be removed by adding the .ion-no-border class to the header.

import NoBorder from '@site/static/usage/v8/header/no-border/index.md';