Country

The Country type provides a country selection.

Settings

Name	Type	Default
default	string	''
required	boolean	false
filter	array	[]
labelField	string	name
prioritizedCountries	array	[]
sortItems	array	[]

default

Type: string
Default: ''

Default value set if a new record is created.

required

Type: boolean
Default: false

If true, an empty selection cannot be made.

filter

Type: array
Default: []

With the filter option it is possible to constrain the possible countries.

name: example/country
fields:
  - identifier: country
    type: Country
    filter:
      onlyCountries:
        - DE
        - AT
        - CH

name: example/country
fields:
  - identifier: country
    type: Country
    filter:
      excludeCountries:
        - DE
        - AT
        - CH

labelField

Type: string
Default: name

The value to use for the label. Possible values are:

localizedName
name
iso2
iso3
officialName
localizedOfficialName

prioritizedCountries

Type: array
Default: []

Countries (ISO2 or ISO3 codes) which are listed before all others countries.

name: example/country
fields:
  - identifier: country
    type: Country
    prioritizedCountries:
      - DE
      - AT
      - CH

sortItems

Type: array
Default: []

Sort order of the select items in the country picker.

name: example/country
fields:
  - identifier: country
    type: Country
    sortItems:
      label: 'desc'

Example

Minimal

name: example/country
fields:
  - identifier: country
    type: Country

Advanced / use case

name: example/country
fields:
  - identifier: country
    type: Country
    required: true
    default: 'DE'
    labelField: 'localizedName'
    prioritizedCountries:
      - DE
      - AT
      - CH