API Reference

Complete reference for the plugin's exports, configuration types, and schema types.

Main Export

Import

import seofields from 'sanity-plugin-seofields'
import type { SeoFieldsPluginConfig } from 'sanity-plugin-seofields'

// Usage
seofields(config?: SeoFieldsPluginConfig)

SeoFieldsPluginConfig

interface SeoFieldsPluginConfig {
  // Enable/disable SEO preview (default: true)
  seoPreview?: boolean | {
    prefix?: (document: SanityDocument) => string
  }

  // Base URL for preview generation
  baseUrl?: string

  // Customize field titles and descriptions
  fieldOverrides?: {
    [fieldKey: string]: {
      title?: string
      description?: string
    }
  }

  // Hide fields on specific document types
  fieldVisibility?: {
    [documentType: string]: {
      hiddenFields: string[]
    }
  }

  // Hide fields globally
  defaultHiddenFields?: string[]

  // Enable/disable dashboard (default: true)
  enableDashboard?: boolean
}

Schema Types

These types are automatically registered when you add the plugin:

seoFieldsComplete SEO field package

title: string (max 70)

description: text (max 160)

canonicalUrl: url

metaImage: image

keywords: string[]

robots: { noIndex, noFollow }

metaAttributes: metaAttribute[]

openGraph: { title, description, url, siteName, type, image }

twitter: { card, site, creator, title, description, image }

openGraphStandalone Open Graph configuration

title: string

description: text

url: url

siteName: string

imageType: 'upload' | 'url'

image: image

imageUrl: url

twitterX (formerly Twitter) Card settings

card: 'summary' | 'summary_large_image' | 'app' | 'player'

site: string (@handle)

creator: string (@handle)

title: string (max 70)

description: text (max 200)

imageType: 'upload' | 'url'

image: image

imageUrl: url

robotsSearch engine directives

noIndex: boolean

noFollow: boolean

metaTagArray of custom meta attributes

metaAttributes: metaAttribute[]

metaAttributeIndividual meta attribute

attributeKey: string

attributeType: 'string' | 'image'

attributeValueString: string

attributeValueImage: image

Field Override Keys

Available keys for fieldOverrides and fieldVisibility.hiddenFields:

Core

titledescriptioncanonicalUrlmetaImagekeywordsmetaAttributesrobots

Open Graph

openGraphUrlopenGraphTitleopenGraphDescriptionopenGraphSiteNameopenGraphTypeopenGraphImage

X (Twitter)

twitterCardtwitterSitetwitterCreatortwitterTitletwitterDescriptiontwitterImage