module Webpacker::Helper

Public Instance Methods

asset_pack_path(name, **options) click to toggle source

Computes the relative path for a given Webpacker asset. Return relative path using manifest.json and passes it to asset_path helper This will use asset_path internally, so most of their behaviors will be the same.

Example:

<%= asset_pack_path 'calendar.css' %> # => "/packs/calendar-1016838bab065ae1e122.css"
# File lib/webpacker/helper.rb, line 9
def asset_pack_path(name, **options)
  asset_path(Webpacker.manifest.lookup!(name), **options)
end
asset_pack_url(name, **options) click to toggle source

Computes the absolute path for a given Webpacker asset. Return absolute path using manifest.json and passes it to asset_url helper This will use asset_url internally, so most of their behaviors will be the same.

Example:

<%= asset_pack_url 'calendar.css' %> # => "http://example.com/packs/calendar-1016838bab065ae1e122.css"
# File lib/webpacker/helper.rb, line 20
def asset_pack_url(name, **options)
  asset_url(Webpacker.manifest.lookup!(name), **options)
end
javascript_pack_tag(*names, **options) click to toggle source

Creates a script tag that references the named pack file, as compiled by webpack per the entries list in config/webpack/shared.js. By default, this list is auto-generated to match everything in app/javascript/packs/*.js. In production mode, the digested reference is automatically looked up.

Example:

<%= javascript_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
<script src="/packs/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
# File lib/webpacker/helper.rb, line 32
def javascript_pack_tag(*names, **options)
  javascript_include_tag(*sources_from_pack_manifest(names, type: :javascript), **options)
end
stylesheet_pack_tag(*names, **options) click to toggle source

Creates a link tag that references the named pack file, as compiled by webpack per the entries list in config/webpack/shared.js. By default, this list is auto-generated to match everything in app/javascript/packs/*.js. In production mode, the digested reference is automatically looked up.

Note: If the development server is running and hot module replacement is active, this will return nothing. In that setup you need to configure your styles to be inlined in your JavaScript for hot reloading.

Examples:

# In development mode with hot module replacement:
<%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
nil

# In production mode:
<%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
<link rel="stylesheet" media="screen" href="/packs/calendar-1016838bab065ae1e122.css" data-turbolinks-track="reload" />
# File lib/webpacker/helper.rb, line 52
def stylesheet_pack_tag(*names, **options)
  unless Webpacker.dev_server.running? && Webpacker.dev_server.hot_module_replacing?
    stylesheet_link_tag(*sources_from_pack_manifest(names, type: :stylesheet), **options)
  end
end

Private Instance Methods

pack_name_with_extension(name, type:) click to toggle source
# File lib/webpacker/helper.rb, line 63
def pack_name_with_extension(name, type:)
  "#{name}#{compute_asset_extname(name, type: type)}"
end
sources_from_pack_manifest(names, type:) click to toggle source
# File lib/webpacker/helper.rb, line 59
def sources_from_pack_manifest(names, type:)
  names.map { |name| Webpacker.manifest.lookup!(pack_name_with_extension(name, type: type)) }
end