Module: ActionView::Helpers::NavigationHelper

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `::ActionDispatch::DebugView`, `::ActionView::Base`, `::ActionView::Helpers`, `::ActionView::TestCase`, `::ActionView::TestCase::Behavior`
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::ActiveSupport::Concern`
Instance Chain: self, `ContentExfiltrationPreventionHelper`, `UrlHelper`, `TagHelper`, `OutputSafetyHelper`, `CaptureHelper`
Defined in:	actionview/lib/action_view/helpers/navigation_helper.rb

Overview

Action View Navigation Helpers

Provides a set of methods for making links, buttons, and forms that depend on the routing subsystem (see ::ActionDispatch::Routing). This allows you to use the same format for links in views and controllers.

Constant Summary

BUTTON_TAG_METHOD_VERBS =
# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 17
```
%w{patch put delete}.freeze
```

STRINGIFIED_COMMON_METHODS =
# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 563

{
  get:    "get",
  delete: "delete",
  patch:  "patch",
  post:   "post",
  put:    "put",
}.freeze

`TagHelper` - Included

ARIA_PREFIXES, BOOLEAN_ATTRIBUTES, CLASS_PREFIXES, DATA_PREFIXES, PRE_CONTENT_STRINGS, TAG_TYPES

`ContentExfiltrationPreventionHelper` - Included

CLOSE_CDATA_COMMENT, CLOSE_FORM_TAG, CLOSE_OPTION_TAG, CLOSE_QUOTES_COMMENT, CONTENT_EXFILTRATION_PREVENTION_MARKUP

Class Attribute Summary

.button_to_generates_button_tag (also: #button_to_generates_button_tag) rw

Class Method Summary

`::ActiveSupport::Concern` - Extended

class_methods	Define class methods from given block.
included	Evaluate given block in context of base class, so that you can write class macros here.
prepended	Evaluate given block in context of base class, so that you can write class macros here.
append_features, prepend_features

Instance Attribute Summary

#button_to_generates_button_tag rw

`ContentExfiltrationPreventionHelper` - Included

#prepend_content_exfiltration_prevention

Instance Method Summary

#button_to(name = nil, options = nil, html_options = nil, &block)

Generates a form containing a single button that submits to the URL created by the set of options.
#current_page?(options = nil, check_parameters: false, method: :get, **options_as_kwargs) ⇒ Boolean

True if the current request URI was generated by the given options.
#link_to(name = nil, options = nil, html_options = nil, &block)

Creates an anchor element of the given name using a URL created by the set of options.
#link_to_if(condition, name, options = {}, html_options = {}, &block)

Creates a link tag of the given name using a URL created by the set of options if condition is true, otherwise only the name is returned.
#link_to_unless(condition, name, options = {}, html_options = {}, &block)

Creates a link tag of the given name using a URL created by the set of options unless condition is true, in which case only the name is returned.
#link_to_unless_current(name, options = {}, html_options = {}, &block)

Creates a link tag of the given name using a URL created by the set of options unless the current request URI is the same as the links, in which case only the name is returned (or the given block is yielded, if one exists).
#add_method_to_attributes!(html_options, method) private
#convert_options_to_data_attributes(options, html_options) private
#link_to_remote_options?(options) ⇒ Boolean private
#method_for_options(options) private
#method_not_get_method?(method) ⇒ Boolean private
#method_tag(method) private
#remove_trailing_slash!(url_string) private
#to_form_params(attribute, namespace = nil) private

Returns an array of hashes each containing :name and :value keys suitable for use as the names and values of form input fields:
#token_tag(token = nil, form_options: {}) private
#url_target(name, options) private

`ContentExfiltrationPreventionHelper` - Included

#prevent_content_exfiltration

`UrlHelper` - Included

#mail_to	Creates a mailto link tag to the specified `email_address`, which is also used as the name of the link unless `name` is specified.
#phone_to	Creates a TEL anchor link tag to the specified `phone_number`.
#sms_to	Creates an SMS anchor link tag to the specified `phone_number`.
#url_for	Basic implementation of url_for to allow use helpers without routes existence.
#_back_url, #_filtered_referrer

`TagHelper` - Included

#cdata_section	Returns a CDATA section with the given `content`.
#class_names	Alias for TagHelper#token_list.
#content_tag	Returns an HTML block tag of type `name` surrounding the `content`.
#escape_once	Returns an escaped version of `html` without affecting existing escaped entities.
#tag	Modern syntax.
#token_list	Returns a string of tokens built from `args`.
#build_tag_values, #ensure_valid_html5_tag_name, #tag_builder

`OutputSafetyHelper` - Included

#raw	This method outputs without escaping a string.
#safe_join	This method returns an HTML safe string similar to what `Array#join` would return.
#to_sentence	Converts the array to a comma-separated sentence where the last element is joined by the connector word.

