Archived

No description

This repository has been archived on 2024-06-09. You can view files and clone it, but cannot push or open issues or pull requests.

Find a file

Stephen M. Pallen 10cf319731 update parser		2017-12-10 19:37:28 -05:00
config	create project and some linker impl	2017-03-29 10:11:22 -04:00
lib	update parser	2017-12-10 19:37:28 -05:00
test	add phone number linking	2017-11-17 13:36:37 -05:00
.gitignore	create project and some linker impl	2017-03-29 10:11:22 -04:00
.travis.yml	update elixir verison in travis	2017-03-29 16:56:03 -04:00
LICENSE	prep for first release	2017-03-29 16:27:13 -04:00
mix.exs	add phone number linking	2017-11-17 13:36:37 -05:00
mix.lock	add phone number linking	2017-11-17 13:36:37 -05:00
README.md	add phone number linking	2017-11-17 13:36:37 -05:00

AutoLinker

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, "~> 0.2"}]
end

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

iex> AutoLinker.link("google.com") "google.com"

iex> AutoLinker.link("google.com", new_window: false, rel: false) "google.com"

iex> AutoLinker.link("google.com", new_window: false, rel: false, class: false) "google.com"

iex> AutoLinker.link("call me at x9999") ~s{call me at x9999}

iex> AutoLinker.link("or at home on 555.555.5555") ~s{or at home on 555.555.5555}

iex> AutoLinker.link(", work (555) 555-5555") ~s{, work (555) 555-5555}

See the Docs for more examples

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]

The source is released under the MIT License.

Check LICENSE for more information.