AutoLinker

Build Status !Hex Version]hex-img [License

AutoLinker is a basic package for turning website names, and phone numbers into links.

Use this package in your web view to convert web references into click-able links.

This is a very early version. Some of the described options are not yet functional.

Installation

The package can be installed by adding auto_linker to your list of dependencies in mix.exs:

def deps do
  [{:auto_linker, "~> 1.0"}]
end

Usage

The following examples illustrate some examples on how to use the auto linker.

iex> AutoLinker.link("google.com") "<a href='http://google.com' class='auto-linker' target='_blank' rel='noopener noreferrer'>google.com</a>"

iex> AutoLinker.link("google.com", new_window: false, rel: false) "<a href='http://google.com' class='auto-linker'>google.com</a>"

iex> AutoLinker.link("google.com", new_window: false, rel: false, class: false) "<a href='http://google.com'>google.com</a>"

iex> AutoLinker.link("call me at x9999") ~s{call me at <a href="" class="phone-number" data-number="9999">x9999</a>}

iex> AutoLinker.link("or at home on 555.555.5555") ~s{or at home on <a href="" class="phone-number" data-number="55555555555">555.555.5555</a>}

iex> AutoLinker.link(", work (555) 555-5555") ~s{, work <a href="" class="phone-number" data-number="5555555555">(555) 555-5555</a>}

iex> AutoLinker.link("Google Search", markdown: true) "<a href='http://google.com' class='auto-linker' target='_blank' rel='noopener noreferrer'>Google Search</a>"

See the Docs for more examples

Configuration

By default, link parsing is enabled and phone parsing is disabled.

# enable phone parsing, and disable link parsing
config :auto_linker, opts: [phone: true, url: false]

License

auto_linker is Copyright (c) 2017 - 2020 E-MetroTel

The source is released under the MIT License.

Check LICENSE for more information.