`CaptureHelper` - Included

#capture	The capture method extracts part of a template as a string object.
#content_for	Calling `content_for` stores a block of markup in an identifier for later use.
#content_for?	`content_for?` checks whether any content has been captured yet using `content_for`.
#provide	The same as `content_for` but when used with streaming flushes straight back to the layout.
#with_output_buffer	Use an alternate output buffer for the duration of the block.

Class Attribute Details

.button_to_generates_button_tag (rw) Also known as: #button_to_generates_button_tag

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 28


mattr_accessor :button_to_generates_button_tag, default: false

Instance Attribute Details

#button_to_generates_button_tag (rw)

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 28


mattr_accessor :button_to_generates_button_tag, default: false

Instance Method Details

#add_method_to_attributes!(html_options, method) (private)

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 542


def add_method_to_attributes!(html_options, method)
  if method_not_get_method?(method) && !html_options["rel"].to_s.include?("nofollow")
    if html_options["rel"].blank?
      html_options["rel"] = "nofollow"
    else
      html_options["rel"] = "#{html_options["rel"]} nofollow"
    end
  end
  html_options["data-method"] = method
end

#button_to(name = nil, options = nil, html_options = nil, &block)

Generates a form containing a single button that submits to the URL created by the set of options. This is the safest method to ensure links that cause changes to your data are not triggered by search bots or accelerators.

You can control the form and button behavior with html_options. Most values in html_options are passed through to the button element. For example, passing a :class option within html_options will set the class attribute of the button element.

The class attribute of the form element can be set by passing a :form_class option within html_options. It defaults to "button_to" to allow styling of the form and its children.

The form submits a POST request by default if the object is not persisted; conversely, if the object is persisted, it will submit a PATCH request. To specify a different HTTP verb use the :method option within html_options.

If the HTML button generated from button_to does not work with your layout, you can consider using the #link_to method with the data-turbo-method attribute as described in the #link_to documentation.

Options

The options hash accepts the same options as url_for. To generate a

element without an [action] attribute, pass false:

<%= button_to "New", false %>
# => "<form method="post" class="button_to">
#      <button type="submit">New</button>
#      <input name="authenticity_token" type="hidden" value="10f2163b45388899ad4d5ae948988266befcb6c3d1b2451cf657a0c293d605a6"/>
#    </form>"

Most values in html_options are passed through to the button element, but there are a few special options:

:method - Symbol of HTTP verb. Supported verbs are :post, :get, :delete, :patch, and :put. By default it will be :post.
:disabled - If set to true, it will generate a disabled button.
:data - This option can be used to add custom data attributes.
:form - This hash will be form attributes
:form_class - This controls the class of the form within which the submit button will be placed
:params - Hash of parameters to be rendered as hidden fields within the form.

Examples

<%= button_to "New", action: "new" %>

=> "

"

<%= button_to "New", new_article_path %>
# => "<form method="post" action="/articles/new" class="button_to">
#      <button type="submit">New</button>
#      <input name="authenticity_token" type="hidden" value="10f2163b45388899ad4d5ae948988266befcb6c3d1b2451cf657a0c293d605a6" autocomplete="off"/>
#    </form>"

