diff options
| author | Pablo Ifrán <pabloifran@gmail.com> | 2016-12-20 18:12:38 -0300 |
|---|---|---|
| committer | Eileen M. Uchitelle <eileencodes@users.noreply.github.com> | 2016-12-20 16:12:38 -0500 |
| commit | c945da583b8f802216300d037e5a70ebc5da834c (patch) | |
| tree | c1ceab57f6bc9ceafde7244c15db84dc406cef32 /actionview | |
| parent | 7a42df07ca1c6032fbdbd8ee6017e173564eb429 (diff) | |
| download | rails-c945da583b8f802216300d037e5a70ebc5da834c.tar.gz rails-c945da583b8f802216300d037e5a70ebc5da834c.tar.bz2 rails-c945da583b8f802216300d037e5a70ebc5da834c.zip | |
Improve `javascript_include_tag` documentation (#27403)
Add all the available options, and correct the samples of the
`javascript_include_tag`.
Diffstat (limited to 'actionview')
| -rw-r--r-- | actionview/lib/action_view/helpers/asset_tag_helper.rb | 29 |
1 files changed, 24 insertions, 5 deletions
diff --git a/actionview/lib/action_view/helpers/asset_tag_helper.rb b/actionview/lib/action_view/helpers/asset_tag_helper.rb index 4e4f4823e6..397a12f137 100644 --- a/actionview/lib/action_view/helpers/asset_tag_helper.rb +++ b/actionview/lib/action_view/helpers/asset_tag_helper.rb @@ -35,18 +35,37 @@ module ActionView # 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. # + # ==== Options + # + # When the last parameter is a hash you can add HTML attributes using that + # parameter. That options supports the following keys as well: + # + # * <tt>:extname</tt> - Append a extention to the generated url unless the extension + # already exists. This only applies for relative urls. + # * <tt>:protocol</tt> - Sets the protocol of the generated url, this option only + # applies when a relative url and +host+ options are provided. + # * <tt>:host</tt> - When a relative url is provided the host is added to the + # that path. + # * <tt>:skip_pipeline</tt> - This option is used to bypass the asset pipeline + # when it is set to true. + # + # ==== Examples + # # javascript_include_tag "xmlhr" - # # => <script src="/assets/xmlhr.js?1284139606"></script> + # # => <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.jst?1284139606"></script> + # # => <script src="/assets/template.debug-1284139606.jst"></script> # # javascript_include_tag "xmlhr.js" - # # => <script src="/assets/xmlhr.js?1284139606"></script> + # # => <script src="/assets/xmlhr.debug-1284139606.js"></script> # # javascript_include_tag "common.javascript", "/elsewhere/cools" - # # => <script src="/assets/common.javascript?1284139606"></script> - # # <script src="/elsewhere/cools.js?1423139606"></script> + # # => <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> |