Class: Avo::Fields::TrixField

Inherits:
BaseField show all
Defined in:
lib/avo/fields/trix_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, #copyable, #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 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

#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, #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, #value, #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) ⇒ TrixField

Returns a new instance of TrixField.



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

def initialize(id, **args, &block)
  super(id, **args, &block)

  hide_on :index

  @always_show = args[:always_show] || false
  @attachment_key = args[:attachment_key]
  @attachments_disabled = args[:attachments_disabled]
  @hide_attachment_filename = args[:hide_attachment_filename] || false
  @hide_attachment_filesize = args[:hide_attachment_filesize] || false
  @hide_attachment_url = args[:hide_attachment_url] || false
end

Instance Attribute Details

#always_show ⇒ Object (readonly)

Returns the value of attribute always_show.



4
5
6
 
# File 'lib/avo/fields/trix_field.rb', line 4

def always_show
  @always_show
end

#attachment_key ⇒ Object (readonly)

Returns the value of attribute attachment_key.



5
6
7
 
# File 'lib/avo/fields/trix_field.rb', line 5

def attachment_key
  @attachment_key
end

#hide_attachment_filename ⇒ Object (readonly)

Returns the value of attribute hide_attachment_filename.



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

def hide_attachment_filename
  @hide_attachment_filename
end

#hide_attachment_filesize ⇒ Object (readonly)

Returns the value of attribute hide_attachment_filesize.



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

def hide_attachment_filesize
  @hide_attachment_filesize
end

#hide_attachment_url ⇒ Object (readonly)

Returns the value of attribute hide_attachment_url.



8
9
10
 
# File 'lib/avo/fields/trix_field.rb', line 8

def hide_attachment_url
  @hide_attachment_url
end

Instance Method Details

#attachments_disabled ⇒ Object 



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/avo/fields/trix_field.rb', line 30

def attachments_disabled
  # Return the value of attachments_disabled if explicitly provided
  return @attachments_disabled unless @attachments_disabled.nil?

  # By default enable attachments on action text
  return false if is_action_text?

  # Disable attachments if attachment_key is not present
  @attachment_key.blank?
end

#is_action_text? ⇒ Boolean

Identify if field is bonded to a rich text model attribute

Returns:

  • (Boolean) 


24
25
26
27
28
 
# File 'lib/avo/fields/trix_field.rb', line 24

def is_action_text?
  return false if !defined?(ActionText::RichText) || record.nil? || !record.respond_to?(id)

  record.send(id).is_a?(ActionText::RichText)
end