Module: MiniviteRails::TagHelpers

Defined in:

lib/minivite_rails/tag_helpers.rb

Overview

Public: Allows to render HTML tags for scripts and styles processed by Vite.

Instance Method Summary

• #vite_asset_path(name, id: nil, **options) ⇒ Object

  Public: Resolves the path for the specified Vite asset.

• #vite_asset_url(name, id: nil, **options) ⇒ Object

  Public: Resolves the url for the specified Vite asset.

• #vite_client_tag(id: nil, crossorigin: 'anonymous', **options) ⇒ Object

  Public: Renders a script tag for vite/client to enable HMR in development.

• #vite_image_tag(name, id: nil, **options) ⇒ Object

  Public: Renders an tag for the specified Vite asset.

• #vite_javascript_tag(*names, id: nil, type: 'module', asset_type: :javascript, skip_preload_tags: false, skip_style_tags: false, crossorigin: 'anonymous', media: 'screen', **options) ⇒ Object

  Public: Renders a

  Public: Resolves the path for the specified Vite asset.

  Example:

  <%= vite_asset_path 'calendar.css' %> # => "/vite/assets/calendar-1016838bab065ae1e122.css"
  

  # File 'lib/minivite_rails/tag_helpers.rb', line 33
  
  def vite_asset_path(name, id: nil, **options)
    path_to_asset vite_manifest(id:).path_for(name, **options)
  end
  

  #vite_asset_url(name, id: nil, **options) ⇒ Object

  Public: Resolves the url for the specified Vite asset.

  Example:

  <%= vite_asset_url 'calendar.css' %> # => "https://example.com/vite/assets/calendar-1016838bab065ae1e122.css"
  

  # File 'lib/minivite_rails/tag_helpers.rb', line 41
  
  def vite_asset_url(name, id: nil, **options)
    url_to_asset vite_manifest(id:).path_for(name, **options)
  end
  

  #vite_client_tag(id: nil, crossorigin: 'anonymous', **options) ⇒ Object

  Public: Renders a script tag for vite/client to enable HMR in development.

  # File 'lib/minivite_rails/tag_helpers.rb', line 12
  
  def vite_client_tag(id: nil, crossorigin: 'anonymous', **options)
    src = vite_manifest(id:).vite_client_src
    return unless src
  
    javascript_include_tag(src, type: 'module', extname: false, crossorigin:, **options)
  end
  

  #vite_image_tag(name, id: nil, **options) ⇒ Object

  Public: Renders an tag for the specified Vite asset.

  # File 'lib/minivite_rails/tag_helpers.rb', line 90
  
  def vite_image_tag(name, id: nil, **options)
    if options[:srcset] && !options[:srcset].is_a?(String)
      options[:srcset] = options[:srcset].map do |src_name, size|
        "#{vite_asset_path(src_name, id:)} #{size}"
      end.join(', ')
    end
  
    image_tag(vite_asset_path(name, id:), options)
  end
  

  #vite_javascript_tag(*names, id: nil, type: 'module', asset_type: :javascript, skip_preload_tags: false, skip_style_tags: false, crossorigin: 'anonymous', media: 'screen', **options) ⇒ Object

  Public: Renders a

  Public: Resolves the path for Vite's public assets

  Example:

  <%= vite_public_asset_path 'logo.svg' %> # => "/vite/logo.svg"
  

  # File 'lib/minivite_rails/tag_helpers.rb', line 49
  
  def vite_public_asset_path(name, id: nil)
    path_to_asset vite_manifest(id:).public_path_for(name)
  end
  

  #vite_react_refresh_tag(id: nil, **options) ⇒ Object

  Public: Renders a script tag to enable HMR with React Refresh.

  # File 'lib/minivite_rails/tag_helpers.rb', line 20
  
  def vite_react_refresh_tag(id: nil, **options)
    react_preamble_code = vite_manifest(id:).react_preamble_code
    return unless react_preamble_code
  
    options[:nonce] = true if Rails::VERSION::MAJOR >= 6 && !options.key?(:nonce)
  
    javascript_tag(react_preamble_code.html_safe, type: :module, **options)
  end
  

  #vite_stylesheet_tag(*names, id: nil, **options) ⇒ Object

  Public: Renders a tag for the specified Vite entrypoints.

  # File 'lib/minivite_rails/tag_helpers.rb', line 81
  
  def vite_stylesheet_tag(*names, id: nil, **options)
    style_paths = names.map { |name| vite_asset_path(name, id:, type: :stylesheet) }
  
    options[:extname] = false if Rails::VERSION::MAJOR >= 7
  
    stylesheet_link_tag(*style_paths, **options)
  end
  

  #vite_typescript_tag(*names, id: nil, **options) ⇒ Object

  Public: Renders a