Vivid API

Header

The header component can be used to display a header at the top of a page or section.

Usage

import { registerHeader } from '@vonage/vivid-api';
registerHeader('your-prefix');

Slots

Default Slot

The default slot sets assigned nodes to the start of the Header.

Action Items Slot

Nodes assigned to action-items slot will be set at the end of the Header.

App Content Slot

It is also possible to assign application content directly to the Header’s app-content slot, which will allow content to follow, vertically.

CSS Variables

Block Size

The Header has a fixed height (64px default). It cannot be modified, but is available as the --vvd-header-block-size CSS variable to slotted content.

Header background-color

Use --header-bg-color to set a custom background color for the header.

CSS Parts

Base

The component’s internal header element.

API Reference

Properties

PropertyTypeDefaultDescription
alternatebooleanapplies scheme alternate to header region
elevationShadowbooleanheader elevation shadow
PropertyTypeDefaultDescription
alternatebooleanapplies scheme alternate to header region
elevation-shadowbooleanheader elevation shadow

Slots

NameDescription
action-itemsNodes assigned to action-items slot will be set at the end of the header.
app-contentContent vertically aligned with header.
defaultDefault slot.
NameDescription
action-itemsNodes assigned to action-items slot will be set at the end of the header.
app-contentContent vertically aligned with header.
defaultDefault slot.