Configuration

import seofields from 'sanity-plugin-seofields'

export default defineConfig({
  plugins: [
    seofields(),  // All defaults — preview, dashboard, all fields
  ],
})

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

export default defineConfig({
  plugins: [
    seofields({
      // Live SERP preview with custom URL prefix + suffix branding
      seoPreview: {
        prefix: (doc) => `/${doc.slug?.current || 'page'}`,
        // Static suffix appended to the SERP preview title — plugin adds " | " automatically
        // and includes it in Meta Title validation length checks.
        titleSuffix: 'Acme Inc',
        // Match parent title color (blue, weight 500) instead of muted gray
        titleSuffixInheritColor: true,
      },

      // Base URL for preview
      baseUrl: 'https://www.example.com',

      // Sanity API version — used by SEO preview GROQ + Health Dashboard
      apiVersion: '2024-01-01',

      // Customize field labels and descriptions
      fieldOverrides: {
        title: {
          title: 'Page Title',
          description: 'The main title that appears in search results',
        },
        description: {
          title: 'Meta Description',
          description: 'A brief summary for search engines',
        },
        canonicalUrl: {
          title: 'Canonical URL',
          description: 'Preferred URL to avoid duplicate content',
        },
        metaImage: {
          title: 'Social Media Image',
          description: 'Image used when sharing on social platforms',
        },
        keywords: {
          title: 'Editorial Keywords',
          description: 'Internal keywords for editorial workflows and content audits',
        },
      },

      // Hide fields on specific document types
      fieldVisibility: {
        page: {
          hiddenFields: ['openGraphSiteName', 'twitterSite'],
        },
        post: {
          hiddenFields: ['openGraphSiteName', 'twitterSite'],
        },
      },

      // Or hide fields globally
      defaultHiddenFields: ['openGraphSiteName', 'twitterSite'],

      // Organize fields into tabbed groups
      fieldGroups: [
        { name: 'meta', title: 'Meta', default: true,
          fields: ['title', 'description', 'metaImage', 'keywords', 'canonicalUrl', 'metaAttributes', 'robots'] },
        { name: 'openGraph', title: 'Open Graph', fields: ['openGraph'] },
        { name: 'twitter', title: 'Twitter Card', fields: ['twitter'] },
      ],

      // SEO Health Dashboard — set false to disable, or pass an object to configure
      healthDashboard: {
        licenseKey: 'SEOF-XXXX-XXXX-XXXX',
        tool: { title: 'SEO Audit', name: 'seo-audit' },
        showTypeColumn: true,
        showDocumentId: false,
        query: { types: ['post', 'page'] },
      },
      // healthDashboard: false, // disable entirely
    } satisfies SeoFieldsPluginConfig),
  ],
})