AutoLinker v0.2.1 AutoLinker
Create url links from text containing urls.
Turns an input string like "Check out google.com"
into
Check out "<a href='http://google.com' target='_blank' rel='noopener noreferrer'>google.com</a>"
Examples
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>"
Link to this section Summary
Functions
Auto link a string
Link to this section Functions
Link to this function
link(text, opts \\ [])
Auto link a string.
Options:
class: "auto-linker"
- specify the class to be added to the generated link. false to clearrel: "noopener noreferrer"
- override the rel attribute. false to clearnew_window: true
- set to false to removetarget='_blank'
attributescheme: false
- Set to true to link urls with schemahttp://google
truncate: false
- Set to a number to truncate urls longer then the number. Truncated urls will end in..
strip_prefix: true
- Strip the scheme prefixexclude_class: false
- Set to a class name when you don’t want urls auto linked in the html of the give classexclude_id: false
- Set to an element id when you don’t want urls auto linked in the html of the give elementexclude_patterns: ["```"] - Don't link anything between the the pattern Each of the above options can be specified when calling
link(text, opts)or can be set in the
:auto_linker’s configuration. For example:config :auto_linker, class: false, new_window: false
Note that passing opts to link/2
will override the configuration settings.