aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorschneems <richard.schneeman@gmail.com>2016-08-29 12:40:02 -0500
committerschneems <richard.schneeman@gmail.com>2016-08-29 13:16:07 -0500
commit981ac09332b8c5210408bbc2f5fa4a99fead6a26 (patch)
tree1808522f17518fca21627f48dd510a384db76b2e
parent8bcf42c4b36caaf835e8312c11eccb830049855b (diff)
downloadrails-981ac09332b8c5210408bbc2f5fa4a99fead6a26.tar.gz
rails-981ac09332b8c5210408bbc2f5fa4a99fead6a26.tar.bz2
rails-981ac09332b8c5210408bbc2f5fa4a99fead6a26.zip
Document public_poster_folder option
-rw-r--r--actionview/lib/action_view/helpers/asset_tag_helper.rb4
1 files changed, 4 insertions, 0 deletions
diff --git a/actionview/lib/action_view/helpers/asset_tag_helper.rb b/actionview/lib/action_view/helpers/asset_tag_helper.rb
index 92bf132fbc..8dc879611c 100644
--- a/actionview/lib/action_view/helpers/asset_tag_helper.rb
+++ b/actionview/lib/action_view/helpers/asset_tag_helper.rb
@@ -257,6 +257,8 @@ module ActionView
# * <tt>:size</tt> - Supplied as "{Width}x{Height}" or "{Number}", so "30x45" becomes
# width="30" and height="45", and "50" becomes width="50" and height="50".
# <tt>:size</tt> will be ignored if the value is not in the correct format.
+ # * <tt>:public_poster_folder</tt> will bypass the asset pipeline when using
+ # the <tt>:poster</tt> option instead using an asset in the public folder.
#
# ==== Examples
#
@@ -268,6 +270,8 @@ module ActionView
# # => <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", public_poster_folder: 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")