This module adds view helpers for rendering SVG files into safe HTML.

To add the helpers, add the following to the quoted view in your my_app_web.ex file.

def view do
  quote do
    use PhoenixInlineSvg.Helpers
  end
end

This will generate functions for each of your images, effectively caching them at compile time.

You can call these functions like so

# Get an image with the default collection
svg_image("image_name")

# Get an image and insert HTML attributes to svg tag
svg_image("image_name", class: "elixir-is-awesome", id: "inline-svg")

# Get an image from a different collection
svg_image("image_name", "collection_name")

# Get an image from a different collection and insert HTML attributes to the svg tag
svg_image("image_name", "collection_name", class: "elixir-is-awesome", id: "inline-svg")

Old Way

As an alternative this module can be imported in the quoted view def of the my_app_web.ex which will always pull the SVG files from the disk (unless you are using a caching module).

def view do
  quote do
    import PhoenixInlineSvg.Helpers
  end
end

Note: If you are setting a custom directory for the SVG files and are using Exrm or Distillery, you will need to ensure that the directory you set is in the outputted lib directory of your application.

Configuration

By default SVG files are loaded from: assets/static/svg/

The directory where SVG files are loaded from can be configured by setting the configuration variable:

config :phoenix_inline_svg, dir: "some/other/dir"

Where some/other/dir is a directory located in the Phoenix application directory.