Select Field

Admin panel screenshot of a Select field

Config

Option	Description
`name` *	To be used as the property name when stored and retrieved from the database. More
`options` *	Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing a `label` string and a `value` string.
`hasMany`	Boolean when, if set to `true`, allows this field to have many selections instead of only one.
`label`	Text used as a field label in the Admin panel or an object with keys for each language.
`unique`	Enforce that each entry in the Collection has a unique value for this field.
`validate`	Provide a custom validation function that will be executed on both the Admin panel and the backend. More
`index`	Build an index for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often.
`saveToJWT`	If this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
`hooks`	Provide field-based hooks to control logic for this field. More
`access`	Provide field-based access control to denote what users can see and do with this field's data. More
`hidden`	Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.
`defaultValue`	Provide data to be used for this field's default value. More
`localized`	Enable localization for this field. Requires localization to be enabled in the Base config.
`required`	Require this field to have a value.
`admin`	Admin-specific configuration. See the default field admin config for more details.
`custom`	Extension point for adding custom data (e.g. for plugins)
`enumName`	Custom enum name for this field when using SQL database adapter (Postgres). Auto-generated from name if not defined.
`dbName`	Custom table name (if `hasMany` set to `true`) for this field when using SQL database adapter (Postgres). Auto-generated from name if not defined.

* An asterisk denotes that a property is required.

Admin config

In addition to the default field admin config, the Select field type also allows for the following admin-specific properties:

isClearable

Set to true if you'd like this field to be clearable within the Admin UI.

isSortable

Set to true if you'd like this field to be sortable within the Admin UI using drag and drop. (Only works when hasMany is set to true)

Example

collections/ExampleCollection.ts

1import { CollectionConfig } from 'payload/types'
2
3export const ExampleCollection: CollectionConfig = {
slug: 'example-collection',
fields: [
  {
    name: 'selectedFeatures', // required
    type: 'select', // required
    hasMany: true,
    admin: {
      isClearable: true,
      isSortable: true, // use mouse to drag and drop different values, and sort them according to your choice
    },
    options: [
      {
        label: 'Metallic Paint',
        value: 'metallic_paint',
      },
      {
        label: 'Alloy Wheels',
        value: 'alloy_wheels',
      },
      {
        label: 'Carbon Fiber Dashboard',
        value: 'carbon_fiber_dashboard',
      },
    ],
  },
],
30}

Customization

The Select field UI component can be customized by providing a custom React component to the components object in the Base config.

1export const CustomSelectField: Field = {
name: 'customSelectField',
type: 'select', // or 'text' if you have dynamic options
admin: {
  components: {
    Field: CustomSelectComponent({
      options: [
        {
          label: 'Option 1',
          value: '1',
        },
        {
          label: 'Option 2',
          value: '2',
        },
      ],
    }),
  },
}
20}

You can import the existing Select component directly from Payload, then extend and customize it as needed.

1import * as React from 'react';
2import { SelectInput, useField } from 'payload/components/forms';
3import { useAuth } from 'payload/components/utilities';
4
5type CustomSelectProps = {
6  path: string;
7  options: {
8    label: string;
9    value: string;
10  }[];
11}
12
13export const CustomSelectComponent: React.FC<CustomSelectProps> = ({ path, options }) => {
14  const { value, setValue } = useField<string>({ path })
15  const { user } = useAuth()
16
17  const adjustedOptions = options.filter((option) => {
18    /*
19      A common use case for a custom select
20      is to show different options based on
21      the current user's role.
22    */
23    return option;
24  });
25
26  return (
27    <div>
28      <label className = "field-label" >
29      Custom
30  Select
31  < /label>
32  < SelectInput
33  path = { path }
34  name = { path }
35  options = { adjustedOptions }
36  value = { value }
37  onChange = {(e)
38=>
39  setValue(e.value)
40}
41  />
42  < /div>
43)
44}

If you are looking to create a dynamic select field, the following tutorial will walk you through the process of creating a custom select field that fetches its options from an external API.

If you want to learn more about custom components check out the Admin > Custom Component docs.

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Deploy your entire stack in one place with Payload Cloud.

Microsoft chose Payload to tell the world about AI.

Select Field

Config

Admin config

Example

Customization

Tabs Field

Related Help Topics