Class: Hanami::Helpers::FormHelper::FormBuilder

Inherits:
HtmlHelper::HtmlBuilder show all
Includes:
EscapeHelper
Defined in:
lib/hanami/helpers/form_helper/form_builder.rb

Overview

Form builder

See Also:

Since:

  • 0.2.0

Constant Summary collapse

BROWSER_METHODS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Set of HTTP methods that are understood by web browsers

Since:

  • 0.2.0

%w[GET POST].freeze
EXCLUDED_CSRF_METHODS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Set of HTTP methods that should NOT generate CSRF token

Since:

  • 0.2.0

%w[GET].freeze
CHECKED =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Checked attribute value

See Also:

Since:

  • 0.2.0

'checked'.freeze
SELECTED =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Selected attribute value for option

See Also:

Since:

  • 0.2.0

'selected'.freeze
ACCEPT_SEPARATOR =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Separator for accept attribute of file input

See Also:

  • #file_input

Since:

  • 0.2.0

','.freeze
INPUT_ID_REPLACEMENT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Replacement for input id interpolation

See Also:

  • #_input_id

Since:

  • 0.2.0

'-\k<token>'.freeze
DEFAULT_UNCHECKED_VALUE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Default value for unchecked check box

See Also:

Since:

  • 0.2.0

'0'.freeze
DEFAULT_CHECKED_VALUE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Default value for checked check box

See Also:

Since:

  • 0.2.0

'1'.freeze

Constants inherited from HtmlHelper::HtmlBuilder

HtmlHelper::HtmlBuilder::CONTENT_TAGS, HtmlHelper::HtmlBuilder::EMPTY_TAGS, HtmlHelper::HtmlBuilder::NEWLINE

Instance Method Summary collapse

Methods inherited from HtmlHelper::HtmlBuilder

#empty_tag, #encode, #fragment, #method_missing, #nested?, #resolve, #tag, #text

Constructor Details

#initialize(form, attributes, context, &blk) ⇒ Hanami::Helpers::FormHelper::FormBuilder #initialize(form, attributes, params, &blk) ⇒ Hanami::Helpers::FormHelper::FormBuilder

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Instantiate a form builder

Overloads:

Since:

  • 0.2.0



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 102

def initialize(form, attributes, context = nil, &blk) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  super()

  @context    = context
  @blk        = blk
  @verb       = nil
  @csrf_token = nil

  # Nested form
  if @context.nil? && attributes.is_a?(Values)
    @values      = attributes
    @attributes  = {}
    @name        = form
  else
    @form        = form
    @name        = form.name
    @values      = Values.new(form.values, @context.params)
    @attributes  = attributes
    @verb_method = verb_method
    @csrf_token  = csrf_token
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Hanami::Helpers::HtmlHelper::HtmlBuilder

Instance Method Details

#button(content, attributes = {}) ⇒ Object #button(attributes = {}, &blk) ⇒ Object

Button

Examples:

Basic usage

<%=
  # ...
  button 'Click me'
%>

<!-- output -->
<button>Click me</button>

HTML Attributes

<%=
  # ...
  button 'Click me', class: "btn btn-secondary"
%>

<!-- output -->
<button class="btn btn-secondary">Click me</button>

Block

<%=
  # ...
  button class: "btn btn-secondary" do
    span class: 'oi oi-check'
  end
%>

<!-- output -->
<button class="btn btn-secondary">
  <span class="oi oi-check"></span>
</button>

Overloads:

  • #button(content, attributes = {}) ⇒ Object

    Use string content

    Parameters:

    • content (String) —

      The content

    • attributes (Hash) (defaults to: {}) —

      HTML attributes to pass to the button tag

  • #button(attributes = {}, &blk) ⇒ Object

    Use block content

    Parameters:

    • attributes (Hash) (defaults to: {}) —

      HTML attributes to pass to the button tag

    • blk (Proc) —

      the block content

Since:

  • 1.0.0



1427
1428
1429
1430
1431
1432
1433
1434
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 1427

def button(content, attributes = {}, &blk)
  if content.is_a?(::Hash)
    attributes = content
    content = nil
  end

  super
end

#check_box(name, attributes = {}) ⇒ Object

Check box

It renders a check box input.

When a form is submitted, browsers don’t send the value of unchecked check boxes. If an user unchecks a check box, their browser won’t send the unchecked value. On the server side the corresponding value is missing, so the application will assume that the user action never happened.

To solve this problem the form renders a hidden field with the “unchecked value”. When the user unchecks the input, the browser will ignore it, but it will still send the value of the hidden input. See the examples below.

When editing a resource, the form automatically assigns the checked="checked" attribute.

Examples:

Basic usage

<%=
  check_box :free_shipping
%>

<!-- output -->
<input type="hidden" name="delivery[free_shipping]" value="0">
<input type="checkbox" name="delivery[free_shipping]" id="delivery-free-shipping" value="1">