<%= button_to "New", new_article_path, params: { time: Time.now  } %>
# => "<form method="post" action="/articles/new" class="button_to">
#      <button type="submit">New</button>
#      <input name="authenticity_token" type="hidden" value="10f2163b45388899ad4d5ae948988266befcb6c3d1b2451cf657a0c293d605a6"/>
#      <input type="hidden" name="time" value="2021-04-08 14:06:09 -0500" autocomplete="off">
#    </form>"

<%= button_to [:make_happy, @user] do %>
Make happy <strong><%= @user.name %></strong>
<% end %>
# => "<form method="post" action="/users/1/make_happy" class="button_to">
#      <button type="submit">
#        Make happy <strong><%= @user.name %></strong>
#      </button>
#      <input name="authenticity_token" type="hidden" value="10f2163b45388899ad4d5ae948988266befcb6c3d1b2451cf657a0c293d605a6"  autocomplete="off"/>
#    </form>"

<%= button_to "New", { action: "new" }, form_class: "new-thing" %>
# => "<form method="post" action="/controller/new" class="new-thing">
#      <button type="submit">New</button>
#      <input name="authenticity_token" type="hidden" value="10f2163b45388899ad4d5ae948988266befcb6c3d1b2451cf657a0c293d605a6"  autocomplete="off"/>
#    </form>"

<%= button_to "Create", { action: "create" }, form: { "data-type" => "json" } %>
# => "<form method="post" action="/images/create" class="button_to" data-type="json">
#      <button type="submit">Create</button>
#      <input name="authenticity_token" type="hidden" value="10f2163b45388899ad4d5ae948988266befcb6c3d1b2451cf657a0c293d605a6"  autocomplete="off"/>
#    </form>"

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 358


def button_to(name = nil, options = nil, html_options = nil, &block)
  html_options, options = options, name if block_given?
  html_options ||= {}
  html_options = html_options.stringify_keys

  url =
    case options
    when FalseClass then nil
    else url_for(options)
    end

  remote = html_options.delete("remote")
  params = html_options.delete("params")

  authenticity_token = html_options.delete("authenticity_token")

  method     = (html_options.delete("method").presence || method_for_options(options)).to_s
  method_tag = BUTTON_TAG_METHOD_VERBS.include?(method) ? method_tag(method) : "".html_safe

  form_method  = method == "get" ? "get" : "post"
  form_options = html_options.delete("form") || {}
  form_options[:class] ||= html_options.delete("form_class") || "button_to"
  form_options[:method] = form_method
  form_options[:action] = url
  form_options[:'data-remote'] = true if remote

  request_token_tag = if form_method == "post"
    request_method = method.empty? ? "post" : method
    token_tag(authenticity_token, form_options: { action: url, method: request_method })
  else
    ""
  end

  html_options = convert_options_to_data_attributes(options, html_options)
  html_options["type"] = "submit"

  button = if block_given?
    content_tag("button", html_options, &block)
  elsif button_to_generates_button_tag
    content_tag("button", name || url, html_options, &block)
  else
    html_options["value"] = name || url
    tag("input", html_options)
  end

  inner_tags = method_tag.safe_concat(button).safe_concat(request_token_tag)
  if params
    to_form_params(params).each do |param|
      options = { type: "hidden", name: param[:name], value: param[:value] }
      options[:autocomplete] = "off" unless ActionView::Base.remove_hidden_field_autocomplete
      inner_tags.safe_concat tag(:input, **options)
    end
  end
  html = content_tag("form", inner_tags, form_options)
  prevent_content_exfiltration(html)
end

#convert_options_to_data_attributes(options, html_options) (private)

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 513


def convert_options_to_data_attributes(options, html_options)
  if html_options
    html_options = html_options.stringify_keys
    html_options["data-remote"] = "true" if link_to_remote_options?(options) || link_to_remote_options?(html_options)

    method = html_options.delete("method")

    add_method_to_attributes!(html_options, method) if method

    html_options
  else
    link_to_remote_options?(options) ? { "data-remote" => "true" } : {}
  end
end

#current_page?(options = nil, check_parameters: false, method: :get, **options_as_kwargs) ⇒ `Boolean`

True if the current request URI was generated by the given options.

Examples

