Files
payload/test/fields/collections/Select/index.ts
Patrik 3c92fbd98d fix: ensures select & radio field option labels accept JSX elements (#11658)
### What

This PR ensures that `select` and `radio` field option labels properly
accept and render JSX elements.

### Why

Previously, JSX elements could be passed as option labels, but the type
definition for options only allowed `LabelFunction` or `StaticLabel`,
resulting in type errors. Additionally:
- JSX labels did not render correctly in the list view but now do.
- In the versions diff view, JSX labels were not supported since it only
accepts strings. To address this, we now fallback to the option `value`
when the label is a JSX element.
2025-03-14 09:14:28 -04:00

250 lines
4.9 KiB
TypeScript

import type { CollectionConfig } from 'payload'
import { selectFieldsSlug } from '../../slugs.js'
import { CustomJSXLabel } from './CustomJSXLabel.js'
const SelectFields: CollectionConfig = {
slug: selectFieldsSlug,
versions: true,
fields: [
{
name: 'select',
type: 'select',
admin: {
isClearable: true,
},
options: [
{
label: 'Value One',
value: 'one',
},
{
label: 'Value Two',
value: 'two',
},
{
label: 'Value Three',
value: 'three',
},
],
},
{
name: 'selectReadOnly',
type: 'select',
admin: {
readOnly: true,
},
options: [
{
label: 'Value One',
value: 'one',
},
{
label: 'Value Two',
value: 'two',
},
{
label: 'Value Three',
value: 'three',
},
],
},
{
name: 'selectHasMany',
hasMany: true,
type: 'select',
admin: {
isClearable: true,
isSortable: true,
},
options: [
{
label: 'Value One',
value: 'one',
},
{
label: 'Value Two',
value: 'two',
},
{
label: 'Value Three',
value: 'three',
},
{
label: 'Value Four',
value: 'four',
},
{
label: 'Value Five',
value: 'five',
},
{
label: 'Value Six',
value: 'six',
},
],
},
{
name: 'array',
type: 'array',
fields: [
{
name: 'selectHasMany',
hasMany: true,
type: 'select',
admin: {
isClearable: true,
isSortable: true,
},
options: [
{
label: 'Value One',
value: 'one',
},
{
label: 'Value Two',
value: 'two',
},
{
label: 'Value Three',
value: 'three',
},
{
label: 'Value Four',
value: 'four',
},
{
label: 'Value Five',
value: 'five',
},
{
label: 'Value Six',
value: 'six',
},
],
},
{
name: 'group',
type: 'group',
fields: [
{
name: 'selectHasMany',
hasMany: true,
type: 'select',
admin: {
isClearable: true,
isSortable: true,
},
options: [
{
label: 'Value One',
value: 'one',
},
{
label: 'Value Two',
value: 'two',
},
{
label: 'Value Three',
value: 'three',
},
{
label: 'Value Four',
value: 'four',
},
{
label: 'Value Five',
value: 'five',
},
{
label: 'Value Six',
value: 'six',
},
],
},
],
},
],
},
{
name: 'selectHasManyLocalized',
type: 'select',
hasMany: true,
localized: true,
options: [
{
label: 'Value One',
value: 'one',
},
{
label: 'Value Two',
value: 'two',
},
],
},
{
name: 'selectI18n',
type: 'select',
admin: {
isClearable: true,
},
options: [
{
value: 'one',
label: { en: 'One', es: 'Uno' },
},
{
value: 'two',
label: { en: 'Two', es: 'Dos' },
},
{
value: 'three',
label: { en: 'Three', es: 'Tres' },
},
],
},
{
name: 'simple',
type: 'select',
options: ['One', 'Two', 'Three'],
},
{
type: 'group',
name: 'settings',
fields: [
{
name: 'category',
type: 'select',
hasMany: true,
options: [
{ value: 'a', label: 'A' },
{ value: 'b', label: 'B' },
],
},
],
},
{
name: 'selectWithJsxLabelOption',
label: 'Select with JSX label option',
type: 'select',
defaultValue: 'three',
options: [
{
label: 'Value One',
value: 'one',
},
{
label: 'Value Two',
value: 'two',
},
{
label: CustomJSXLabel,
value: 'three',
},
],
},
],
}
export default SelectFields