Skip to content
/ imgex Public
forked from ianwalter/imgex

Unofficial client library for generating imgix URLs in Elixir

License

Notifications You must be signed in to change notification settings

axelson/imgex

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

imgex

An Elixir client library for generating image URLs with imgix

Hex version CI

Installation

imgex is available in Hex, the package can be installed as:

  1. Add imgex to your list of dependencies in mix.exs:

    def deps do
      [{:imgex, "~> 0.2.0"}]
    end
  2. Ensure imgex is started before your application:

    def application do
      [applications: [:imgex]]
    end

Documentation

The source is really small so reading through it should be straight-forward but the full package documentation is available at https://hexdocs.pm/imgex.

Configuration

To use the library you have to configure your imgix domain and secure token or pass them as an options map %{domain: "domain", token: "token"} as the third parameter to Imgex.url/3 or Imgex.proxy_url/3. See config/test.exs for an example of how to configure this.

Usage

To generate an imgix url based on a path (Web Folder and S3 sources) and optional parameters do:

url = Imgex.url "/images/cats.jpg", %{w: 700}

To generate an imgix url based on a public URL (Web Proxy sources) and optional parameters do:

url = Imgex.proxy_url "https://some-public-url.com/cats.jpg", %{w: 700}

 

Created by Ian Walter

About

Unofficial client library for generating imgix URLs in Elixir

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Elixir 100.0%