Country Select Examples

country_select 8.0.2

countries 5.6.0

Vanilla Form using `form_with`

Default Configuration

Default Config
f.country_select :country_code

With Priority Countries
f.country_select :country_code, priority_countries: ["GB", "US", "LV"]

With Priority Countries in the provided order
f.country_select :country_code, priority_countries: ["GB", "US", "LV"]

With Prompt
f.country_select :country_code, priority_countries: ["GB", "US"], prompt: "Select a Country"

Including a blank selection
f.country_select :country_code, priority_countries: ["GB", "US"], include_blank: true

Adding HTML attributes
f.country_select :country_code, { priority_countries: ["GB", "US"] }, class: 'required-field', required: true

With I18n Support (I18n.locale = :es)

Country code
f.country_select :country_code

With Priority Countries
f.country_select :country_code, priority_countries: ["GB", "US"]

With Only Chosen Countries

Chosen Countries
f.country_select :country_code, only: ["SG","LV"]

Chosen Countries in the provided order
f.country_select :country_code, only: ["SG","LV"], sort_provided: false

With Priority Countries
f.country_select :country_code, only: ["US"], priority_countries: ["GB", "US"]

Excluding Countries

Excluding Latvia and Signapore
f.country_select :country_code, except: ["LV","SG"]

With Priority Countries
f.country_select :country_code, except: ["US"], priority_countries: ["GB", "US"]

Without Form Object

country_select("address", "country", only: ["GB", "FR", "DE"])

country_select(nil, "country", only: ["GB", "FR", "DE"])

Using a custom formatter

Custom formatters can be defined in an initializer to fully customize option tags.

CountrySelect::FORMATS[:with_alpha2] = lambda do |country|
  "#{country.iso_short_name} (#{country.alpha2})"
end

Using Custom Alpha2 Formatter
f.country_select :country_code, format: :with_alpha2

CountrySelect::FORMATS[:with_data_attrs] = lambda do |country|
  [
    country.iso_short_name,
    country.alpha2,
    {
      'data-country-code' => country.country_code,
      'data-alpha3' => country.alpha3
    }
  ]
end

Using Custom Option Formatter With HTML data attributes
f.country_select :country_code, format: :with_data_attrs

Formtastic

Default Configuration

Country code

f.input :country_code, as: :country

Country code

f.input :country_code, as: :country, priority_countries: ["GB", "US"]

With I18n Support (I18n.locale = :es)

Country code

f.input :country_code, as: :country

Country code

f.input :country_code, as: :country, priority_countries: ["GB", "US"]

With Only Chosen Countries

Country code

f.input :country_code, as: :country, only: ["LV","SG"]

Country code

f.input :country_code, as: :country, priority_countries: ["GB", "US"], only: ["US"]

Simple Form

Default Configuration

Country code

f.input :country_code

Country code

f.input :country_code, priority: ["GB", "US"]

With I18n Support (I18n.locale = :es)

Country code

f.input :country_code

Country code

f.input :country_code, priority: ["GB", "US"]

With Only Chosen Countries

Country code

f.input :country_code, only: ["LV","SG"]

Country code

f.input :country_code, priority: ["GB", "US"], only: ["US"]

With Unofficial Country Names

Country code

f.input :country_code, priority: ["United Kingdom", "US"]

Country Select Examples

Vanilla Form using form_with

Formtastic

Simple Form

Vanilla Form using `form_with`