Module: BulmaFormRails::FieldHelpers

Defined in:
lib/bulma_form_rails/field_helpers.rb

Overview

kevinweller.name

This Ruby on Rails Helper module allows easy and efficient web form construction with labeled fields of different types.

Constant Summary collapse

VALID_INPUT_TYPES = 
%i[color date datetime_local email file hidden month number password phone telephone text time url]

Instance Method Summary collapse

Instance Method Details

#bulma_check_box(form_or_object, field_name, options = {}) ⇒ Object

Render a labeled checkbox field.

  • form_or_object - the form or object

  • field_name - a symbol representing the name of the field

  • options - a hash of additional options:

    • class - additional checkbox classes other than checkbox

    • label - custom field label text



84
85
86
87
88
89
90
91
92
93
 
# File 'lib/bulma_form_rails/field_helpers.rb', line 84

def bulma_check_box(form_or_object, field_name, options = {})
  # Prepare parameters.
  prepare_value_class!(options, base_class: 'checkbox')
  render_parameters = prepare_common_parameters(field_name, form_or_object, options)
  
  # Render the labeled field.
  render layout: 'bulma_form_rails/field', locals: render_parameters do
    render partial: 'bulma_form_rails/value', locals: render_parameters.merge(method: :check_box, additional_field_classes: 'is-narrow')
  end
end

#bulma_custom_field(form_or_object, field_name, options = {}, &block) ⇒ Object

Render a labeled field with custom content.

  • form_or_object - the form or object

  • field_name - a symbol representing the name of the field as a whole, regardless of how many tags are in the specified ERb block

  • options - a hash of additional options:

    • label - custom field label text

  • block - ERb to render the field value content

Raises:

  • (ArgumentError) 


21
22
23
24
25
26
27
28
29
 
# File 'lib/bulma_form_rails/field_helpers.rb', line 21

def bulma_custom_field(form_or_object, field_name, options = {}, &block)
  # Prepare parameters.
  raise ArgumentError.new('No block given for custom field') if !block_given?
  render_parameters = prepare_common_parameters(field_name, form_or_object, options)
  render_parameters.merge!(additional_field_label_classes: 'is-normal') unless options[:contains_check_box_or_radio_group]
  
  # Render the labeled field.
  render layout: 'bulma_form_rails/field', locals: render_parameters, &block
end

#bulma_datetime_select(form_or_object, field_name, options = {}, html_options = {}) ⇒ Object

Render a labeled date+time selection field.

  • form_or_object - the form or object

  • field_name - a symbol representing the name of the field

  • options - a hash of additional options

  • html_options - a hash of additional options:

    • class - additional select classes other than select

    • label - custom field label text



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/bulma_form_rails/field_helpers.rb', line 139

def bulma_datetime_select(form_or_object, field_name, options = {}, html_options = {})
  # Prepare parameters.
  prepare_value_class!(options, base_class: 'select is-fullwidth')
  render_parameters = prepare_common_parameters(field_name, form_or_object, options)
  
  # Render the labeled field.
  render layout: 'bulma_form_rails/field', locals: render_parameters.merge(additional_field_label_classes: 'is-normal') do
    render partial: 'bulma_form_rails/datetime_select', locals: render_parameters.merge(html_options: html_options)
  end
end

#bulma_input(form_or_object, field_name, type = :text, options = {}) ⇒ Object

Render a labeled input field. Mandatory parameters:

  • form_or_object - the form or object

  • field_name - a symbol representing the name of the field

  • type - :color, :date, :datetime_local, :email, :file, :hidden, :month, :number, :password, :phone, :telephone, :text, :time, or :url with optional _field suffix

  • options - a hash of additional options:

    • class - additional input classes other than input

    • label - custom field label text

Raises:

  • (ArgumentError) 


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/bulma_form_rails/field_helpers.rb', line 41

