DemoCloud PricingDocsFor EnterpriseCommunity HelpBlog
New projectLogin
New projectLogin

Select Field

Shows a Select field in the Payload admin panel
Admin panel screenshot of a 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',
},
],
}
]
}

Customization

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

export 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',
},
],
}),
},
}
}

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

import * as React from 'react';
import { SelectInput, useField } from 'payload/components/forms';
import { useAuth } from 'payload/components/utilities';
type customSelectProps = {
path: string;
options: {
label: string;
value: string;
}[];
}
export const CustomSelectComponent: React.FC<CustomSelectProps> = ({ path, options }) => {
const { value, setValue } = useField<string>({ path });
const { user } = useAuth();
const adjustedOptions = options.filter((option) => {
/*
A common use case for a custom select
is to show different options based on
the current user's role.
*/
return option;
});
return (
<div>
<label className="field-label">
Custom Select
</label>
<SelectInput
path={path}
name={path}
options={adjustedOptions}
value={value}
onChange={() => setValue(e.value)}
/>
</div>
);
};

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.

Next

Tabs Field

Related Help Topics