Payload Adsign Plugin

Slug Field

Auto-generate URL-friendly slugs

Usage

collections/Articles/index.ts
import { slugField } from '@adsign/payload-adsign-plugin';

export const Articles: CollectionConfig = {
  fields: [
    {
      name: 'title',
      type: 'text',
    },
    slugField({
      useAsSlug: 'title',
    }),
  ],
};

Options

OptionTypeDefaultDescription
useAsSlugstring-Field to generate slug from
localestring'en'Locale for transliteration
namestring'slug'Field name
requiredbooleantrueIs required

Examples

With custom locale:

slugField({
  useAsSlug: 'title',
  locale: 'nb', // Norwegian
})

In sidebar:

slugField({
  useAsSlug: 'title',
  admin: { position: 'sidebar' },
})

On this page