Module: ActionView::Helpers::AssetTagHelper::JavascriptTagHelpers

### Home Classes Methods

### In Files

- lib/action_view/helpers/asset_tag_helpers/javascript_tag_helpers.rb

### Namespace

- MODULE ActionView::Helpers::AssetTagHelper::JavascriptTagHelpers::ClassMethods

### Methods

- #javascript_include_tag
- #javascript_path
- #path_to_javascript

### Class/Module Index

Quicksearch

- ActionDispatch
- ActionDispatch::Assertions
- ActionDispatch::Assertions::DomAssertions
- ActionDispatch::Assertions::ResponseAssertions
- ActionDispatch::Assertions::RoutingAssertions
- ActionDispatch::Assertions::SelectorAssertions
- ActionDispatch::Assertions::TagAssertions
- ActionDispatch::BestStandardsSupport
- ActionDispatch::BodyProxy
- ActionDispatch::Callbacks
- ActionDispatch::Cookies
- ActionDispatch::Cookies::CookieOverflow
- ActionDispatch::DebugExceptions
- ActionDispatch::ExceptionWrapper
- ActionDispatch::FileHandler
- ActionDispatch::Flash
- ActionDispatch::Flash::FlashHash
- ActionDispatch::Head
- ActionDispatch::Http
- ActionDispatch::Http::Cache
- ActionDispatch::Http::Cache::Request
- ActionDispatch::Http::Cache::Response
- ActionDispatch::Http::FilterParameters
- ActionDispatch::Http::Headers
- ActionDispatch::Http::MimeNegotiation
- ActionDispatch::Http::ParameterFilter
- ActionDispatch::Http::Parameters
- ActionDispatch::Http::URL
- ActionDispatch::Http::Upload
- ActionDispatch::Http::UploadedFile
- ActionDispatch::Integration
- ActionDispatch::Integration::RequestHelpers
- ActionDispatch::Integration::Runner
- ActionDispatch::Integration::Session
- ActionDispatch::IntegrationTest
- ActionDispatch::MiddlewareStack
- ActionDispatch::MiddlewareStack::Middleware
- ActionDispatch::ParamsParser
- ActionDispatch::PerformanceTest
- ActionDispatch::PublicExceptions
- ActionDispatch::RailsEntityStore
- ActionDispatch::RailsMetaStore
- ActionDispatch::Railtie
- ActionDispatch::Reloader
- ActionDispatch::RemoteIp
- ActionDispatch::RemoteIp::GetIp
- ActionDispatch::RemoteIp::IpSpoofAttackError
- ActionDispatch::Request
- ActionDispatch::RequestId
- ActionDispatch::Rescue
- ActionDispatch::Response
- ActionDispatch::Routing
- ActionDispatch::Routing::Mapper
- ActionDispatch::Routing::Mapper::Base
- ActionDispatch::Routing::Mapper::HttpHelpers
- ActionDispatch::Routing::Mapper::Resources
- ActionDispatch::Routing::Mapper::Scoping
- ActionDispatch::Routing::PolymorphicRoutes
- ActionDispatch::Routing::Redirection
- ActionDispatch::Routing::RouteSet
- ActionDispatch::Routing::RouteSet::MountedHelpers
- ActionDispatch::Routing::UrlFor
- ActionDispatch::Session
- ActionDispatch::Session::AbstractStore
- ActionDispatch::Session::CacheStore
- ActionDispatch::Session::Compatibility
- ActionDispatch::Session::CookieStore
- ActionDispatch::Session::DestroyableSession
- ActionDispatch::Session::MemCacheStore
- ActionDispatch::Session::StaleSessionCheck
- ActionDispatch::ShowExceptions
- ActionDispatch::Static
- ActionDispatch::TestProcess
- ActionDispatch::TestRequest
- ActionDispatch::TestResponse
- ActionController
- ActionController::Base
- ActionController::Caching
- ActionController::Caching::Actions
- ActionController::Caching::Actions::ActionCachePath
- ActionController::Caching::Actions::ClassMethods
- ActionController::Caching::ConfigMethods
- ActionController::Caching::Fragments
- ActionController::Caching::Pages
- ActionController::Caching::Pages::ClassMethods
- ActionController::Caching::Sweeping
- ActionController::Compatibility
- ActionController::ConditionalGet
- ActionController::Cookies
- ActionController::DataStreaming
- ActionController::Flash
- ActionController::ForceSSL
- ActionController::ForceSSL::ClassMethods
- ActionController::Head
- ActionController::Helpers
- ActionController::Helpers::ClassMethods
- ActionController::HideActions
- ActionController::HideActions::ClassMethods
- ActionController::HttpAuthentication
- ActionController::HttpAuthentication::Basic
- ActionController::HttpAuthentication::Basic::ControllerMethods
- ActionController::HttpAuthentication::Basic::ControllerMethods::ClassMethods
- ActionController::HttpAuthentication::Digest
- ActionController::HttpAuthentication::Digest::ControllerMethods
- ActionController::HttpAuthentication::Token
- ActionController::HttpAuthentication::Token::ControllerMethods
- ActionController::ImplicitRender
- ActionController::Instrumentation
- ActionController::Instrumentation::ClassMethods
- ActionController::LogSubscriber
- ActionController::Metal
- ActionController::Middleware
- ActionController::Middleware::ActionMiddleware
- ActionController::MimeResponds
- ActionController::MimeResponds::ClassMethods
- ActionController::ParamsWrapper
- ActionController::ParamsWrapper::ClassMethods
- ActionController::RackDelegation
- ActionController::Railtie
- ActionController::Railties
- ActionController::Railties::Paths
- ActionController::RecordIdentifier
- ActionController::Redirecting
- ActionController::Renderers
- ActionController::Renderers::All
- ActionController::Renderers::ClassMethods
- ActionController::Rendering
- ActionController::RequestForgeryProtection
- ActionController::RequestForgeryProtection::ClassMethods
- ActionController::Rescue
- ActionController::Responder
- ActionController::SessionManagement
- ActionController::SessionManagement::ClassMethods
- ActionController::Streaming
- ActionController::TemplateAssertions
- ActionController::TestCase
- ActionController::TestCase::Behavior
- ActionController::TestCase::Behavior::ClassMethods
- ActionController::TestCase::RaiseActionExceptions
- ActionController::TestResponse
- ActionController::Testing
- ActionController::Testing::ClassMethods
- ActionController::UrlFor
- ActionView
- ActionView::Base
- ActionView::Context
- ActionView::FileSystemResolver
- ActionView::FixtureResolver
- ActionView::Helpers
- ActionView::Helpers::ActiveModelHelper
- ActionView::Helpers::ActiveModelInstanceTag
- ActionView::Helpers::AssetPaths
- ActionView::Helpers::AssetTagHelper
- ActionView::Helpers::AssetTagHelper::AssetIncludeTag
- ActionView::Helpers::AssetTagHelper::JavascriptIncludeTag
- ActionView::Helpers::AssetTagHelper::JavascriptTagHelpers
- ActionView::Helpers::AssetTagHelper::JavascriptTagHelpers::ClassMethods
- ActionView::Helpers::AssetTagHelper::StylesheetIncludeTag
- ActionView::Helpers::AssetTagHelper::StylesheetTagHelpers
- ActionView::Helpers::AssetTagHelper::StylesheetTagHelpers::ClassMethods
- ActionView::Helpers::AtomFeedHelper
- ActionView::Helpers::AtomFeedHelper::AtomBuilder
- ActionView::Helpers::AtomFeedHelper::AtomFeedBuilder
- ActionView::Helpers::CacheHelper
- ActionView::Helpers::CaptureHelper
- ActionView::Helpers::CsrfHelper
- ActionView::Helpers::DateHelper
- ActionView::Helpers::DateHelperInstanceTag
- ActionView::Helpers::DebugHelper
- ActionView::Helpers::FormBuilder
- ActionView::Helpers::FormHelper
- ActionView::Helpers::FormOptionsHelper
- ActionView::Helpers::FormTagHelper
- ActionView::Helpers::InstanceTag
- ActionView::Helpers::JavaScriptHelper
- ActionView::Helpers::OutputSafetyHelper
- ActionView::Helpers::RecordTagHelper
- ActionView::Helpers::RenderingHelper
- ActionView::Helpers::SanitizeHelper
- ActionView::Helpers::TagHelper
- ActionView::Helpers::TextHelper
- ActionView::Helpers::TranslationHelper
- ActionView::Helpers::UrlHelper
- ActionView::LogSubscriber
- ActionView::LookupContext
- ActionView::LookupContext::DetailsCache
- ActionView::LookupContext::ViewPaths
- ActionView::NullResolver
- ActionView::PartialRenderer
- ActionView::Railtie
- ActionView::Renderer
- ActionView::Resolver
- ActionView::Resolver::Path
- ActionView::Template
- ActionView::Template::Handlers
- ActionView::Template::Handlers::Builder
- ActionView::Template::Handlers::ERB
- ActionView::Template::Handlers::Erubis
- ActionView::TestCase
- ActionView::TestCase::Behavior
- ActionView::TestCase::Behavior::ClassMethods
- ActionView::TestCase::Behavior::Locals
- ActionView::TestCase::TestController
- AbstractController
- AbstractController::ActionNotFound
- AbstractController::AssetPaths
- AbstractController::Base
- AbstractController::Callbacks
- AbstractController::Callbacks::ClassMethods
- AbstractController::Collector
- AbstractController::DoubleRenderError
- AbstractController::Error
- AbstractController::Helpers
- AbstractController::Helpers::ClassMethods
- AbstractController::Layouts
- AbstractController::Layouts::ClassMethods
- AbstractController::Layouts::ClassMethods::LayoutConditions
- AbstractController::Logger
- AbstractController::Railties
- AbstractController::Railties::RoutesHelpers
- AbstractController::Rendering
- AbstractController::Rendering::ClassMethods
- AbstractController::Translation
- AbstractController::UrlFor
- AbstractController::UrlFor::ClassMethods
- AbstractController::ViewPaths
- AbstractController::ViewPaths::ClassMethods
- Sprockets
- Sprockets::Bootstrap
- Sprockets::Compressors
- Sprockets::Helpers
- Sprockets::Helpers::IsolatedHelper
- Sprockets::Helpers::RailsHelper
- Sprockets::Helpers::RailsHelper::AssetPaths
- Sprockets::Helpers::RailsHelper::AssetPaths::AssetNotPrecompiledError
- Sprockets::Railtie
- Sprockets::StaticCompiler
- HTML
- HTML::FullSanitizer
- HTML::LinkSanitizer
- HTML::Sanitizer
- HTML::Selector
- HTML::Tag
- HTML::WhiteListSanitizer
- Mime
- Mime::Mimes
- Mime::Type
- ActionPack
- Object
- Rack