HTML Attributes

<%=
  check_box :free_shipping, class: "form-check-input"
%>

<!-- output -->
<input type="hidden" name="delivery[free_shipping]" value="0">
<input type="checkbox" name="delivery[free_shipping]" id="delivery-free-shipping" value="1" class="form-check-input">

Specify (un)checked values

<%=
  check_box :free_shipping, checked_value: 'true', unchecked_value: 'false'
%>

<!-- output -->
<input type="hidden" name="delivery[free_shipping]" value="false">
<input type="checkbox" name="delivery[free_shipping]" id="delivery-free-shipping" value="true">

Automatic “checked” attribute

# For this example the params are:
#
#  { delivery: { free_shipping: '1' } }
<%=
  check_box :free_shipping
%>

<!-- output -->
<input type="hidden" name="delivery[free_shipping]" value="0">
<input type="checkbox" name="delivery[free_shipping]" id="delivery-free-shipping" value="1" checked="checked">

Force “checked” attribute

# For this example the params are:
#
#  { delivery: { free_shipping: '0' } }
<%=
  check_box :free_shipping, checked: 'checked'
%>

<!-- output -->
<input type="hidden" name="delivery[free_shipping]" value="0">
<input type="checkbox" name="delivery[free_shipping]" id="delivery-free-shipping" value="1" checked="checked">

Multiple check boxes

<%=
  check_box :languages, name: 'book[languages][]', value: 'italian', id: nil
  check_box :languages, name: 'book[languages][]', value: 'english', id: nil
%>

<!-- output -->
<input type="checkbox" name="book[languages][]" value="italian">
<input type="checkbox" name="book[languages][]" value="english">

Automatic “checked” attribute for multiple check boxes

# For this example the params are:
#
#  { book: { languages: ['italian'] } }
<%=
  check_box :languages, name: 'book[languages][]', value: 'italian', id: nil
  check_box :languages, name: 'book[languages][]', value: 'english', id: nil
%>

<!-- output -->
<input type="checkbox" name="book[languages][]" value="italian" checked="checked">
<input type="checkbox" name="book[languages][]" value="english">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Options Hash (attributes):

  • :checked_value (String) — default: defaults to "1"
  • :unchecked_value (String) — default: defaults to "0"

Since:

  • 0.2.0



507
508
509
510
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 507

def check_box(name, attributes = {})
  _hidden_field_for_check_box(name, attributes)
  input _attributes_for_check_box(name, attributes)
end

#color_field(name, attributes = {}) ⇒ Object

Color input

Examples:

Basic usage

<%=
  # ...
  color_field :background
%>

<!-- output -->
<input type="color" name="user[background]" id="user-background" value="">

HTML Attributes

<%=
  # ...
  color_field :background, class: "form-control"
%>

<!-- output -->
<input type="color" name="user[background]" id="user-background" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 0.2.0



536
537
538
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 536

def color_field(name, attributes = {})
  input _attributes(:color, name, attributes)
end

#datalist(name, values, list, attributes = {}) ⇒ Object

Datalist input

Examples:

Basic Usage

<%=
  # ...
  values = ['Italy', 'United States']
  datalist :stores, values, 'books'
%>

<!-- output -->
<input type="text" name="book[store]" id="book-store" value="" list="books">
<datalist id="books">
  <option value="Italy"></option>
  <option value="United States"></option>
</datalist>

Options As Hash

<%=
  # ...
  values = Hash['Italy' => 'it', 'United States' => 'us']
  datalist :stores, values, 'books'
%>

<!-- output -->
<input type="text" name="book[store]" id="book-store" value="" list="books">
<datalist id="books">
  <option value="Italy">it</option>
  <option value="United States">us</option>
</datalist>

Specify Custom Attributes For Datalist Input

<%=
  # ...
  values = ['Italy', 'United States']
  datalist :stores, values, 'books', datalist: { class: 'form-control' }
%>

<!-- output -->
<input type="text" name="book[store]" id="book-store" value="" list="books">
<datalist id="books" class="form-control">
  <option value="Italy"></option>
  <option value="United States"></option>
</datalist>

Specify Custom Attributes For Options List

<%=
  # ...
  values = ['Italy', 'United States']
  datalist :stores, values, 'books', options: { class: 'form-control' }
%>

<!-- output -->
<input type="text" name="book[store]" id="book-store" value="" list="books">
<datalist id="books">
  <option value="Italy" class="form-control"></option>
  <option value="United States" class="form-control"></option>
</datalist>

Parameters:

  • name (Symbol) —

    the input name

  • values (Array, Hash) —

    a collection that is transformed into <option> tags.

  • list (String) —

    the name of list for the text input, it’s also the id of datalist

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 0.4.0



1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 1367

