Select Field

#
Config

OptionDescription
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.
hasManyBoolean when, if set to true, allows this field to have many selections instead of only one.
labelText used as a field label in the Admin panel or an object with keys for each language.
uniqueEnforce that each entry in the Collection has a unique value for this field.
validateProvide a custom validation function that will be executed on both the Admin panel and the backend. More
indexBuild a MongoDB 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.
saveToJWTIf this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
hooksProvide field-based hooks to control logic for this field. More
accessProvide field-based access control to denote what users can see and do with this field's data. More
hiddenRestrict 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.
defaultValueProvide data to be used for this field's default value. More
localizedEnable localization for this field. Requires localization to be enabled in the Base config.
requiredRequire this field to have a value.
adminAdmin-specific configuration. See the default field admin config for more details.
customExtension point for adding custom data (e.g. for plugins)

* 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

import { CollectionConfig } from 'payload/types';
export 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',
},
],
}
]
}
Next

Tabs Field