Newskit Logo
Newskit Logo
View Github

Title Bar

Overview

The title bar provides context and actions related to a particular section of content that follows below on the screen.

Props

Title bar has a number of props to facilitate a variety of uses:

childrenstring
The content of the title is passed as the child of the component.
headingAs'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'span' = h3
The heading tag used for the title. It should be one of the following strings: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'span'.
actionItemReact.ComponentType
An action item, most commonly a button or a link, related to the title. The actionItem is hidden for extra small viewports (less than 480px).
hideActionItemOnMQPartial<boolean> = {xs: true}
An object to specify in which breakpoints to hide the action item.
overridesobject
If provided, overrides the respective presets for the component and provided elements.
stylePresetMQ<string>
If provided, this overrides the style preset applied to the TitleBar.
spaceInsetMQ<string>
This property is deprecated. Use the below logical padding props instead. If provided, applies padding to the teaser container.
headingobject
typographyPresetMQ<string>
If provided, this overrides the typography preset applied to the TitleBar heading.
stylePresetMQ<string>
If provided, this overrides the typography preset applied to the TitleBar heading.
paddingInlineMQ<string>
It can take one space token to specify the logical inline start and end padding of the container. This space token can also be used on breakpoints.
paddingInlineStartMQ<string>
It can take one space token to specify the logical inline start padding of the container. This space token can also be used on breakpoints.
paddingInlineEndMQ<string>
It can take one space token to specify the logical inline end padding of the container. This space token can also be used on breakpoints.
paddingBlockMQ<string>
It can take one space token to specify the logical block start and end padding of the container. This space token can also be used on breakpoints.
paddingBlockStartMQ<string>
It can take one space token to specify the logical block start padding of the container. This space token can also be used on breakpoints.
paddingBlockEndMQ<string>
It can take one space token to specify the logical block end padding of the container. This space token can also be used on breakpoints.
marginInlineMQ<string>
It can take one space token to specify the logical inline start and end margin of the container. This space token can also be used on breakpoints.
marginInlineStartMQ<string>
It can take one space token to specify the logical inline start margin of the container. This space token can also be used on breakpoints.
marginInlineEndMQ<string>
It can take one space token to specify the logical inline end margin of the container. This space token can also be used on breakpoints.
marginBlockMQ<string>
It can take one space token to specify the logical block start and end margin of the container. This space token can also be used on breakpoints.
marginBlockStartMQ<string>
It can take one space token to specify the logical block start margin of the container. This space token can also be used on breakpoints.
marginBlockEndMQ<string>
It can take one space token to specify the logical block end margin of the container. This space token can also be used on breakpoints.
Refer to the defaults below for the object structure:

An error occurred loading this code example.

For more information about how to apply overrides to a component please refer to the Override default preset page.

Playground

Title content

Render Heading as
Action Item
1import React from 'react';
2import { TitleBar } from 'newskit';
3
4export default () => (
5  <TitleBar headingAs="h3">Title content</TitleBar>
6);
7

For more information on overriding component defaults, see the docs here.

Anatomy

  1. Title
  2. Action items (optional)

Container

The container takes up the full width of the grid area that's specified for example 12 column, 6 column etc.

A border is applied at the bottom.

Title

The title should provide context for the content that sits below the title bar.

Action Items

Action items can include a button or a link. They are positioned to the right of the container and they vertically align to the position of the title. If you are using one of our components you can style the Button or the Link as you like from their overrides. We suggest you to use the style preset buttonSolidPrimary and linkStandalone respectively for a Button and a Link action.

Behaviour

Action hidden at smaller breakpoints

By default the action item is hidden on extra small breakpoint (xs). This is to allow the action to then be placed at the bottom of mobile list for a better UX.

Accessibility

Your title should be 3:1 colour ratio against a the background colour to be AA WCAG compliant.