def datalist(name, values, list, attributes = {}) # rubocop:disable Metrics/MethodLength
  attrs    = attributes.dup
  options  = attrs.delete(:options)  || {}
  datalist = attrs.delete(:datalist) || {}

  attrs[:list]  = list
  datalist[:id] = list

  text_field(name, attrs)
  super(datalist) do
    values.each do |value, content|
      option(content, { value: value }.merge(options))
    end
  end
end

#date_field(name, attributes = {}) ⇒ Object

Date input

Examples:

Basic usage

<%=
  # ...
  date_field :birth_date
%>

<!-- output -->
<input type="date" name="user[birth_date]" id="user-birth-date" value="">

HTML Attributes

<%=
  # ...
  date_field :birth_date, class: "form-control"
%>

<!-- output -->
<input type="date" name="user[birth_date]" id="user-birth-date" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 0.2.0



564
565
566
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 564

def date_field(name, attributes = {})
  input _attributes(:date, name, attributes)
end

#datetime_field(name, attributes = {}) ⇒ Object

Datetime input

Examples:

Basic usage

<%=
  # ...
  datetime_field :delivered_at
%>

<!-- output -->
<input type="datetime" name="delivery[delivered_at]" id="delivery-delivered-at" value="">

HTML Attributes

<%=
  # ...
  datetime_field :delivered_at, class: "form-control"
%>

<!-- output -->
<input type="datetime" name="delivery[delivered_at]" id="delivery-delivered-at" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 0.2.0



592
593
594
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 592

def datetime_field(name, attributes = {})
  input _attributes(:datetime, name, attributes)
end

#datetime_local_field(name, attributes = {}) ⇒ Object

Datetime Local input

Examples:

Basic usage

<%=
  # ...
  datetime_local_field :delivered_at
%>

<!-- output -->
<input type="datetime-local" name="delivery[delivered_at]" id="delivery-delivered-at" value="">

HTML Attributes

<%=
  # ...
  datetime_local_field :delivered_at, class: "form-control"
%>

<!-- output -->
<input type="datetime-local" name="delivery[delivered_at]" id="delivery-delivered-at" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 0.2.0



620
621
622
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 620

def datetime_local_field(name, attributes = {})
  input _attributes(:'datetime-local', name, attributes)
end

#email_field(name, attributes = {}) ⇒ Object

Email input

Examples:

Basic usage

<%=
  # ...
  email_field :email
%>

<!-- output -->
<input type="email" name="user[email]" id="user-email" value="">

HTML Attributes

<%=
  # ...
  email_field :email, class: "form-control"
%>

<!-- output -->
<input type="email" name="user[email]" id="user-email" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 0.2.0



732
733
734
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 732

def email_field(name, attributes = {})
  input _attributes(:email, name, attributes)
end

#fields_for(name, value = nil) {|index| ... } ⇒ Object

Nested fields

The inputs generated by the wrapped block will be prefixed with the given name It supports infinite levels of nesting.

Examples:

Basic usage

<%=
  form_for :delivery, routes.deliveries_path do
    text_field :customer_name

    fields_for :address do
      text_field :street
    end

    submit 'Create'
  end
%>

<!-- output -->
<form action="/deliveries" method="POST" accept-charset="utf-8" id="delivery-form">
  <input type="hidden" name="_csrf_token" value="920cd5bfaecc6e58368950e790f2f7b4e5561eeeab230aa1b7de1b1f40ea7d5d">
  <input type="text" name="delivery[customer_name]" id="delivery-customer-name" value="">
  <input type="text" name="delivery[address][street]" id="delivery-address-street" value="">

  <button type="submit">Create</button>
</form>

Multiple levels of nesting

<%=
  form_for :delivery, routes.deliveries_path do
    text_field :customer_name

    fields_for :address do
      text_field :street

      fields_for :location do
        text_field :city
        text_field :country
      end
    end

    submit 'Create'
  end
%>

<!-- output -->
<form action="/deliveries" method="POST" accept-charset="utf-8" id="delivery-form">
  <input type="hidden" name="_csrf_token" value="920cd5bfaecc6e58368950e790f2f7b4e5561eeeab230aa1b7de1b1f40ea7d5d">
  <input type="text" name="delivery[customer_name]" id="delivery-customer-name" value="">
  <input type="text" name="delivery[address][street]" id="delivery-address-street" value="">
  <input type="text" name="delivery[address][location][city]" id="delivery-address-location-city" value="">
  <input type="text" name="delivery[address][location][country]" id="delivery-address-location-country" value="">

  <button type="submit">Create</button>
</form>

Parameters:

  • name (Symbol) —

    the nested name, it’s used to generate input names, ids, and to lookup params to fill values.

Yields:

  • (index)

Yield Parameters:

  • index (Integer) —

    iterative index (it starts from zero)

