Class: Avo::Fields::HeadingField

Inherits:
BaseField show all
Defined in:
lib/avo/fields/heading_field.rb

Defined Under Namespace

Classes: EditComponent, 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, #null_values, #nullable, #panel_name, #readonly, #record, #required, #sortable, #stacked, #summarizable, #user

Attributes included from Concerns::IsDisabled

#disabled

Attributes included from 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 inherited from BaseField

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

Methods included from Concerns::UseViewComponents

#component_for_view, #view_component_name, #view_component_namespace

Methods included from Concerns::IsRequired

#is_required?

Methods included from Concerns::IsDisabled

#is_disabled?

Methods included from Concerns::IsReadonly

#is_readonly?

Methods included from Concerns::HasHTMLAttributes

#get_html

Methods included from 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) ⇒ HeadingField

Returns a new instance of HeadingField.



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

def initialize(id, **args, &block)
  args[:updatable] = false
  @label = args[:label] || id.to_s.humanize

  super(id, **args, &block)

  # this field is not used to update anything
  @for_presentation_only = true

  hide_on :index

  @as_html = args[:as_html].presence || false
end

Instance Attribute Details

#as_html ⇒ Object (readonly)

Returns the value of attribute as_html.



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

def as_html
  @as_html
end

Instance Method Details

#id ⇒ Object 



22
23
24
 
# File 'lib/avo/fields/heading_field.rb', line 22

def id
  "heading_#{name.to_s.parameterize.underscore}"
end

#value ⇒ Object 



26
27
28
 
# File 'lib/avo/fields/heading_field.rb', line 26

def value
  block.present? ? execute_block : @label
end