button_to(name, options = {}, html_options = {}) public

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. If the HTML button does not work with your layout, you can also consider using the link_to method with the :method modifier as described in the link_to documentation.

The generated FORM element has a class name of button-to to allow styling of the form itself and its children. You can control the form submission and input element behavior using html_options. This method accepts the :method and :confirm modifiers described in the link_to documentation. If no :method modifier is given, it will default to performing a POST operation. You can also disable the button by passing :disabled => true in html_options. If you are using RESTful routes, you can pass the :method to change the HTTP verb used to submit the form.

Options

The options hash accepts the same options at url_for.

There are a few special html_options:

  • :method — specifies the anchor name to be appended to the path.
  • :disabled — specifies the anchor name to be appended to the path.
  • :confirm — This will add a JavaScript confirm prompt with the question specified. If the user accepts, the link is processed normally, otherwise no action is taken.

Examples

  <%= button_to "New", :action => "new" %>
  # => "<form method="post" action="/controller/new" class="button-to">
  #      <div><input value="New" type="submit" /></div>
  #    </form>"

  button_to "Delete Image", { :action => "delete", :id => @image.id },
            :confirm => "Are you sure?", :method => :delete
  # => "<form method="post" action="/images/delete/1" class="button-to">
  #      <div>
  #        <input type="hidden" name="_method" value="delete" />
  #        <input onclick="return confirm('Are you sure?');"
  #              value="Delete" type="submit" />
  #      </div>
  #    </form>"
Show source
Register or log in to add new notes.