Since:

  • 0.2.0



206
207
208
209
210
211
212
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 206

def fields_for(name, value = nil)
  current_name = @name
  @name        = _input_name(name)
  yield(name, value)
ensure
  @name = current_name
end

#fields_for_collection(name) {|index, value| ... } ⇒ Object

Nested collections

Supports nesting for collections, with infinite levels of nesting.

Examples:

Basic usage

<%=
  form_for :delivery, routes.deliveries_path do
    text_field :customer_name

    fields_for_collection :addresses do
      text_field :street
    end

    submit 'Create'
  end
%>

<!-- output -->
<form action="/deliveries" method="POST" accept-charset="utf-8" id="delivery-form">
  <input type="hidden" name="_csrf_token" value="920cd5bfaecc6e58368950e790f2f7b4e5561eeeab230aa1b7de1b1f40ea7d5d">
  <input type="text" name="delivery[customer_name]" id="delivery-customer-name" value="">
  <input type="text" name="delivery[addresses][][street]" id="delivery-address-0-street" value="">
  <input type="text" name="delivery[addresses][][street]" id="delivery-address-1-street" value="">

  <button type="submit">Create</button>
</form>

Yield index and value

<%=
  form_for(:bill, routes.bill_path(id: bill.id), { bill: bill }, method: :patch, class: 'form-horizontal') do
    fieldset do
      legend "Addresses"

      fields_for_collection :addresses do |i, address|
        div class: "form-group" do
          text "Address id: #{address.id}"

          label :street
          input_text :street, class: "form-control", placeholder: "Street", "data-funky": "index-#{i}"
        end
      end

      label :ensure_names
    end

    submit submit_label, class: "btn btn-default"
  end
%>

<!-- output -->
<form action="/bills/1" method="POST" accept-charset="utf-8" id="bill-form" class="form-horizontal">
  <input type="hidden" name="_method" value="PATCH">
  <input type="hidden" name="_csrf_token" value="920cd5bfaecc6e58368950e790f2f7b4e5561eeeab230aa1b7de1b1f40ea7d5d">
  <fieldset>
    <legend>Addresses</legend>

    <div class="form-group">
      Address id: 23
      <label for="bill-addresses-0-street">Street</label>
      <input type="text" name="bill[addresses][][street]" id="bill-addresses-0-street" value="5th Ave" class="form-control" placeholder="Street" data-funky="index-0">
    </div>

    <div class="form-group">
      Address id: 42
      <label for="bill-addresses-1-street">Street</label>
      <input type="text" name="bill[addresses][][street]" id="bill-addresses-1-street" value="4th Ave" class="form-control" placeholder="Street" data-funky="index-1">
    </div>

    <label for="bill-ensure-names">Ensure names</label>
  </fieldset>

  <button type="submit" class="btn btn-default">Update</button>
</form>

Parameters:

  • name (Symbol) —

    the nested name, it’s used to generate input names, ids, and to lookup params to fill values.

Yields:

  • (index, value)

Yield Parameters:

  • index (Integer) —

    iterative index (it starts from zero)

  • value (Object) —

    an item of the collection

Since:

  • 0.2.0



295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 295

def fields_for_collection(name, &block)
  current_name = @name
  base_value = _value(name)
  @name = _input_name(name)

  base_value.each_with_index do |value, index|
    fields_for(index, value, &block)
  end
ensure
  @name = current_name
end

#fieldset(content = nil, attributes = {}) ⇒ Object

Fieldset

Examples:

Basic usage

<%=
  # ...
  fieldset do
    legend "Author"

    fields_for :author do
      label :name
      text_field :name
    end
  end
%>

<!-- output -->
<fieldset>
  <legend>Author</legend>
  <label for="book-author-name">Name</label>
  <input type="text" name="book[author][name]" id="book-author-name" value="">
</fieldset>

Parameters:

  • content (Symbol, String, NilClass) (defaults to: nil) —

    the content

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the label tag

Since:

  • 1.0.0



404
405
406
407
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 404

def fieldset(content = nil, attributes = {})
  # This is here only for documentation purposes
  super
end

#file_field(name, attributes = {}) ⇒ Object

File input

**PLEASE REMEMBER TO ADD enctype: 'multipart/form-data' ATTRIBUTE TO THE FORM**

Examples:

Basic usage

<%=
  # ...
  file_field :avatar
%>

<!-- output -->
<input type="file" name="user[avatar]" id="user-avatar">

HTML Attributes

<%=
  # ...
  file_field :avatar, class: "avatar-upload"
%>

<!-- output -->
<input type="file" name="user[avatar]" id="user-avatar" class="avatar-upload">

Accepted MIME Types

<%=
  # ...
  file_field :resume, accept: 'application/pdf,application/ms-word'
%>

<!-- output -->
<input type="file" name="user[resume]" id="user-resume" accept="application/pdf,application/ms-word">

