Module: ActionView::Helpers::AssetTagHelper
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 | |
Instance Chain:
|
|
Defined in: | actionview/lib/action_view/helpers/asset_tag_helper.rb |
Overview
Action View Asset Tag Helpers
This module provides methods for generating HTML that links views to assets such as images, JavaScripts, stylesheets, and feeds. These methods do not verify the assets exist before linking to them:
image_tag("rails.png")
# => <img src="/assets/rails.png" />
stylesheet_link_tag("application")
# => <link href="/assets/application.css?body=1" rel="stylesheet" />
Constant Summary
AssetUrlHelper
- Included
ASSET_EXTENSIONS, ASSET_PUBLIC_DIRECTORIES, URI_REGEXP
TagHelper
- Included
ARIA_PREFIXES, BOOLEAN_ATTRIBUTES, DATA_PREFIXES, PRE_CONTENT_STRINGS, TAG_TYPES
Class Attribute Summary
- .apply_stylesheet_media_default (also: #apply_stylesheet_media_default) rw
- .image_decoding (also: #image_decoding) rw
- .image_loading (also: #image_loading) rw
- .preload_links_header (also: #preload_links_header) rw
Instance Attribute Summary
Instance Method Summary
-
#audio_tag(*sources)
Returns an HTML audio tag for the
sources
. -
#auto_discovery_link_tag(type = :rss, url_options = {}, tag_options = {})
Returns a link tag that browsers and feed readers can use to auto-detect an RSS, Atom, or JSON feed.
-
#favicon_link_tag(source = "favicon.ico", options = {})
Returns a link tag for a favicon managed by the asset pipeline.
-
#image_tag(source, options = {})
Returns an HTML image tag for the
source
. -
#javascript_include_tag(*sources)
Returns an HTML script tag for each of the
sources
provided. -
#picture_tag(*sources, &block)
Returns an HTML picture tag for the
sources
. -
#preload_link_tag(source, options = {})
Returns a link tag that browsers can use to preload the
source
. -
#stylesheet_link_tag(*sources)
Returns a stylesheet link tag for the sources specified as arguments.
-
#video_tag(*sources)
Returns an HTML video tag for the
sources
.
TagHelper
- Included
#cdata_section | Returns a CDATA section with the given |
#class_names | Alias for TagHelper#token_list. |
#content_tag | Returns an HTML block tag of type |
#escape_once | Returns an escaped version of |
#tag | Returns an HTML tag. |
#token_list | Returns a string of tokens built from |
OutputSafetyHelper
- Included
#raw | This method outputs without escaping a string. |
#safe_join | This method returns an HTML safe string similar to what |
#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? |
|
#provide | The same as |
AssetUrlHelper
- Included
#asset_path | This is the entry point for all assets. |
#asset_url | Computes the full URL to an asset in the public directory. |
#audio_path | Computes the path to an audio asset in the public audios directory. |
#audio_url | Computes the full URL to an audio asset in the public audios directory. |
#compute_asset_extname | Compute extname to append to asset path. |
#compute_asset_host | Pick an asset host for this source. |
#compute_asset_path | Computes asset path to public directory. |
#font_path | Computes the path to a font asset. |
#font_url | Computes the full URL to a font asset. |
#image_path | Computes the path to an image asset. |
#image_url | Computes the full URL to an image asset. |
#javascript_path | Computes the path to a JavaScript asset in the public javascripts directory. |
#javascript_url | Computes the full URL to a JavaScript asset in the public javascripts directory. |
#path_to_asset | Alias for AssetUrlHelper#asset_path. |
#path_to_audio | Alias for AssetUrlHelper#audio_path. |
#path_to_font | Alias for AssetUrlHelper#font_path. |
#path_to_image | Alias for AssetUrlHelper#image_path. |
#path_to_javascript | Alias for AssetUrlHelper#javascript_path. |
#path_to_stylesheet | Alias for AssetUrlHelper#stylesheet_path. |
#path_to_video | Alias for AssetUrlHelper#video_path. |
#public_compute_asset_path | Alias for AssetUrlHelper#compute_asset_path. |
#stylesheet_path | Computes the path to a stylesheet asset in the public stylesheets directory. |
#stylesheet_url | Computes the full URL to a stylesheet asset in the public stylesheets directory. |
#url_to_asset | Alias for AssetUrlHelper#asset_url. |
#url_to_audio | Alias for AssetUrlHelper#audio_url. |
#url_to_font | Alias for AssetUrlHelper#font_url. |
#url_to_image | Alias for AssetUrlHelper#image_url. |
#url_to_javascript | Alias for AssetUrlHelper#javascript_url. |
#url_to_stylesheet | Alias for AssetUrlHelper#stylesheet_url. |
#url_to_video | Alias for AssetUrlHelper#video_url. |
#video_path | Computes the path to a video asset in the public videos directory. |
#video_url | Computes the full URL to a video asset in the public videos directory. |
Class Attribute Details
.apply_stylesheet_media_default (rw) Also known as: #apply_stylesheet_media_default
[ GitHub ]# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 28
mattr_accessor :apply_stylesheet_media_default
.image_decoding (rw) Also known as: #image_decoding
[ GitHub ]# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 26
mattr_accessor :image_decoding
.image_loading (rw) Also known as: #image_loading
[ GitHub ]# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 25
mattr_accessor :image_loading
.preload_links_header (rw) Also known as: #preload_links_header
[ GitHub ]# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 27
mattr_accessor :preload_links_header
Instance Attribute Details
#apply_stylesheet_media_default (rw)
[ GitHub ]# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 28
mattr_accessor :apply_stylesheet_media_default
#image_decoding (rw)
[ GitHub ]# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 26
mattr_accessor :image_decoding
#image_loading (rw)
[ GitHub ]# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 25
mattr_accessor :image_loading
#preload_links_header (rw)
[ GitHub ]# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 27
mattr_accessor :preload_links_header
Instance Method Details
#audio_tag(*sources)
Returns an HTML audio tag for the sources
. If sources
is a string, a single audio tag will be returned. If sources
is an array, an audio tag with nested source tags for each source will be returned. The sources
can be full paths, files that exist in your public audios directory, or Active Storage attachments.
When the last parameter is a hash you can add HTML attributes using that parameter.
audio_tag("sound")
# => <audio src="/audios/sound"></audio>
audio_tag("sound.wav")
# => <audio src="/audios/sound.wav"></audio>
audio_tag("sound.wav", autoplay: true, controls: true)
# => <audio autoplay="autoplay" controls="controls" src="/audios/sound.wav"></audio>
audio_tag("sound.wav", "sound.mid")
# => <audio><source src="/audios/sound.wav" /><source src="/audios/sound.mid" /></audio>
Active Storage blobs (audios that are uploaded by the users of your app):
audio_tag(user.name_pronunciation_audio)
# => <audio src="/rails/active_storage/blobs/.../name_pronunciation_audio.mp3"></audio>
# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 581
def audio_tag(*sources) multiple_sources_tag_builder("audio", sources) end
#auto_discovery_link_tag(type = :rss, url_options = {}, tag_options = {})
Returns a link tag that browsers and feed readers can use to auto-detect an RSS, Atom, or JSON feed. The type
can be :rss
(default), :atom
, or :json
. Control the link options in url_for format using the url_options
. You can modify the LINK tag itself in tag_options
.
Options
-
:rel
- Specify the relation of this link, defaults to “alternate” -
:type
- Override the auto-generated mime type -
:title
- Specify the title of the link, defaults to thetype
Examples
auto_discovery_link_tag
# => <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.com/controller/action" />
auto_discovery_link_tag(:atom)
# => <link rel="alternate" type="application/atom+xml" title="ATOM" href="http://www.currenthost.com/controller/action" />
auto_discovery_link_tag(:json)
# => <link rel="alternate" type="application/json" title="JSON" href="http://www.currenthost.com/controller/action" />
auto_discovery_link_tag(:rss, {action: "feed"})
# => <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.com/controller/feed" />
auto_discovery_link_tag(:rss, {action: "feed"}, {title: "My RSS"})
# => <link rel="alternate" type="application/rss+xml" title="My RSS" href="http://www.currenthost.com/controller/feed" />
auto_discovery_link_tag(:rss, {controller: "news", action: "feed"})
# => <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.com/news/feed" />
auto_discovery_link_tag(:rss, "http://www.example.com/feed.rss", {title: "Example RSS"})
# => <link rel="alternate" type="application/rss+xml" title="Example RSS" href="http://www.example.com/feed.rss" />
# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 259
def auto_discovery_link_tag(type = :rss, = {}, = {}) if !(type == :rss || type == :atom || type == :json) && [:type].blank? raise ArgumentError.new("You should pass :type tag_option key explicitly, because you have passed #{type} type other than :rss, :atom, or :json.") end tag( "link", "rel" => [:rel] || "alternate", "type" => [:type] || Template::Types[type].to_s, "title" => [:title] || type.to_s.upcase, "href" => .is_a?(Hash) ? url_for( .merge(only_path: false)) : ) end
#favicon_link_tag(source = "favicon.ico", options = {})
Returns a link tag for a favicon managed by the asset pipeline.
If a page has no link like the one generated by this helper, browsers ask for /favicon.ico
automatically, and cache the file if the request succeeds. If the favicon changes it is hard to get it updated.
To have better control applications may let the asset pipeline manage their favicon storing the file under app/assets/images
, and using this helper to generate its corresponding link tag.
The helper gets the name of the favicon file as first argument, which defaults to “favicon.ico”, and also supports :rel
and :type
options to override their defaults, “icon” and “image/x-icon” respectively:
favicon_link_tag
# => <link href="/assets/favicon.ico" rel="icon" type="image/x-icon" />
favicon_link_tag 'myicon.ico'
# => <link href="/assets/myicon.ico" rel="icon" type="image/x-icon" />
Mobile Safari looks for a different link tag, pointing to an image that will be used if you add the page to the home screen of an iOS device. The following call would generate such a tag:
favicon_link_tag 'mb-icon.png', rel: 'apple-touch-icon', type: 'image/png'
# => <link href="/assets/mb-icon.png" rel="apple-touch-icon" type="image/png" />
# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 300
def favicon_link_tag(source = "favicon.ico", = {}) tag("link", { rel: "icon", type: "image/x-icon", href: path_to_image(source, skip_pipeline: .delete(:skip_pipeline)) }.merge!( .symbolize_keys)) end
#image_tag(source, options = {})
Returns an HTML image tag for the source
. The source
can be a full path, a file, or an Active Storage attachment.
Options
You can add HTML attributes using the options
. The options
supports additional keys for convenience and conformance:
-
:size
- Supplied as"#{width}x#{height}"
or"#{number}"
, so"30x45"
becomeswidth="30" height="45"
, and"50"
becomeswidth="50" height="50"
.:size
will be ignored if the value is not in the correct format. -
:srcset
- If supplied as a hash or array of[source, descriptor]
pairs, each image path will be expanded before the list is formatted as a string.
Examples
Assets (images that are part of your app):
image_tag("icon")
# => <img src="/assets/icon" />
image_tag("icon.png")
# => <img src="/assets/icon.png" />
image_tag("icon.png", size: "16x10", alt: "Edit Entry")
# => <img src="/assets/icon.png" width="16" height="10" alt="Edit Entry" />
image_tag("/icons/icon.gif", size: "16")
# => <img src="/icons/icon.gif" width="16" height="16" />
image_tag("/icons/icon.gif", height: '32', width: '32')
# => <img height="32" src="/icons/icon.gif" width="32" />
image_tag("/icons/icon.gif", class: "menu_icon")
# => <img class="menu_icon" src="/icons/icon.gif" />
image_tag("/icons/icon.gif", data: { title: 'Rails Application' })
# => <img data-title="Rails Application" src="/icons/icon.gif" />
image_tag("icon.png", srcset: { "icon_2x.png" => "2x", "icon_4x.png" => "4x" })
# => <img src="/assets/icon.png" srcset="/assets/icon_2x.png 2x, /assets/icon_4x.png 4x">
image_tag("pic.jpg", srcset: [["pic_1024.jpg", "1024w"], ["pic_1980.jpg", "1980w"]], sizes: "100vw")
# => <img src="/assets/pic.jpg" srcset="/assets/pic_1024.jpg 1024w, /assets/pic_1980.jpg 1980w" sizes="100vw">
Active Storage blobs (images that are uploaded by the users of your app):
image_tag(user.avatar)
# => <img src="/rails/active_storage/blobs/.../tiger.jpg" />
image_tag(user.avatar.variant(resize_to_limit: [100, 100]))
# => <img src="/rails/active_storage/representations/.../tiger.jpg" />
image_tag(user.avatar.variant(resize_to_limit: [100, 100]), size: '100')
# => <img width="100" height="100" src="/rails/active_storage/representations/.../tiger.jpg" />
# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 418
def image_tag(source, = {}) = .symbolize_keys check_for_image_tag_errors( ) skip_pipeline = .delete(:skip_pipeline) [:src] = resolve_asset_source("image", source, skip_pipeline) if [:srcset] && ! [:srcset].is_a?(String) [:srcset] = [:srcset].map do |src_path, size| src_path = path_to_image(src_path, skip_pipeline: skip_pipeline) "#{src_path} #{size}" end.join(", ") end [:width], [:height] = extract_dimensions( .delete(:size)) if [:size] [:loading] ||= image_loading if image_loading [:decoding] ||= image_decoding if image_decoding tag("img", ) end
#javascript_include_tag(*sources)
Returns an HTML script tag for each of the sources
provided.
Sources may be paths to JavaScript files. Relative paths are assumed to be relative to assets/javascripts
, full paths are assumed to be relative to the document root. Relative paths are idiomatic, use absolute paths only when needed.
When passing paths, the “.js” extension is optional. If you do not want “.js” appended to the path extname: false
can be set on the options.
You can modify the HTML attributes of the script tag by passing a hash as the last argument.
When the Asset Pipeline is enabled, you can pass the name of your manifest as source, and include other JavaScript or CoffeeScript files inside the manifest.
If the server supports HTTP Early Hints, and the defer
option is not enabled, Rails will push a 103 Early Hints
response that links to the assets.
Options
When the last parameter is a hash you can add HTML attributes using that parameter. This includes but is not limited to the following options:
-
:extname
- Append an extension to the generated URL unless the extension already exists. This only applies for relative URLs. -
:protocol
- Sets the protocol of the generated URL. This option only applies when a relative URL andhost
options are provided. -
:host
- When a relative URL is provided the host is added to the that path. -
:skip_pipeline
- This option is used to bypass the asset pipeline when it is set to true. -
:nonce
- When set to true, adds an automatic nonce value if you have Content Security Policy enabled. -
:async
- When set totrue
, adds theasync
HTML attribute, allowing the script to be fetched in parallel to be parsed and evaluated as soon as possible. -
:defer
- When set totrue
, adds thedefer
HTML attribute, which indicates to the browser that the script is meant to be executed after the document has been parsed. Additionally, prevents sending the Preload Links header.
Any other specified options will be treated as HTML attributes for the script
tag.
For more information regarding how the :async
and :defer
options affect the <script>
tag, please refer to the MDN docs.
Examples
javascript_include_tag "xmlhr"
# => <script src="/assets/xmlhr.debug-1284139606.js"></script>
javascript_include_tag "xmlhr", host: "localhost", protocol: "https"
# => <script src="https://localhost/assets/xmlhr.debug-1284139606.js"></script>
javascript_include_tag "template.jst", extname: false
# => <script src="/assets/template.debug-1284139606.jst"></script>
javascript_include_tag "xmlhr.js"
# => <script src="/assets/xmlhr.debug-1284139606.js"></script>
javascript_include_tag "common.javascript", "/elsewhere/cools"
# => <script src="/assets/common.javascript.debug-1284139606.js"></script>
# <script src="/elsewhere/cools.debug-1284139606.js"></script>
javascript_include_tag "http://www.example.com/xmlhr"
# => <script src="http://www.example.com/xmlhr"></script>
javascript_include_tag "http://www.example.com/xmlhr.js"
# => <script src="http://www.example.com/xmlhr.js"></script>
javascript_include_tag "http://www.example.com/xmlhr.js", nonce: true
# => <script src="http://www.example.com/xmlhr.js" nonce="..."></script>
javascript_include_tag "http://www.example.com/xmlhr.js", async: true
# => <script src="http://www.example.com/xmlhr.js" async="async"></script>
javascript_include_tag "http://www.example.com/xmlhr.js", defer: true
# => <script src="http://www.example.com/xmlhr.js" defer="defer"></script>
# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 111
def javascript_include_tag(*sources) = sources. .stringify_keys = .extract!("protocol", "extname", "host", "skip_pipeline").symbolize_keys preload_links = [] use_preload_links_header = ["preload_links_header"].nil? ? preload_links_header : .delete("preload_links_header") nopush = ["nopush"].nil? ? true : .delete("nopush") crossorigin = .delete("crossorigin") crossorigin = "anonymous" if crossorigin == true integrity = ["integrity"] rel = ["type"] == "module" ? "modulepreload" : "preload" = sources.uniq.map { |source| href = path_to_javascript(source, ) if use_preload_links_header && ! ["defer"] && href.present? && !href.start_with?("data:") preload_link = "<#{href}>; rel=#{rel}; as=script" preload_link += "; crossorigin=#{crossorigin}" unless crossorigin.nil? preload_link += "; integrity=#{integrity}" unless integrity.nil? preload_link += "; nopush" if nopush preload_links << preload_link end = { "src" => href, "crossorigin" => crossorigin }.merge!( ) if ["nonce"] == true ["nonce"] = content_security_policy_nonce end content_tag("script", "", ) }.join("\n").html_safe if use_preload_links_header send_preload_links_header(preload_links) end end
#picture_tag(*sources, &block)
Returns an HTML picture tag for the sources
. If sources
is a string, a single picture tag will be returned. If sources
is an array, a picture tag with nested source tags for each source will be returned. The sources
can be full paths, files that exist in your public images directory, or Active Storage attachments. Since the picture tag requires an img tag, the last element you provide will be used for the img tag. For complete control over the picture tag, a block can be passed, which will populate the contents of the tag accordingly.
Options
When the last parameter is a hash you can add HTML attributes using that parameter. Apart from all the HTML supported options, the following are supported:
-
:image
-::Hash
of options that are passed directly to the #image_tag helper.
Examples
picture_tag("picture.webp")
# => <picture><img src="/images/picture.webp" /></picture>
picture_tag("gold.png", :image => { :size => "20" })
# => <picture><img height="20" src="/images/gold.png" width="20" /></picture>
picture_tag("gold.png", :image => { :size => "45x70" })
# => <picture><img height="70" src="/images/gold.png" width="45" /></picture>
picture_tag("picture.webp", "picture.png")
# => <picture><source srcset="/images/picture.webp" /><source srcset="/images/picture.png" /><img src="/images/picture.png" /></picture>
picture_tag("picture.webp", "picture.png", :image => { alt: "Image" })
# => <picture><source srcset="/images/picture.webp" /><source srcset="/images/picture.png" /><img alt="Image" src="/images/picture.png" /></picture>
picture_tag(["picture.webp", "picture.png"], :image => { alt: "Image" })
# => <picture><source srcset="/images/picture.webp" /><source srcset="/images/picture.png" /><img alt="Image" src="/images/picture.png" /></picture>
picture_tag(:class => "my-class") { tag(:source, :srcset => image_path("picture.webp")) + image_tag("picture.png", :alt => "Image") }
# => <picture class="my-class"><source srcset="/images/picture.webp" /><img alt="Image" src="/images/picture.png" /></picture>
picture_tag { tag(:source, :srcset => image_path("picture-small.webp"), :media => "(min-width: 600px)") + tag(:source, :srcset => image_path("picture-big.webp")) + image_tag("picture.png", :alt => "Image") }
# => <picture><source srcset="/images/picture-small.webp" media="(min-width: 600px)" /><source srcset="/images/picture-big.webp" /><img alt="Image" src="/images/picture.png" /></picture>
Active Storage blobs (images that are uploaded by the users of your app):
picture_tag(user.profile_picture)
# => <picture><img src="/rails/active_storage/blobs/.../profile_picture.webp" /></picture>
# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 479
def picture_tag(*sources, &block) sources.flatten! = sources. .symbolize_keys = .delete(:image) || {} skip_pipeline = .delete(:skip_pipeline) content_tag("picture", ) do if block.present? capture(&block).html_safe elsif sources.size <= 1 image_tag(sources.last, ) else = sources.map do |source| tag("source", srcset: resolve_asset_source("image", source, skip_pipeline), type: Template::Types[File.extname(source)[1..]]&.to_s) end safe_join( << image_tag(sources.last, )) end end end
#preload_link_tag(source, options = {})
Returns a link tag that browsers can use to preload the source
. The source
can be the path of a resource managed by asset pipeline, a full path, or an URI.
Options
-
:type
- Override the auto-generated mime type, defaults to the mime type forsource
extension. -
:as
- Override the auto-generated value for as attribute, calculated usingsource
extension and mime type. -
:crossorigin
- Specify the crossorigin attribute, required to load cross-origin resources. -
:nopush
- Specify if the use of server push is not desired for the resource. Defaults tofalse
. -
:integrity
- Specify the integrity attribute.
Examples
preload_link_tag("custom_theme.css")
# => <link rel="preload" href="/assets/custom_theme.css" as="style" type="text/css" />
preload_link_tag("/videos/video.webm")
# => <link rel="preload" href="/videos/video.mp4" as="video" type="video/webm" />
preload_link_tag(post_path(format: :json), as: "fetch")
# => <link rel="preload" href="/posts.json" as="fetch" type="application/json" />
preload_link_tag("worker.js", as: "worker")
# => <link rel="preload" href="/assets/worker.js" as="worker" type="text/javascript" />
preload_link_tag("//example.com/font.woff2")
# => <link rel="preload" href="//example.com/font.woff2" as="font" type="font/woff2" crossorigin="anonymous"/>
preload_link_tag("//example.com/font.woff2", crossorigin: "use-credentials")
# => <link rel="preload" href="//example.com/font.woff2" as="font" type="font/woff2" crossorigin="use-credentials" />
preload_link_tag("/media/audio.ogg", nopush: true)
# => <link rel="preload" href="/media/audio.ogg" as="audio" type="audio/ogg" />
# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 343
def preload_link_tag(source, = {}) href = path_to_asset(source, skip_pipeline: .delete(:skip_pipeline)) extname = File.extname(source).downcase.delete(".") mime_type = .delete(:type) || Template::Types[extname]&.to_s as_type = .delete(:as) || resolve_link_as(extname, mime_type) crossorigin = .delete(:crossorigin) crossorigin = "anonymous" if crossorigin == true || (crossorigin.blank? && as_type == "font") integrity = [:integrity] nopush = .delete(:nopush) || false rel = mime_type == "module" ? "modulepreload" : "preload" link_tag = tag.link(**{ rel: rel, href: href, as: as_type, type: mime_type, crossorigin: crossorigin }.merge!( .symbolize_keys)) preload_link = "<#{href}>; rel=#{rel}; as=#{as_type}" preload_link += "; type=#{mime_type}" if mime_type preload_link += "; crossorigin=#{crossorigin}" if crossorigin preload_link += "; integrity=#{integrity}" if integrity preload_link += "; nopush" if nopush send_preload_links_header([preload_link]) link_tag end
#stylesheet_link_tag(*sources)
Returns a stylesheet link tag for the sources specified as arguments.
When passing paths, the .css
extension is optional. If you don’t specify an extension, .css
will be appended automatically. If you do not want .css
appended to the path, set extname: false
in the options. You can modify the link attributes by passing a hash as the last argument.
If the server supports HTTP Early Hints, Rails will push a 103 Early Hints
response that links to the assets.
Options
-
:extname
- Append an extension to the generated URL unless the extension already exists. This only applies for relative URLs. -
:protocol
- Sets the protocol of the generated URL. This option only applies when a relative URL andhost
options are provided. -
:host
- When a relative URL is provided the host is added to the that path. -
:skip_pipeline
- This option is used to bypass the asset pipeline when it is set to true.
Examples
stylesheet_link_tag "style"
# => <link href="/assets/style.css" rel="stylesheet" />
stylesheet_link_tag "style.css"
# => <link href="/assets/style.css" rel="stylesheet" />
stylesheet_link_tag "http://www.example.com/style.css"
# => <link href="http://www.example.com/style.css" rel="stylesheet" />
stylesheet_link_tag "style.less", extname: false, skip_pipeline: true, rel: "stylesheet/less"
# => <link href="/stylesheets/style.less" rel="stylesheet/less">
stylesheet_link_tag "style", media: "all"
# => <link href="/assets/style.css" media="all" rel="stylesheet" />
stylesheet_link_tag "style", media: "print"
# => <link href="/assets/style.css" media="print" rel="stylesheet" />
stylesheet_link_tag "random.styles", "/css/stylish"
# => <link href="/assets/random.styles" rel="stylesheet" />
# <link href="/css/stylish.css" rel="stylesheet" />
# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 193
def stylesheet_link_tag(*sources) = sources. .stringify_keys = .extract!("protocol", "extname", "host", "skip_pipeline").symbolize_keys use_preload_links_header = ["preload_links_header"].nil? ? preload_links_header : .delete("preload_links_header") preload_links = [] crossorigin = .delete("crossorigin") crossorigin = "anonymous" if crossorigin == true nopush = ["nopush"].nil? ? true : .delete("nopush") integrity = ["integrity"] = sources.uniq.map { |source| href = path_to_stylesheet(source, ) if use_preload_links_header && href.present? && !href.start_with?("data:") preload_link = "<#{href}>; rel=preload; as=style" preload_link += "; crossorigin=#{crossorigin}" unless crossorigin.nil? preload_link += "; integrity=#{integrity}" unless integrity.nil? preload_link += "; nopush" if nopush preload_links << preload_link end = { "rel" => "stylesheet", "crossorigin" => crossorigin, "href" => href }.merge!( ) if apply_stylesheet_media_default && ["media"].blank? ["media"] = "screen" end tag(:link, ) }.join("\n").html_safe if use_preload_links_header send_preload_links_header(preload_links) end end
#video_tag(*sources)
Returns an HTML video tag for the sources
. If sources
is a string, a single video tag will be returned. If sources
is an array, a video tag with nested source tags for each source will be returned. The sources
can be full paths, files that exist in your public videos directory, or Active Storage attachments.
Options
When the last parameter is a hash you can add HTML attributes using that parameter. The following options are supported:
-
:poster
- Set an image (like a screenshot) to be shown before the video loads. The path is calculated like thesrc
of #image_tag. -
:size
- Supplied as"#{width}x#{height}"
or"#{number}"
, so"30x45"
becomeswidth="30" height="45"
, and"50"
becomeswidth="50" height="50"
.:size
will be ignored if the value is not in the correct format. -
:poster_skip_pipeline
will bypass the asset pipeline when using the:poster
option instead using an asset in the public folder.
Examples
video_tag("trailer")
# => <video src="/videos/trailer"></video>
video_tag("trailer.ogg")
# => <video src="/videos/trailer.ogg"></video>
video_tag("trailer.ogg", controls: true, preload: 'none')
# => <video preload="none" controls="controls" src="/videos/trailer.ogg"></video>
video_tag("trailer.m4v", size: "16x10", poster: "screenshot.png")
# => <video src="/videos/trailer.m4v" width="16" height="10" poster="/assets/screenshot.png"></video>
video_tag("trailer.m4v", size: "16x10", poster: "screenshot.png", poster_skip_pipeline: true)
# => <video src="/videos/trailer.m4v" width="16" height="10" poster="screenshot.png"></video>
video_tag("/trailers/hd.avi", size: "16x16")
# => <video src="/trailers/hd.avi" width="16" height="16"></video>
video_tag("/trailers/hd.avi", size: "16")
# => <video height="16" src="/trailers/hd.avi" width="16"></video>
video_tag("/trailers/hd.avi", height: '32', width: '32')
# => <video height="32" src="/trailers/hd.avi" width="32"></video>
video_tag("trailer.ogg", "trailer.flv")
# => <video><source src="/videos/trailer.ogg" /><source src="/videos/trailer.flv" /></video>
video_tag(["trailer.ogg", "trailer.flv"])
# => <video><source src="/videos/trailer.ogg" /><source src="/videos/trailer.flv" /></video>
video_tag(["trailer.ogg", "trailer.flv"], size: "160x120")
# => <video height="120" width="160"><source src="/videos/trailer.ogg" /><source src="/videos/trailer.flv" /></video>
Active Storage blobs (videos that are uploaded by the users of your app):
video_tag(user.intro_video)
# => <video src="/rails/active_storage/blobs/.../intro_video.mp4"></video>
# File 'actionview/lib/action_view/helpers/asset_tag_helper.rb', line 549
def video_tag(*sources) = sources. .symbolize_keys public_poster_folder = .delete(:poster_skip_pipeline) sources << multiple_sources_tag_builder("video", sources) do || [:poster] = path_to_image( [:poster], skip_pipeline: public_poster_folder) if [:poster] [:width], [:height] = extract_dimensions( .delete(:size)) if [:size] end end