No matching classes.

# ActionView::Helpers::AssetTagHelper::JavascriptTagHelpers

### Public Instance Methods

javascript_include_tag(*sources) click to toggle source

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 `public/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 the application is not using the asset pipeline, to include the default JavaScript expansion pass `:defaults` as source. By default, `:defaults` loads jQuery, and that can be overridden in `config/application.rb`:

    config.action_view.javascript_expansions[:defaults] = %w(foo.js bar.js)

When using `:defaults` or `:all`, if an `application.js` file exists in `public/javascripts` it will be included as well at the end.

You can modify the HTML attributes of the script tag by passing a hash as the last argument.

#### Examples

    javascript_include_tag "xmlhr"
    # => <script type="text/javascript" src="/javascripts/xmlhr.js?1284139606"></script>

    javascript_include_tag "xmlhr.js"
    # => <script type="text/javascript" src="/javascripts/xmlhr.js?1284139606"></script>

    javascript_include_tag "common.javascript", "/elsewhere/cools"
    # => <script type="text/javascript" src="/javascripts/common.javascript?1284139606"></script>
    #    <script type="text/javascript" src="/elsewhere/cools.js?1423139606"></script>

    javascript_include_tag "http://www.example.com/xmlhr"
    # => <script type="text/javascript" src="http://www.example.com/xmlhr"></script>

    javascript_include_tag "http://www.example.com/xmlhr.js"
    # => <script type="text/javascript" src="http://www.example.com/xmlhr.js"></script>

    javascript_include_tag :defaults
    # => <script type="text/javascript" src="/javascripts/jquery.js?1284139606"></script>
    #    <script type="text/javascript" src="/javascripts/rails.js?1284139606"></script>
    #    <script type="text/javascript" src="/javascripts/application.js?1284139606"></script>

Note: The application.js file is only referenced if it exists

You can also include all JavaScripts in the `javascripts` directory using `:all` as the source:

    javascript_include_tag :all
    # => <script type="text/javascript" src="/javascripts/jquery.js?1284139606"></script>
    #    <script type="text/javascript" src="/javascripts/rails.js?1284139606"></script>
    #    <script type="text/javascript" src="/javascripts/shop.js?1284139606"></script>
    #    <script type="text/javascript" src="/javascripts/checkout.js?1284139606"></script>
    #    <script type="text/javascript" src="/javascripts/application.js?1284139606"></script>

Note that your defaults of choice will be included first, so they will be available to all subsequently included files.

If you want Rails to search in all the subdirectories under `public/javascripts`, you should explicitly set `:recursive`:

    javascript_include_tag :all, :recursive => true

## Caching multiple JavaScripts into one

You can also cache multiple JavaScripts into one file, which requires less HTTP connections to download and can better be compressed by gzip (leading to faster transfers). Caching will only happen if `config.perform_caching` is set to true (which is the case by default for the Rails production environment, but not for the development environment).

#### Examples

    # assuming config.perform_caching is false
    javascript_include_tag :all, :cache => true
    # => <script type="text/javascript" src="/javascripts/jquery.js?1284139606"></script>
    #    <script type="text/javascript" src="/javascripts/rails.js?1284139606"></script>
    #    <script type="text/javascript" src="/javascripts/shop.js?1284139606"></script>
    #    <script type="text/javascript" src="/javascripts/checkout.js?1284139606"></script>
    #    <script type="text/javascript" src="/javascripts/application.js?1284139606"></script>

    # assuming config.perform_caching is true
    javascript_include_tag :all, :cache => true
    # => <script type="text/javascript" src="/javascripts/all.js?1344139789"></script>

    # assuming config.perform_caching is false
    javascript_include_tag "jquery", "cart", "checkout", :cache => "shop"
    # => <script type="text/javascript" src="/javascripts/jquery.js?1284139606"></script>
    #    <script type="text/javascript" src="/javascripts/cart.js?1289139157"></script>
    #    <script type="text/javascript" src="/javascripts/checkout.js?1299139816"></script>

    # assuming config.perform_caching is true
    javascript_include_tag "jquery", "cart", "checkout", :cache => "shop"
    # => <script type="text/javascript" src="/javascripts/shop.js?1299139816"></script>

The `:recursive` option is also available for caching:

    javascript_include_tag :all, :cache => true, :recursive => true

    # File lib/action_view/helpers/asset_tag_helpers/javascript_tag_helpers.rb, line 186
    def javascript_include_tag(*sources)
      @javascript_include ||= JavascriptIncludeTag.new(config, asset_paths)
      @javascript_include.include_tag(*sources)
    end

javascript_path(source) click to toggle source

Computes the path to a javascript asset in the public javascripts directory. If the `source` filename has no extension, .js will be appended (except for explicit URIs) Full paths from the document root will be passed through. Used internally by javascript_include_tag to build the script path.

#### Examples

    javascript_path "xmlhr"                              # => /javascripts/xmlhr.js
    javascript_path "dir/xmlhr.js"                       # => /javascripts/dir/xmlhr.js
    javascript_path "/dir/xmlhr"                         # => /dir/xmlhr.js
    javascript_path "http://www.example.com/js/xmlhr"    # => http://www.example.com/js/xmlhr
    javascript_path "http://www.example.com/js/xmlhr.js" # => http://www.example.com/js/xmlhr.js

    # File lib/action_view/helpers/asset_tag_helpers/javascript_tag_helpers.rb, line 86
    def javascript_path(source)
      asset_paths.compute_public_path(source, 'javascripts', :ext => 'js')
    end

Also aliased as: path_to_javascript
path_to_javascript(source) click to toggle source
Alias for: javascript_path

[Validate]

Generated with the Darkfish Rdoc Generator 2.