Accepted MIME Types (as array)

<%=
  # ...
  file_field :resume, accept: ['application/pdf', 'application/ms-word']
%>

<!-- output -->
<input type="file" name="user[resume]" id="user-resume" accept="application/pdf,application/ms-word">

Accepted multiple file upload (as array)

<%=
  # ...
  file_field :resume, multiple: true
%>

<!-- output -->
<input type="file" name="user[resume]" id="user-resume" multiple="multiple">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Options Hash (attributes):

  • :accept (String, Array) —

    Optional set of accepted MIME Types

  • :multiple (TrueClass, FalseClass) —

    Optional, allow multiple file upload

Since:

  • 0.2.0



869
870
871
872
873
874
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 869

def file_field(name, attributes = {})
  attributes[:accept] = Array(attributes[:accept]).join(ACCEPT_SEPARATOR) if attributes.key?(:accept)
  attributes = { type: :file, name: _displayed_input_name(name), id: _input_id(name) }.merge(attributes)

  input(attributes)
end

#hidden_field(name, attributes = {}) ⇒ Object

Hidden input

Examples:

Basic usage

<%=
  # ...
  hidden_field :customer_id
%>

<!-- output -->
<input type="hidden" name="delivery[customer_id]" id="delivery-customer-id" value="">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 0.2.0



810
811
812
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 810

def hidden_field(name, attributes = {})
  input _attributes(:hidden, name, attributes)
end

#image_button(source, attributes = {}) ⇒ Object

Image button

Visual submit button

**Please note:** for security reasons, please use the absolute URL of the image

Examples:

Basic usage

<%=
  # ...
  image_button "https://hanamirb.org/assets/button.png"
%>

<!-- output -->
<input type="image" src="https://hanamirb.org/assets/button.png">

HTML Attributes

<%=
  # ...
  image_button "https://hanamirb.org/assets/button.png", name: "image", width: "50"
%>

<!-- output -->
<input name="image" width="50" type="image" src="https://hanamirb.org/assets/button.png">

Parameters:

  • source (String) —

    The **absolute URL** of the image

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the button tag

Since:

  • 1.0.0



1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 1464

def image_button(source, attributes = {})
  attrs = attributes.dup
  attrs[:type] = :image
  attrs[:src]  = escape_url(source)

  input attrs
end

#label(content, attributes = {}) ⇒ Object

Label tag

The first param content can be a Symbol that represents the target field (Eg. :extended_title), or a String which is used as it is.

Examples:

Basic usage

<%=
  # ...
  label :extended_title
%>

<!-- output -->
<label for="book-extended-title">Extended title</label>

HTML attributes

<%=
  # ...
  label :title, class: "form-label"
%>

<!-- output -->
<label for="book-title" class="form-label">Title</label>

Custom content

<%=
  # ...
  label 'Title', for: :extended_title
%>

<!-- output -->
<label for="book-extended-title">Title</label>

Custom “for” attribute

<%=
  # ...
  label :extended_title, for: 'ext-title'
%>

<!-- output -->
<label for="ext-title">Extended title</label>

Nested fields usage

<%=
  # ...
  fields_for :address do
    label :city
    text_field :city
  end
%>

<!-- output -->
<label for="delivery-address-city">City</label>
<input type="text" name="delivery[address][city] id="delivery-address-city" value="">

Parameters:

  • content (Symbol, String) —

    the field name or a content string

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the label tag

Since:

  • 0.2.0



366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 366

def label(content, attributes = {})
  attributes = { for: _for(content, attributes.delete(:for)) }.merge(attributes)
  content    = case content
               when String, Hanami::Utils::String
                 content
               else
                 Utils::String.capitalize(content)
               end

  super(content, attributes)
end

#month_field(name, attributes = {}) ⇒ Object

Month field

Examples:

Basic usage

<%=
  # ...
  month_field :release_month
%>

<!-- output -->
<input type="month" name="book[release_month]" id="book-release-month" value="">

HTML Attributes

<%=
  # ...
  month_field :release_month, class: "form-control"
%>

<!-- output -->
<input type="month" name="book[release_month]" id="book-release-month" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 1.0.0



676
677
678
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 676

def month_field(name, attributes = {})
  input _attributes(:month, name, attributes)
end

#number_field(name, attributes = {}) ⇒ Object

Number input