Let's say we're in the http://www.example.com/shop/checkout?order=desc&page=1 action.

current_page?(action: 'process')
# => false

current_page?(action: 'checkout')
# => true

current_page?(controller: 'library', action: 'checkout')
# => false

current_page?(controller: 'shop', action: 'checkout')
# => true

current_page?(controller: 'shop', action: 'checkout', order: 'asc')
# => false

current_page?(controller: 'shop', action: 'checkout', order: 'desc', page: '1')
# => true

current_page?(controller: 'shop', action: 'checkout', order: 'desc', page: '2')
# => false

current_page?('http://www.example.com/shop/checkout')
# => true

current_page?('http://www.example.com/shop/checkout', check_parameters: true)
# => false

current_page?('/shop/checkout')
# => true

current_page?('http://www.example.com/shop/checkout?order=desc&page=1')
# => true

Different actions may share the same URL path but have a different HTTP method. Let's say we sent a POST to http://www.example.com/products and rendered a validation error.

current_page?(controller: 'product', action: 'index')
# => false

current_page?(controller: 'product', action: 'create')
# => false

current_page?(controller: 'product', action: 'create', method: :post)
# => true

current_page?(controller: 'product', action: 'index', method: [:get, :post])
# => true

We can also pass in the symbol arguments instead of strings.

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 85


