config | ||
lib | ||
test | ||
.formatter.exs | ||
.gitignore | ||
.travis.yml | ||
LICENSE | ||
mix.exs | ||
mix.lock | ||
README.md |
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
Usage
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}
iex> AutoLinker.link("Google Search", markdown: true) "Google Search"
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 E-MetroTel
The source is released under the MIT License.
Check LICENSE for more information.