You can also make use of the ‘max`, `min`, and `step` attributes for the HTML5 number field.

Examples:

Basic usage

<%=
  # ...
  number_field :percent_read
%>

<!-- output -->
<input type="number" name="book[percent_read]" id="book-percent-read" value="">

Advanced attributes

<%=
  # ...
  number_field :priority, min: 1, max: 10, step: 1
%>

<!-- output -->
<input type="number" name="book[percent_read]" id="book-precent-read" value="" min="1" max="10" step="1">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the number input

Since:

  • 0.2.0



901
902
903
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 901

def number_field(name, attributes = {})
  input _attributes(:number, name, attributes)
end

#password_field(name, attributes = {}) ⇒ Object

Password input

Examples:

Basic usage

<%=
  # ...
  password_field :password
%>

<!-- output -->
<input type="password" name="signup[password]" id="signup-password" value="">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 0.2.0



1126
1127
1128
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 1126

def password_field(name, attributes = {})
  input({ type: :password, name: _displayed_input_name(name), id: _input_id(name), value: nil }.merge(attributes))
end

#radio_button(name, value, attributes = {}) ⇒ Object

Radio input

If request params have a value that corresponds to the given value, it automatically sets the checked attribute. This Hanami::Controller integration happens without any developer intervention.

Examples:

Basic usage

<%=
  # ...
  radio_button :category, 'Fiction'
  radio_button :category, 'Non-Fiction'
%>

<!-- output -->
<input type="radio" name="book[category]" value="Fiction">
<input type="radio" name="book[category]" value="Non-Fiction">

HTML Attributes

<%=
  # ...
  radio_button :category, 'Fiction', class: "form-check"
  radio_button :category, 'Non-Fiction', class: "form-check"
%>

<!-- output -->
<input type="radio" name="book[category]" value="Fiction" class="form-check">
<input type="radio" name="book[category]" value="Non-Fiction" class="form-check">

Automatic checked value

# Given the following params:
#
# book: {
#   category: 'Non-Fiction'
# }

<%=
  # ...
  radio_button :category, 'Fiction'
  radio_button :category, 'Non-Fiction'
%>

<!-- output -->
<input type="radio" name="book[category]" value="Fiction">
<input type="radio" name="book[category]" value="Non-Fiction" checked="checked">

Parameters:

  • name (Symbol) —

    the input name

  • value (String) —

    the input value

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 0.2.0



1105
1106
1107
1108
1109
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 1105

def radio_button(name, value, attributes = {})
  attributes = { type: :radio, name: _displayed_input_name(name), value: value }.merge(attributes)
  attributes[:checked] = CHECKED if _value(name).to_s == value.to_s
  input(attributes)
end

#range_field(name, attributes = {}) ⇒ Object

Range input

You can also make use of the ‘max`, `min`, and `step` attributes for the HTML5 number field.

Examples:

Basic usage

<%=
  # ...
  range_field :discount_percentage
%>

<!-- output -->
<input type="range" name="book[discount_percentage]" id="book-discount-percentage" value="">

Advanced attributes

<%=
  # ...
  range_field :discount_percentage, min: 1, max: 10, step: 1
%>

<!-- output -->
<input type="number" name="book[discount_percentage]" id="book-discount-percentage" value="" min="1" max="10" step="1">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the number input

Since:

  • 1.0.0



932
933
934
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 932

def range_field(name, attributes = {})
  input _attributes(:range, name, attributes)
end

#search_field(name, attributes = {}) ⇒ Object

Search input

Examples:

Basic usage

<%=
  # ...
  search_field :q
%>

<!-- output -->
<input type="search" name="search[q]" id="search-q" value="">

HTML Attributes

<%=
  # ...
  search_field :q, class: "form-control"
%>

<!-- output -->
<input type="search" name="search[q]" id="search-q" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 1.0.0



1051
1052
1053
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 1051

def search_field(name, attributes = {})
  input _attributes(:search, name, attributes)
end

#select(name, values, attributes = {}) ⇒ Object

Select input

Values is used to generate the list of &lt;option&gt; tags, it is an Enumerable of pairs of content (the displayed text) and value (the tag’s attribute), in that respective order (please refer to the examples for more clarity).

If request params have a value that corresponds to one of the given values, it automatically sets the selected attribute on the <option> tag. This Hanami::Controller integration happens without any developer intervention.

Examples:

Basic usage

<%=
  # ...
  values = Hash['Italy' => 'it', 'United States' => 'us']
  select :store, values
%>

<!-- output -->
<select name="book[store]" id="book-store">
  <option value="it">Italy</option>
  <option value="us">United States</option>
</select>

HTML Attributes

<%=
  # ...
  values = Hash['Italy' => 'it', 'United States' => 'us']
  select :store, values, class: "form-control"
%>

<!-- output -->
<select name="book[store]" id="book-store" class="form-control">
  <option value="it">Italy</option>
  <option value="us">United States</option>
</select>

Automatic selected option

# Given the following params:
#
# book: {
#   store: 'it'
# }

<%=
  # ...
  values = Hash['Italy' => 'it', 'United States' => 'us']
  select :store, values
%>

<!-- output -->
<select name="book[store]" id="book-store">
  <option value="it" selected="selected">Italy</option>
  <option value="us">United States</option>
