Payload Adsign Plugin

Roles Field

Select field for user roles

Usage

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

export const Users: CollectionConfig = {
  fields: [
    rolesField({
      name: 'roles',
      label: 'User Roles',
      roles: [
        {
          label: 'Admin',
          name: 'admin',
        },
        {
          label: 'Editor',
          name: 'editor',
        },
      ],
    }),
  ],
};

Options

OptionTypeRequiredDescription
namestringYesField name
rolesArray<{label, name}>YesAvailable roles
labelstringNoField label

With Access Control

See Access Control Setup for using this field with role-based access control.

On this page