method

image_submit_tag

v4.0.2 - Show latest stable - 2 notes - Class: ActionView::Helpers::FormTagHelper

image_submit_tag(source, options = {}) public

Displays an image which when clicked will submit the form.

source is passed to AssetTagHelper#path_to_image

Options

:data - This option can be used to add custom data attributes.
:disabled - If set to true, the user will not be able to use this input.
Any other key creates standard HTML options for the tag.

Data attributes

confirm: 'question?' - This will add a JavaScript confirm prompt with the question specified. If the user accepts, the form is processed normally, otherwise no action is taken.

Examples

image_submit_tag("login.png")
# => <input alt="Login" src="/images/login.png" type="image" />

image_submit_tag("purchase.png", disabled: true)
# => <input alt="Purchase" disabled="disabled" src="/images/purchase.png" type="image" />

image_submit_tag("search.png", class: 'search_button', alt: 'Find')
# => <input alt="Find" class="search_button" src="/images/search.png" type="image" />

image_submit_tag("agree.png", disabled: true, class: "agree_disagree_button")
# => <input alt="Agree" class="agree_disagree_button" disabled="disabled" src="/images/agree.png" type="image" />

image_submit_tag("save.png", data: { confirm: "Are you sure?" })
# => <input alt="Save" src="/images/save.png" data-confirm="Are you sure?" type="image" />

Show source

# File actionpack/lib/action_view/helpers/form_tag_helper.rb, line 542
      def image_submit_tag(source, options = {})
        options = options.stringify_keys

        if confirm = options.delete("confirm")
          message = ":confirm option is deprecated and will be removed from Rails 4.1. "                      "Use 'data: { confirm: \'Text\' }' instead'."
          ActiveSupport::Deprecation.warn message

          options["data-confirm"] = confirm
        end

        tag :input, { "alt" => image_alt(source), "type" => "image", "src" => path_to_image(source) }.update(options)
      end

October 29, 2008

3 thanks

A work-around for adding confirmation to image_submit_tag

Sometimes you may want to add a confirmation to image submit tags but this function does not allow it. To get over this limitation use a normal submit tag and set the src and type properties (set type to “image”)

Code example

submit_tag “Delete”, :confirm => “Are you sure?”, :src => “/images/trash.png”, :type => “image” %>

January 24, 2009

0 thanks

Adding "alt" text to the image tag

<%= image_submit_tag (“create.gif”, :alt => “Create new entity”) %>

This way when the images are disabled or don’t work you get the nice custom text instead of the standard one. Pretty useful.