</select>

Prompt option

<%=
  # ...
  values = Hash['Italy' => 'it', 'United States' => 'us']
  select :store, values, options: { prompt: 'Select a store' }
%>

<!-- output -->
<select name="book[store]" id="book-store">
  <option>Select a store</option>
  <option value="it">Italy</option>
  <option value="us">United States</option>
</select>

Selected option

<%=
  # ...
  values = Hash['Italy' => 'it', 'United States' => 'us']
  select :store, values, options: { selected: book.store }
%>

<!-- output -->
<select name="book[store]" id="book-store">
  <option value="it" selected="selected">Italy</option>
  <option value="us">United States</option>
</select>

Prompt option and HTML attributes

<%=
  # ...
  values = Hash['Italy' => 'it', 'United States' => 'us']
  select :store, values, options: { prompt: 'Select a store' }, class: "form-control"
%>

<!-- output -->
<select name="book[store]" id="book-store" class="form-control">
  <option>Select a store</option>
  <option value="it">Italy</option>
  <option value="us">United States</option>
</select>

Multiple select

<%=
  # ...
  values = Hash['Italy' => 'it', 'United States' => 'us']
  select :stores, values, multiple: true
%>

<!-- output -->
<select name="book[store][]" id="book-store" multiple="multiple">
 <option value="it">Italy</option>
  <option value="us">United States</option>
</select>

Multiple select and HTML attributes

<%=
  # ...
  values = Hash['Italy' => 'it', 'United States' => 'us']
  select :stores, values, multiple: true, class: "form-control"
%>

<!-- output -->
<select name="book[store][]" id="book-store" multiple="multiple" class="form-control">
  <option value="it">Italy</option>
  <option value="us">United States</option>
</select>

Array with repeated entries

<%=
  # ...
  values = [['Italy', 'it'],
            ['---', ''],
            ['Afghanistan', 'af'],
            ...
            ['Italy', 'it'],
            ...
            ['Zimbabwe', 'zw']]
  select :stores, values
%>

<!-- output -->
<select name="book[store]" id="book-store">
  <option value="it">Italy</option>
  <option value="">---</option>
  <option value="af">Afghanistan</option>
  ...
  <option value="it">Italy</option>
  ...
  <option value="zw">Zimbabwe</option>
</select>

Parameters:

  • name (Symbol) —

    the input name

  • values (Hash) —

    a Hash to generate <option> tags.

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 0.2.0



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 1281

