Heading

Headings control the visual style of headings. Use headings to introduce major sections, like Contact information, Shipping address, or Shipping method. Unlike HTML headings, you don’t explicitly specify the position of the heading in the document outline. Nest headings within the heading group component to control the document outline structure used by assistive technologies.

Basic Heading

import {render, Heading} from '@shopify/checkout-ui-extensions-react';

render('Checkout::Dynamic::Render', () => );

function Extension() {
  return Store name;
}

import {extend, Heading} from '@shopify/checkout-ui-extensions';

extend('Checkout::Dynamic::Render', (root) => {
  const heading = root.createComponent(Heading, undefined, 'Store name');

  root.appendChild(heading);
});

HeadingProps

HeadingProps

id

Unique identifier. Typically used to make the heading a target that another component can refer to in order to provide an alternative accessibility label.

level

The visual level of the heading. When not set, the heading will use its “automatic” heading level, which is determined by the level of nesting within ancestor `HeadingGroup`s. No matter what value you provide here, the semantic level (e.g., how the heading contributes to the document outline) is determined exclusively by the “automatic” heading level.

accessibilityRole

Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help buyers navigate the page.

inlineAlignment

Align text along the main axis.

Level

1 | 2 | 3

AccessibilityRole

'main' | 'header' | 'footer' | 'section' | 'complementary' | 'navigation' | 'orderedList' | 'listItem' | 'unorderedList' | 'separator' | 'status' | 'alert' | 'decorative' | 'presentation'

InlineAlignment

'start' | 'center' | 'end'

Related

  • HeadingGroup
  • Text
  • TextBlock