title

• Type: string | TitleObject | ((params: CallbackParams) => string | TitleObject)
• Optional: Yes (Required if children is present)

The title property sets the display name for the list item in the Sanity desk menu.

Standard Usage

JSON

{
  title: 'My Custom Title',
  schemaType: 'author',
}

Helpers

helpers.listing('author', {
  title: 'My Custom Title',
});

Parent & Child Titles

You can specify a different title for when an item is listed in the parent list versus when it is opened as a child pane. This is done by passing a TitleObject containing parent and/or child keys.

JSON

{
  schemaType: 'author',
  title: {
    parent: 'Contributors',
    child: 'Authors',
  },
}

Helpers

helpers.listing('author', {
  title: {
    parent: 'Contributors',
    child: 'Authors',
  },
});

With Children

When children are present, title becomes mandatory to label the parent item in the desk menu.

JSON

{
  title: 'Profile',
  children: [
    {
      schemaType: 'author',
    },
    {
      schemaType: 'user',
    },
  ],
}

Helpers

helpers.children('Profile', [helpers.listing('author'), helpers.listing('user')]);

With Dividers

You can use the title property with helpers.divider to create a labeled separator.

JSON

{
  title: 'Content Section',
  isDivider: true,
}

Helpers

helpers.divider('Content Section');

Dynamic Title (Callback)

You can set the title dynamically using a callback function:

JSON

{
  title: ({ workspace }) => `${workspace === 'production' ? 'Live' : 'Staging'} Settings`,
  schemaType: 'settings',
  singleton: true,
}

Helpers

helpers.singleton('settings', {
  title: ({ workspace }) => `${workspace === 'production' ? 'Live' : 'Staging'} Settings`,
});