def select(name, values, attributes = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  options     = attributes.delete(:options) { {} }
  multiple    = attributes[:multiple]
  attributes  = { name: _select_input_name(name, multiple), id: _input_id(name) }.merge(attributes)
  prompt      = options.delete(:prompt)
  selected    = options.delete(:selected)
  input_value = _value(name)

  super(attributes) do
    option(prompt) unless prompt.nil?

    already_selected = nil
    values.each do |content, value|
      if (multiple || !already_selected) && (already_selected = _select_option_selected?(value, selected, input_value, multiple))
        option(content, { value: value, selected: SELECTED }.merge(options))
      else
        option(content, { value: value }.merge(options))
      end
    end
  end
end

#submit(content, attributes = {}) ⇒ Object #submit(attributes = {}, &blk) ⇒ Object

Submit button

Examples:

Basic usage

<%=
  # ...
  submit 'Create'
%>

<!-- output -->
<button type="submit">Create</button>

HTML Attributes

<%=
  # ...
  submit 'Create', class: "btn btn-primary"
%>

<!-- output -->
<button type="submit" class="btn btn-primary">Create</button>

Block

<%=
  # ...
  button class: "btn btn-primary" do
    span class: 'oi oi-check'
  end
%>

<!-- output -->
<button type="submit" class="btn btn-primary">
  <span class="oi oi-check"></span>
</button>

Overloads:

  • #submit(content, attributes = {}) ⇒ Object

    Use string content

    Parameters:

    • content (String) —

      The content

    • attributes (Hash) (defaults to: {}) —

      HTML attributes to pass to the button tag

  • #submit(attributes = {}, &blk) ⇒ Object

    Use block content

    Parameters:

    • attributes (Hash) (defaults to: {}) —

      HTML attributes to pass to the button tag

    • blk (Proc) —

      the block content

Since:

  • 0.2.0



1516
1517
1518
1519
1520
1521
1522
1523
1524
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 1516

def submit(content, attributes = {}, &blk)
  if content.is_a?(::Hash)
    attributes = content
    content = nil
  end

  attributes = { type: :submit }.merge(attributes)
  button(content, attributes, &blk)
end

#tel_field(name, attributes = {}) ⇒ Object

Telephone input

Examples:

Basic usage

<%=
  # ...
  tel_field :telephone
%>

<!-- output -->
<input type="tel" name="user[telephone]" id="user-telephone" value="">

HTML Attributes

<%=
  # ...
  telurl_field :telephone, class: "form-control"
%>

<!-- output -->
<input type="tel" name="user[telephone]" id="user-telephone" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 1.0.0



791
792
793
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 791

def tel_field(name, attributes = {})
  input _attributes(:tel, name, attributes)
end

#text_area(name, content = nil, attributes = {}) ⇒ Object

Text-area input

Examples:

Basic usage

<%=
  # ...
  text_area :hobby
%>

<!-- output -->
<textarea name="user[hobby]" id="user-hobby"></textarea>

Set content

<%=
  # ...
  text_area :hobby, 'Football'
%>

<!-- output -->
<textarea name="user[hobby]" id="user-hobby">Football</textarea>

Set content and HTML attributes

<%=
  # ...
  text_area :hobby, 'Football', class: 'form-control'
%>

<!-- output -->
<textarea name="user[hobby]" id="user-hobby" class="form-control">Football</textarea>

Omit content and specify HTML attributes

<%=
  # ...
  text_area :hobby, class: 'form-control'
%>

<!-- output -->
<textarea name="user[hobby]" id="user-hobby" class="form-control"></textarea>

Force blank value

<%=
  # ...
  text_area :hobby, '', class: 'form-control'
%>

<!-- output -->
<textarea name="user[hobby]" id="user-hobby" class="form-control"></textarea>

Parameters:

  • name (Symbol) —

    the input name

  • content (String) (defaults to: nil) —

    the content of the textarea

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the textarea tag

Since:

  • 0.2.5



988
989
990
991
992
993
994
995
996
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 988

def text_area(name, content = nil, attributes = {})
  if content.respond_to?(:to_hash)
    attributes = content
    content    = nil
  end

  attributes = { name: _displayed_input_name(name), id: _input_id(name) }.merge(attributes)
  textarea(content || _value(name), attributes)
end

#text_field(name, attributes = {}) ⇒ Object Also known as: input_text

Text input

Examples:

Basic usage

<%=
  # ...
  text_field :first_name
%>

<!-- output -->
<input type="text" name="user[first_name]" id="user-first-name" value="">

HTML Attributes

<%=
  # ...
  text_field :first_name, class: "form-control"
%>

<!-- output -->
<input type="text" name="user[first_name]" id="user-first-name" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 0.2.0



1022
1023
1024
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 1022

def text_field(name, attributes = {})
  input _attributes(:text, name, attributes)
end

#time_field(name, attributes = {}) ⇒ Object

Time field

Examples:

Basic usage

<%=
  # ...
  time_field :release_hour
%>

<!-- output -->
<input type="time" name="book[release_hour]" id="book-release-hour" value="">

HTML Attributes

<%=
  # ...
  time_field :release_hour, class: "form-control"
%>

<!-- output -->
<input type="time" name="book[release_hour]" id="book-release-hour" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 1.0.0



648
649
650
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 648

def time_field(name, attributes = {})
  input _attributes(:time, name, attributes)
end

#to_s ⇒ Hanami::Utils::Escape::SafeString

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Resolves all the nodes and generates the markup

Returns:

  • (Hanami::Utils::Escape::SafeString) —

    the output

See Also:

Since:

  • 0.2.0



134
135
136
137
138
139
140
141
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 134

def to_s
  if toplevel?
    _method_override!
    form(@blk, @attributes)
  end

  super
end

#url_field(name, attributes = {}) ⇒ Object

URL input

Examples:

Basic usage

<%=
  # ...
  url_field :website
%>

<!-- output -->
<input type="url" name="user[website]" id="user-website" value="">

HTML Attributes

<%=
  # ...
  url_field :website, class: "form-control"
%>

<!-- output -->
<input type="url" name="user[website]" id="user-website" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 1.0.0



760
761
762
763
764
765
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 760

def url_field(name, attributes = {})
  attrs         = attributes.dup
  attrs[:value] = escape_url(attrs.fetch(:value) { _value(name) })

  input _attributes(:url, name, attrs)
end

#week_field(name, attributes = {}) ⇒ Object

Week field

Examples:

Basic usage

<%=
  # ...
  week_field :release_week
%>

<!-- output -->
<input type="week" name="book[release_week]" id="book-release-week" value="">

HTML Attributes

<%=
  # ...
  week_field :release_week, class: "form-control"
%>

<!-- output -->
<input type="week" name="book[release_week]" id="book-release-week" value="" class="form-control">

Parameters:

  • name (Symbol) —

    the input name

  • attributes (Hash) (defaults to: {}) —

    HTML attributes to pass to the input tag

Since:

  • 1.0.0



704
705
706
 
# File 'lib/hanami/helpers/form_helper/form_builder.rb', line 704

def week_field(name, attributes = {})
  input _attributes(:week, name, attributes)
end