You are viewing a PR preview for PR #1506

Agriculture Design System
Beta
Design System for the Export Service

Header

The Header is the masthead of our applications. It incorporates the Department of Agriculture, Fisheries and Forestry Coat of Arms logo and provides a user context on where they are.

View in FigmaView in StorybookView in Github
import { ... } from '@ag.ds-next/react/header';

Usage

Header components can be imported via the header entrypoint in the @ag.ds-next/react package.

For example:

import { ... } from '@ag.ds-next/react/header';

Props

Header Props
PropTypeDescription
headingstringThe heading should be set to the website or service title.
background?"body" | "bodyAlt"Default: "body"The background color of the Header.
badgeLabel?stringUsed to indicate if an application is in a prerelease state.
href?stringDefault: "/"The href to link to, for example "/".
logo?ElementThe logo to display.
rightContent?ReactNodeContent to placed on the right side of the Header.
size?"sm" | "md"Default: "md"The size of the Header controls the vertical height.
subline?stringUsed to provide additional information to describe your website or service.

Source

You can view the full source code for this package on Github.