Class: Avo::Fields::CountryField

Inherits:
BaseField show all
Includes:
FieldExtensions::HasIncludeBlank
Defined in:
lib/avo/fields/country_field.rb

Defined Under Namespace

Classes: EditComponent, IndexComponent, ShowComponent

Instance Attribute Summary collapse

Attributes inherited from BaseField

#action, #as_avatar, #autocomplete, #block, #computable, #computed, #computed_value, #default, #for_attribute, #for_presentation_only, #format_using, #help, #id, #null_values, #nullable, #panel_name, #readonly, #record, #required, #sortable, #stacked, #summarizable, #user

Attributes included from Avo::Fields::Concerns::IsDisabled

#disabled

Attributes included from Avo::Fields::Concerns::HasHTMLAttributes

#html

Attributes included from Concerns::VisibleInDifferentViews

#show_on_edit, #show_on_index, #show_on_new, #show_on_preview, #show_on_show

Attributes included from Concerns::IsVisible

#visible

Attributes included from Concerns::IsResourceItem

#resource, #view

Instance Method Summary collapse

Methods included from FieldExtensions::HasIncludeBlank

#include_blank

Methods inherited from BaseField

#apply_update_using, #assign_value, #custom?, #custom_name?, #database_id, #default_name, #execute_block, #fill_field, #form_field_label, #has_attribute?, #has_own_panel?, #hidden_in_reflection?, #meta, #name, #placeholder, #plural_name, #record_errors, #resolve_attribute, #table_header_label, #to_permitted_param, #translated_name, #translated_plural_name, #translation_key, #type, #updatable, #value, #visible_in_reflection?

Methods included from Avo::Fields::Concerns::UseViewComponents

#component_for_view, #view_component_name, #view_component_namespace

Methods included from Avo::Fields::Concerns::IsRequired

#is_required?

Methods included from Avo::Fields::Concerns::IsDisabled

#is_disabled?

Methods included from Avo::Fields::Concerns::IsReadonly

#is_readonly?

Methods included from Avo::Fields::Concerns::HasHTMLAttributes

#get_html

Methods included from Avo::Fields::Concerns::HasDefault

#computed_default_value

Methods included from Concerns::HasHelpers

#helpers

Methods included from Concerns::VisibleInDifferentViews

#except_on, #hide_on, #initialize_views, #only_on, #post_initialize, #show_on, #show_on_create, #show_on_update, #visible_in_view?

Methods included from Concerns::IsVisible

#visible?

Methods included from Concerns::HasItemType

#is_field?, #is_heading?, #is_main_panel?, #is_panel?, #is_row?, #is_sidebar?, #is_tab?, #is_tab_group?, #is_tool?

Methods included from Concerns::IsResourceItem

#visible?

Methods included from Concerns::Hydration

#hydrate

Constructor Details

#initialize(id, **args, &block) ⇒ CountryField

Returns a new instance of CountryField.



9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/avo/fields/country_field.rb', line 9

def initialize(id, **args, &block)
  args[:placeholder] ||= I18n.t("avo.choose_a_country")

  super(id, **args, &block)

  @countries = begin
    ISO3166::Country.translations.sort_by { |code, name| name }.to_h
  rescue
    {none: "You need to install the countries gem for this field to work properly"}
  end
  @display_code = args[:display_code].present? ? args[:display_code] : false
end

Instance Attribute Details

#countries ⇒ Object (readonly)

Returns the value of attribute countries.



6
7
8
 
# File 'lib/avo/fields/country_field.rb', line 6

def countries
  @countries
end

#display_code ⇒ Object (readonly)

Returns the value of attribute display_code.



7
8
9
 
# File 'lib/avo/fields/country_field.rb', line 7

def display_code
  @display_code
end

Instance Method Details

#options_for_filter ⇒ Object 



34
35
36
 
# File 'lib/avo/fields/country_field.rb', line 34

def options_for_filter
  select_options
end

#select_options ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/avo/fields/country_field.rb', line 22

def select_options
  if @display_code
    countries.map do |code, name|
      [code, code]
    end
  else
    countries.map do |code, name|
      [name, code]
    end
  end
end