schemaType

• Type: string | ((params: CallbackParams) => string)
• Optional: Yes

The schemaType property links the list item to a specific document type defined in your Sanity schema.

Standard Usage

JSON

{
  schemaType: 'author',
}

Helpers

helpers.listing('author');

With Custom Title

By default, the plugin generates a title based on the schemaType. You can override it using the title property.

JSON

{
  title: 'Contributors',
  schemaType: 'author',
}

Helpers

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

With Custom Icon

JSON

import { UsersIcon } from '@sanity/icons';

{
  schemaType: 'author',
  icon: UsersIcon,
}

Helpers

import { UsersIcon } from '@sanity/icons';

helpers.listing('author', {
  icon: UsersIcon,
});

With Combined (Title + Icon)

JSON

import { UsersIcon } from '@sanity/icons';

{
  title: 'Contributors',
  schemaType: 'author',
  icon: UsersIcon,
}

Helpers

import { UsersIcon } from '@sanity/icons';

helpers.listing('author', {
  title: 'Contributors',
  icon: UsersIcon,
});

With Disabled Pluralization

Use isPlural: false to display the singular name as defined in your schema.

JSON

{
  schemaType: 'author',
  isPlural: false,
}

Helpers

helpers.listing('author', {
  isPlural: false,
});

Dynamic Schema Type (Callback)

You can set the schemaType dynamically using a callback function:

JSON

{
  schemaType: ({ workspace }) => workspace === 'blog' ? 'post' : 'product',
}

Helpers

helpers.listing(({ workspace }) => (workspace === 'blog' ? 'post' : 'product'));