def current_page?(options = nil, check_parameters: false, method: :get, **options_as_kwargs)
  unless request
    raise "You cannot use helpers that need to determine the current " \
          "page unless your view context provides a Request object " \
          "in a #request method"
  end

  if options.is_a?(Hash)
    check_parameters = options.delete(:check_parameters) { check_parameters }
    method = options.delete(:method) { method }
  else
    options ||= options_as_kwargs
  end

  method_matches = case method
  when :get
    request.get? || request.head?
  when Array
    method.include?(request.method_symbol) || (method.include?(:get) && request.head?)
  else
    method == request.method_symbol
  end
  return false unless method_matches

  url_string = URI::RFC2396_PARSER.unescape(url_for(options)).force_encoding(Encoding::BINARY)

  # We ignore any extra parameters in the request_uri if the
  # submitted URL doesn't have any either. This lets the function
  # work with things like ?order=asc
  # the behavior can be disabled with check_parameters: true
  request_uri = url_string.index("?") || check_parameters ? request.fullpath : request.path
  request_uri = URI::RFC2396_PARSER.unescape(request_uri).force_encoding(Encoding::BINARY)

  if %r{^\w+://}.match?(url_string)
    request_uri = +"#{request.protocol}#{request.host_with_port}#{request_uri}"
  end

  remove_trailing_slash!(url_string)
  remove_trailing_slash!(request_uri)

  url_string == request_uri
end

#link_to(name = nil, options = nil, html_options = nil, &block)

Creates an anchor element of the given name using a URL created by the set of options. See the valid options in the documentation for url_for. It's also possible to pass a String instead of an options hash, which generates an anchor element that uses the value of the String as the href for the link. Using a :back Symbol instead of an options hash will generate a link to the referrer (a JavaScript back link will be used in place of a referrer if none exists). If nil is passed as the name the value of the link itself will become the name.

Signatures

link_to(body, url, html_options = {})
# url is a String; you can use URL helpers like
# posts_path

link_to(body, url_options = {}, html_options = {})
# url_options, except :method, is passed to url_for

link_to(options = {}, html_options = {}) do
# name
end

link_to(url, html_options = {}) do
# name
end

link_to(active_record_model)

Options

:data - This option can be used to add custom data attributes.

Examples

Because it relies on url_for, link_to supports both older-style controller/action/id arguments and newer RESTful routes. Current Rails style favors RESTful routes whenever possible, so base your application on resources and use

link_to "Profile", profile_path(@profile)
# => <a href="/profiles/1">Profile</a>

or the even pithier

link_to "Profile", @profile
# => <a href="/profiles/1">Profile</a>

in place of the older more verbose, non-resource-oriented

link_to "Profile", controller: "profiles", action: "show", id: @profile
# => <a href="/profiles/show/1">Profile</a>

Similarly,

link_to "Profiles", profiles_path
# => <a href="/profiles">Profiles</a>

is better than

link_to "Profiles", controller: "profiles"
# => <a href="/profiles">Profiles</a>

When name is nil the href is presented instead

link_to nil, "http://example.com"
# => <a href="http://www.example.com">http://www.example.com</a>

More concise yet, when name is an Active Record model that defines a to_s method returning a default value or a model instance attribute

link_to @profile
# => <a href="http://www.example.com/profiles/1">Eileen</a>

You can use a block as well if your link target is hard to fit into the name parameter. ::ERB example:

<%= link_to(@profile) do %>
<strong><%= @profile.name %></strong> -- <span>Check it out!</span>
<% end %>
# => <a href="/profiles/1">
     <strong>David</strong> -- <span>Check it out!</span>
   </a>

Classes and ids for CSS are easy to produce:

link_to "Articles", articles_path, id: "news", class: "article"
# => <a href="/articles" class="article" id="news">Articles</a>

Be careful when using the older argument style, as an extra literal hash is needed:

link_to "Articles", { controller: "articles" }, id: "news", class: "article"
# => <a href="/articles" class="article" id="news">Articles</a>

Leaving the hash off gives the wrong link:

link_to "WRONG!", controller: "articles", id: "news", class: "article"
# => <a href="/articles/index/news?class=article">WRONG!</a>

link_to can also produce links with anchors or query strings:

link_to "Comment wall", profile_path(@profile, anchor: "wall")
# => <a href="/profiles/1#wall">Comment wall</a>

link_to "Ruby on Rails search", controller: "searches", query: "ruby on rails"
# => <a href="/searches?query=rubyonrails">Ruby on Rails search</a>

link_to "Nonsense search", searches_path(foo: "bar", baz: "quux")
# => <a href="/searches?foo=bar&baz=quux">Nonsense search</a>

You can set any link attributes such as target, rel, type:

link_to "External link", "http://www.rubyonrails.org/", target: "_blank", rel: "nofollow"
# => <a href="http://www.rubyonrails.org/" target="_blank" rel="nofollow">External link</a>

Turbo

::Rails 7 ships with Turbo enabled by default. Turbo provides the following :data options:

turbo_method: symbol of HTTP verb - Performs a Turbo link visit with the given HTTP verb. Forms are recommended when performing non-+GET+ requests. Only use data-turbo-method where a form is not possible.
turbo_confirm: "question?" - Adds a confirmation dialog to the link with the given value.

Consult the Turbo Handbook for more information on the options above.

Examples

link_to "Delete profile", @profile, data: { turbo_method: :delete }
# => <a href="/profiles/1" data-turbo-method="delete">Delete profile</a>

link_to "Visit Other Site", "https://rubyonrails.org/", data: { turbo_confirm: "Are you sure?" }
# => <a href="https://rubyonrails.org/" data-turbo-confirm="Are you sure?">Visit Other Site</a>

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 260


def link_to(name = nil, options = nil, html_options = nil, &block)
  html_options, options, name = options, name, block if block_given?
  options ||= {}

  html_options = convert_options_to_data_attributes(options, html_options)

  url = url_target(name, options)
  html_options["href"] ||= url

  content_tag("a", name || url, html_options, &block)
end

#link_to_if(condition, name, options = {}, html_options = {}, &block)

Creates a link tag of the given name using a URL created by the set of options if condition is true, otherwise only the name is returned. To specialize the default behavior, you can pass a block that accepts the name or the full argument list for link_to_if.

Examples

<%= link_to_if(@current_user.nil?, "Login", { controller: "sessions", action: "new" }) %>

If the user isn't logged in...

=> Login

<%=
 link_to_if(@current_user.nil?, "Login", { controller: "sessions", action: "new" }) do
   link_to(@current_user.login, { controller: "accounts", action: "show", id: @current_user })
 end
%>
# If the user isn't logged in...
# => <a href="/sessions/new/">Login</a>
# If they are logged in...
# => <a href="/accounts/show/3">my_username</a>

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 500


def link_to_if(condition, name, options = {}, html_options = {}, &block)
  if condition
    link_to(name, options, html_options)
  else
    if block_given?
      block.arity <= 1 ? capture(name, &block) : capture(name, options, html_options, &block)
    else
      ERB::Util.html_escape(name)
    end
  end
end

#link_to_remote_options?(options) ⇒ `Boolean` (private)

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 536


def link_to_remote_options?(options)
  if options.is_a?(Hash)
    options.delete("remote") || options.delete(:remote)
  end
end

#link_to_unless(condition, name, options = {}, html_options = {}, &block)

Creates a link tag of the given name using a URL created by the set of options unless condition is true, in which case only the name is returned. To specialize the default behavior (i.e., show a login link rather than just the plaintext link text), you can pass a block that accepts the name or the full argument list for link_to_unless.

Examples

<%= link_to_unless(@current_user.nil?, "Reply", { action: "reply" }) %>

If the user is logged in...

=> Reply

<%=
 link_to_unless(@current_user.nil?, "Reply", { action: "reply" }) do |name|
   link_to(name, { controller: "accounts", action: "signup" })
 end
%>
# If the user is logged in...
# => <a href="/controller/reply/">Reply</a>
# If not...
# => <a href="/accounts/signup">Reply</a>

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 477


def link_to_unless(condition, name, options = {}, html_options = {}, &block)
  link_to_if !condition, name, options, html_options, &block
end

#link_to_unless_current(name, options = {}, html_options = {}, &block)

Creates a link tag of the given name using a URL created by the set of options unless the current request URI is the same as the links, in which case only the name is returned (or the given block is yielded, if one exists). You can give link_to_unless_current a block which will specialize the default behavior (e.g., show a "Start Here" link rather than the link's text).

Examples

Let's say you have a navigation menu...

If in the "about" action, it will render...

...but if in the "index" action, it will render:

The implicit block given to link_to_unless_current is evaluated if the current action is the action given. So, if we had a comments page and wanted to render a "Go Back" link instead of a link to the comments page, we could do something like this...

<%=
   link_to_unless_current("Comment", { controller: "comments", action: "new" }) do
      link_to("Go back", { controller: "posts", action: "index" })
   end
%>

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 453


def link_to_unless_current(name, options = {}, html_options = {}, &block)
  link_to_unless current_page?(options), name, options, html_options, &block
end

#method_for_options(options) (private)

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 553


def method_for_options(options)
  if options.is_a?(Array)
    method_for_options(options.last)
  elsif options.respond_to?(:persisted?)
    options.persisted? ? :patch : :post
  elsif options.respond_to?(:to_model)
    method_for_options(options.to_model)
  end
end

#method_not_get_method?(method) ⇒ `Boolean` (private)

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 571


def method_not_get_method?(method)
  return false unless method
  (STRINGIFIED_COMMON_METHODS[method] || method.to_s.downcase) != "get"
end

#method_tag(method) (private)

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 592


def method_tag(method)
  options = { type: "hidden", name: "_method", value: method.to_s }
  options[:autocomplete] = "off" unless ActionView::Base.remove_hidden_field_autocomplete
  tag("input", **options)
end

#remove_trailing_slash!(url_string) (private)

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 640


def remove_trailing_slash!(url_string)
  trailing_index = (url_string.index("?") || 0) - 1
  url_string[trailing_index] = "" if url_string[trailing_index] == "/"
end

#to_form_params(attribute, namespace = nil) (private)

Returns an array of hashes each containing :name and :value keys suitable for use as the names and values of form input fields:

to_form_params(name: 'David', nationality: 'Danish')
# => [{name: 'name', value: 'David'}, {name: 'nationality', value: 'Danish'}]

to_form_params(country: { name: 'Denmark' })
# => [{name: 'country[name]', value: 'Denmark'}]

to_form_params(countries: ['Denmark', 'Sweden']})
# => [{name: 'countries[]', value: 'Denmark'}, {name: 'countries[]', value: 'Sweden'}]

An optional namespace can be passed to enclose key names:

to_form_params({ name: 'Denmark' }, 'country')
# => [{name: 'country[name]', value: 'Denmark'}]

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 614


def to_form_params(attribute, namespace = nil)
  attribute = if attribute.respond_to?(:permitted?)
    attribute.to_h
  else
    attribute
  end

  params = []
  case attribute
  when Hash
    attribute.each do |key, value|
      prefix = namespace ? "#{namespace}[#{key}]" : key
      params.push(*to_form_params(value, prefix))
    end
  when Array
    array_prefix = "#{namespace}[]"
    attribute.each do |value|
      params.push(*to_form_params(value, array_prefix))
    end
  else
    params << { name: namespace.to_s, value: attribute.to_param }
  end

  params.sort_by { |pair| pair[:name] }
end

#token_tag(token = nil, form_options: {}) (private)

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 576


def token_tag(token = nil, form_options: {})
  if token != false && defined?(protect_against_forgery?) && protect_against_forgery?
    token =
      if token == true || token.nil?
        form_authenticity_token(form_options: form_options.merge(authenticity_token: token))
      else
        token
      end
    options = { type: "hidden", name: request_forgery_protection_token.to_s, value: token }
    options[:autocomplete] = "off" unless ActionView::Base.remove_hidden_field_autocomplete
    tag(:input, **options)
  else
    ""
  end
end

#url_target(name, options) (private)

[ GitHub ]

# File 'actionview/lib/action_view/helpers/navigation_helper.rb', line 528


def url_target(name, options)
  if name.respond_to?(:model_name) && options.is_a?(Hash) && options.empty?
    url_for(name)
  else
    url_for(options)
  end
end

Module: ActionView::Helpers::NavigationHelper

Overview

Action View Navigation Helpers

Constant Summary

TagHelper - Included

ContentExfiltrationPreventionHelper - Included

Class Attribute Summary

Class Method Summary

::ActiveSupport::Concern - Extended

Instance Attribute Summary

ContentExfiltrationPreventionHelper - Included

Instance Method Summary

ContentExfiltrationPreventionHelper - Included

UrlHelper - Included

TagHelper - Included

OutputSafetyHelper - Included

CaptureHelper - Included

Class Attribute Details

.button_to_generates_button_tag (rw) Also known as: #button_to_generates_button_tag

Instance Attribute Details

#button_to_generates_button_tag (rw)

Instance Method Details

#add_method_to_attributes!(html_options, method) (private)

#button_to(name = nil, options = nil, html_options = nil, &block)

Options

Examples

=> "

New

"

#convert_options_to_data_attributes(options, html_options) (private)

#current_page?(options = nil, check_parameters: false, method: :get, **options_as_kwargs) ⇒ Boolean

Examples

#link_to(name = nil, options = nil, html_options = nil, &block)

Signatures

Options

Examples

Turbo

Examples

#link_to_if(condition, name, options = {}, html_options = {}, &block)

Examples

If the user isn't logged in...

=> Login

#link_to_remote_options?(options) ⇒ Boolean (private)

#link_to_unless(condition, name, options = {}, html_options = {}, &block)

Examples

If the user is logged in...

=> Reply

#link_to_unless_current(name, options = {}, html_options = {}, &block)

Examples

#method_for_options(options) (private)

#method_not_get_method?(method) ⇒ Boolean (private)

#method_tag(method) (private)

#remove_trailing_slash!(url_string) (private)

#to_form_params(attribute, namespace = nil) (private)

#token_tag(token = nil, form_options: {}) (private)

#url_target(name, options) (private)

`TagHelper` - Included

`ContentExfiltrationPreventionHelper` - Included

`::ActiveSupport::Concern` - Extended

`ContentExfiltrationPreventionHelper` - Included

`ContentExfiltrationPreventionHelper` - Included

`UrlHelper` - Included

`TagHelper` - Included

`OutputSafetyHelper` - Included

`CaptureHelper` - Included

#current_page?(options = nil, check_parameters: false, method: :get, **options_as_kwargs) ⇒ `Boolean`

#link_to_remote_options?(options) ⇒ `Boolean` (private)

#method_not_get_method?(method) ⇒ `Boolean` (private)