2017-03-29 14:11:22 +00:00
|
|
|
# AutoLinker
|
|
|
|
|
|
2017-03-29 20:32:28 +00:00
|
|
|
[](https://travis-ci.org/smpallen99/auto_linker) [![Hex Version][hex-img]][hex] [![License][license-img]][license]
|
2017-03-29 20:27:13 +00:00
|
|
|
|
2017-03-29 20:32:28 +00:00
|
|
|
[hex-img]: https://img.shields.io/hexpm/v/auto_linker.svg
|
|
|
|
|
[hex]: https://hex.pm/packages/auto_linker
|
2017-03-29 20:27:13 +00:00
|
|
|
[license-img]: http://img.shields.io/badge/license-MIT-brightgreen.svg
|
|
|
|
|
[license]: http://opensource.org/licenses/MIT
|
|
|
|
|
|
2017-11-17 18:36:37 +00:00
|
|
|
AutoLinker is a basic package for turning website names, and phone numbers into links.
|
2017-03-29 20:27:13 +00:00
|
|
|
|
|
|
|
|
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.
|
2017-03-29 14:11:22 +00:00
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
2017-03-29 20:27:13 +00:00
|
|
|
The package can be installed by adding `auto_linker` to your list of dependencies in `mix.exs`:
|
2017-03-29 14:11:22 +00:00
|
|
|
|
|
|
|
|
```elixir
|
|
|
|
|
def deps do
|
2017-11-17 18:36:37 +00:00
|
|
|
[{:auto_linker, "~> 0.2"}]
|
2017-03-29 14:11:22 +00:00
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
2017-03-29 20:27:13 +00:00
|
|
|
## Usage
|
|
|
|
|
|
2017-11-17 18:36:37 +00:00
|
|
|
The following examples illustrate some examples on how to use the auto linker.
|
|
|
|
|
|
2017-03-29 20:27:13 +00:00
|
|
|
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>"
|
2017-11-17 18:36:37 +00:00
|
|
|
|
|
|
|
|
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>}
|
2017-03-29 20:27:13 +00:00
|
|
|
|
2018-01-23 00:46:47 +00:00
|
|
|
iex> AutoLinker.link("[Google Search](http://google.com)", markdown: true)
|
|
|
|
|
"<a href='http://google.com' class='auto-linker' target='_blank' rel='noopener noreferrer'>Google Search</a>"
|
|
|
|
|
|
2017-03-29 20:36:56 +00:00
|
|
|
See the [Docs](https://hexdocs.pm/auto_linker/) for more examples
|
2017-03-29 20:27:13 +00:00
|
|
|
|
2017-11-17 18:36:37 +00:00
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
By default, link parsing is enabled and phone parsing is disabled.
|
|
|
|
|
|
|
|
|
|
```elixir
|
|
|
|
|
# enable phone parsing, and disable link parsing
|
|
|
|
|
config :auto_linker, opts: [phone: true, url: false]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
2017-03-29 20:27:13 +00:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
`auto_linker` is Copyright (c) 2017 E-MetroTel
|
|
|
|
|
|
|
|
|
|
The source is released under the MIT License.
|
2017-03-29 14:11:22 +00:00
|
|
|
|
2017-03-29 20:27:13 +00:00
|
|
|
Check [LICENSE](LICENSE) for more information.
|
