TitleBar Component

Requires @shopify/app-bridge-react@v4 and the app-bridge.js script tag

The Title Bar API allows you to populate a standardized title bar with button actions and navigation breadcrumbs.

Anchor to titlebar componentTitleBar component

The TitleBar component is available for use in your app. It configures the Title Bar in the Shopify admin.

Anchor to children children: The children of the title bar.
Anchor to title title string: The title of the title bar. Can also be set via document.title.

_UITitleBarAttributes

children
The children of the title bar.
```
UITitleBarChildren
```
title
The title of the title bar. Can also be set via <code>document.title</code>.
```
string
```

interface _UITitleBarAttributes {
  /**
   * The title of the title bar. Can also be set via <code>document.title</code>.
   */
  title?: string;
  /**
   * The children of the title bar.
   */
  children?: UITitleBarChildren;
}

UITitleBarChildren

BaseElementAttributes & { variant?: "breadcrumb" | "primary"; }

button

BaseElementAttributes & { variant?: "breadcrumb" | "primary"; tone?: "critical" | "default"; }

section

{ label?: string; children?: { a?: BaseElementAttributes; button?: BaseElementAttributes; }; }

interface UITitleBarChildren {
  a?: BaseElementAttributes & {variant?: 'breadcrumb' | 'primary'};
  button?: BaseElementAttributes & {
    variant?: 'breadcrumb' | 'primary';
    tone?: 'critical' | 'default';
  };
  section?: {
    label?: string;
    children?: {
      a?: BaseElementAttributes;
      button?: BaseElementAttributes;
    };
  };
}

BaseElementAttributes

children
```
string
```
class
```
string
```
href
```
string
```
id
```
string
```
name
```
string
```
onclick
```
string
```
rel
```
string
```
target
```
string
```

interface BaseElementAttributes {
  id?: string;
  name?: string;
  class?: string;
  href?: string;
  rel?: string;
  target?: string;
  onclick?: string;
  children?: string;
}

Was this section helpful?

TitleBar

import {TitleBar} from '@shopify/app-bridge-react';

export function MyApp() {

return (

<button variant="primary">Primary action</button>

<button>Secondary action</button>

</TitleBar>

);

}

examples

TitleBar

import {TitleBar} from '@shopify/app-bridge-react';

export function MyApp() {
  return (
    <TitleBar title="Products">
      <button variant="primary">Primary action</button>
      <button>Secondary action</button>
    </TitleBar>
  );
}

Preview

Anchor to examplesExamples

Title Bar with different options

Anchor to example-title-bar-with-buttonsTitle Bar with buttons

Title Bar with buttons

Anchor to example-title-bar-with-grouped-secondary-buttonsTitle Bar with grouped secondary buttons

Title Bar with grouped secondary buttons

Was this section helpful?

Title Bar with breadcrumb

import {TitleBar} from '@shopify/app-bridge-react';

export function MyApp() {

return (

</TitleBar>

);

}

examples

Title Bar with breadcrumb

description

Title Bar with breadcrumb

import {TitleBar} from '@shopify/app-bridge-react';

export function MyApp() {
  return (
    <TitleBar title="Products">
      <button variant="breadcrumb">Home</button>
    </TitleBar>
  );
}

Title Bar with buttons

description

Title Bar with buttons

import {TitleBar} from '@shopify/app-bridge-react';

export function MyApp() {
  return (
    <TitleBar title="Products">
      <button onClick={() => console.log('Secondary Action')}>
        Secondary Action
      </button>
      <button variant="primary" onClick={() => console.log('Primary Action')}>
        Primary Action
      </button>
    </TitleBar>
  );
}

Title Bar with grouped secondary buttons

description

Title Bar with grouped secondary buttons

import {TitleBar} from '@shopify/app-bridge-react';

export function MyApp() {
  return (
    <TitleBar title="Products">
      <section label="More actions">
        <button onClick={() => console.log('Secondary Action 1')}>
          Secondary Action 1
        </button>
        <button onClick={() => console.log('Secondary Action 2')}>
          Secondary Action 2
        </button>
      </section>
    </TitleBar>
  );
}

Anchor to relatedRelated

Web Componentsui-title-bar

React ComponentsModal