Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hypercontext/linkifyjs
JavaScript plugin for finding links in plain-text and converting them to HTML <a> tags.
https://github.com/hypercontext/linkifyjs
autolink email html javascript jquery-plugin linkify nodejs react url
Last synced: 30 days ago
JSON representation
JavaScript plugin for finding links in plain-text and converting them to HTML <a> tags.
- Host: GitHub
- URL: https://github.com/hypercontext/linkifyjs
- Owner: Hypercontext
- License: mit
- Created: 2013-05-02T23:28:54.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2023-11-22T03:40:24.000Z (12 months ago)
- Last Synced: 2024-09-26T19:25:13.979Z (about 2 months ago)
- Topics: autolink, email, html, javascript, jquery-plugin, linkify, nodejs, react, url
- Language: JavaScript
- Homepage: https://linkify.js.org
- Size: 3.94 MB
- Stars: 1,830
- Watchers: 24
- Forks: 182
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Linkify
[](https://www.npmjs.com/package/linkifyjs)
[](https://github.com/Hypercontext/linkifyjs/actions/workflows/ci.yml)
[](https://automate.browserstack.com/public-build/alN1cUFSYVI3Yitudjh6NkJuNURhVy9sRHQ0RXE2L0t2RWpDY3lHM3Rtbz0tLVZScU8rRHAyMWRoYjVVY000elJybHc9PQ==--35ad6d7d5981f5bc0efdb7b6ba78972d8174e7e5)
[](https://coveralls.io/github/Hypercontext/linkifyjs?branch=main)
Linkify is a JavaScript plugin. Use Linkify to find links in plain-text and
convert them to HTML <a> tags. It automatically highlights URLs,
#hashtags, @mentions and more.
__Jump to__
- [Features](#features)
- [Demo](#demo)
- [Installation and Usage](#installation-and-usage)
- [Browser Support](#browser-support)
- [Node.js Support](#nodejs-support)
- [Downloads](#downloads)
- [API Documentation](#api-documentation)
- [Contributing](#contributing)
- [License](#license)
## Features
* Detect URLs and email addresses
* #hashtag, @mention and #-ticket plugins
* React and jQuery support
* Multi-language and emoji support
* Custom link plugins
* Fast, accurate and small footprint (~20kB minified, ~11kB gzipped)
* 99% test coverage
* Compatible with all modern browsers (Internet Explorer 11 and up)
## Demo
[Launch demo](https://linkify.js.org/#demo)
## Installation and Usage
[View full documentation](https://linkify.js.org/docs/).
Download the [latest release](https://github.com/Hypercontext/linkifyjs/releases) for direct use in the browser, or install via [NPM](https://www.npmjs.com/):
```
npm install linkifyjs linkify-html
```
### Quick Start
When developing in an environment with JavaScript module loader such as Webpack,
use an `import` statement:
```js
import * as linkify from 'linkifyjs';
import linkifyHtml from 'linkify-html';
```
Or in Node.js with CommonJS modules
```js
const linkify = require('linkifyjs');
const linkifyHtml = require('linkify-html');
```
**Note:** When linkify-ing text that does not contain HTML, install and use the
`linkify-string` package instead of `linkify-html`. [Read more about Linkify's
interfaces](https://linkify.js.org/docs/interfaces.html).
### Usage
#### Example 1: Convert all links to <a> tags in the given string
```js
const options = { defaultProtocol: 'https' };
linkifyHtml('Any links to github.com here? If not, contact [email protected]', options);
```
Returns the following string:
```js
'Any links to github.com here? If not, contact [email protected]'
```
To modify the resulting links with a target attribute, class name and more, [use
the available options](https://linkify.js.org/docs/options.html).
#### Example 2: Find all links in the given string
```js
linkify.find('Any links to github.com here? If not, contact [email protected]');
```
Returns the following array
```js
[
{
type: 'url',
value: 'github.com',
isLink: true,
href: 'http://github.com',
start: 13,
end: 23
},
{
type: 'email',
value: '[email protected]',
isLink: true,
href: 'mailto:[email protected]',
start: 46,
end: 62
}
]
```
#### Example 3: Check whether a string is a valid link:
Check if as string is a valid URL or email address:
```js
linkify.test('github.com'); // true
```
Check if a string is a valid email address:
```js
linkify.test('github.com', 'email'); // false
linkify.test('[email protected]', 'email'); // true
```
### Usage with React, jQuery or the browser DOM
[Read the interface documentation](https://linkify.js.org/docs/interfaces.html) to learn how to use linkify when working with a specific JavaScript environment such as React.
### Plugins for @mentions, #hashtags and more
By default Linkify will only detect and highlight web URLs and e-mail addresses.
Plugins for @mentions, #hashtags and more may be installed separately. [Read the
plugin documentation](https://linkify.js.org/docs/plugins.html).
## Browser Support
Linkify natively supports all modern browsers.
## Node.js Support
Linkify is tested on Node.js 14 and up. Older Node.js versions are unofficially
supported.
## Downloads
Download the [**latest release**](https://github.com/Hypercontext/linkifyjs/releases)
## API Documentation
View full documentation at [linkify.js.org/docs](https://linkify.js.org/docs/)
## Contributing
Check out [CONTRIBUTING.md](https://github.com/Hypercontext/linkifyjs/blob/main/CONTRIBUTING.md).
## License
MIT
## Authors
Linkify is made with ❤️ by [Hypercontext](https://hypercontext.com/) and [@nfrasser](https://github.com/nfrasser)