def bulma_input(form_or_object, field_name, type = :text, options = {})
  # Convert type to form method.
  type = type.to_s
  type.delete!('_field') if type.end_with?('_field')
  raise ArgumentError.new("Invalid input type #{type.inspect}") unless VALID_INPUT_TYPES.any?(type.intern)
  method = "#{type}_field".intern
  
  # Prepare parameters.
  prepare_value_class!(options, base_class: 'input')
  render_parameters = prepare_common_parameters(field_name, form_or_object, options)
  additional_render_parameters = %i[date_field datetime_local_field month_field time_field].any?(method) ? {additional_field_classes: 'is-narrow'} : {}
  
  # Render the labeled field.
  render layout: 'bulma_form_rails/field', locals: render_parameters.merge(additional_field_label_classes: 'is-normal') do
    render partial: 'bulma_form_rails/value', locals: render_parameters.merge(method: method).merge(additional_render_parameters)
  end 
end

#bulma_radio_group(form_or_object, field_name, choices, options = {}) ⇒ Object

Render a labeled radio group field.

  • form_or_object - the form or object

  • field_name - a symbol representing the name of the field as a whole, regardless of how many radio buttons are generated by choices

  • choices - an array of radio button choice options

  • options - an array of additional options

    • class - additional radio classes other than radio

    • label - custom field label text



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/bulma_form_rails/field_helpers.rb', line 102

def bulma_radio_group(form_or_object, field_name, choices, options = {})
  # Prepare parameters.
  prepare_value_class!(options, base_class: 'radio')
  render_parameters = prepare_common_parameters(field_name, form_or_object, options)
  
  # Render the labeled field.
  render layout: 'bulma_form_rails/field', locals: render_parameters do
    render partial: 'bulma_form_rails/radio_group', locals: render_parameters.merge(choices: choices)
  end
end

#bulma_select(form_or_object, field_name, choices, options = {}, html_options = {}) ⇒ Object

Render a labeled selection field.

  • form_or_object - the form or object

  • field_name - a symbol representing the name of the field

  • choices - an array of select choice options

  • options - a hash of additional options

    • class - additional select classes other than select

    • label - custom field label text

  • html_options - a hash of additional options:



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/bulma_form_rails/field_helpers.rb', line 121

def bulma_select(form_or_object, field_name, choices, options = {}, html_options = {})
  # Prepare parameters.
  prepare_value_class!(options, base_class: 'select is-fullwidth')
  render_parameters = prepare_common_parameters(field_name, form_or_object, options)
  
  # Render the labeled field.
  render layout: 'bulma_form_rails/field', locals: render_parameters.merge(additional_field_label_classes: 'is-normal') do
    render partial: 'bulma_form_rails/select', locals: render_parameters.merge(choices: choices, html_options: html_options)
  end
end

#bulma_text_area(form_or_object, field_name, options = {}) ⇒ Object

Render a labeled text area field.

  • form_or_object - the form or object

  • field_name - a symbol representing the name of the field

  • options - a hash of additional options:

    • class - additional textarea classes other than textarea

    • label - custom field label text

    • rows - number of text rows to be visible

    • cols - number of text columns to be visible



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/bulma_form_rails/field_helpers.rb', line 67

def bulma_text_area(form_or_object, field_name, options = {})
  # Prepare parameters.
  prepare_value_class!(options, base_class: 'textarea')
  render_parameters = prepare_common_parameters(field_name, form_or_object, options)
  
  # Render the labeled field.
  render layout: 'bulma_form_rails/field', locals: render_parameters.merge(additional_field_label_classes: 'is-normal') do
    render partial: 'bulma_form_rails/value', locals: render_parameters.merge(method: :text_area)
  end
end

#bulma_time_select(form_or_object, field_name, options = {}, html_options = {}) ⇒ Object

Render a labeled time selection field.

  • form_or_object - the form or object

  • field_name - a symbol representing the name of the field

  • options - a hash of additional options

  • html_options - a hash of additional options:

    • class - additional select classes other than select

    • label - custom field label text



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/bulma_form_rails/field_helpers.rb', line 157

def bulma_time_select(form_or_object, field_name, options = {}, html_options = {})
  # Prepare parameters.
  prepare_value_class!(options, base_class: 'select is-fullwidth')
  render_parameters = prepare_common_parameters(field_name, form_or_object, options)
  
  # Render the labeled field.
  render layout: 'bulma_form_rails/field', locals: render_parameters.merge(additional_field_label_classes: 'is-normal') do
    render partial: 'bulma_form_rails/time_select', locals: render_parameters.merge(html_options: html_options)
  end
end