https://github.com/johno/ember-linkify

Linkify urls in an Ember app with a fancy helper
https://github.com/johno/ember-linkify

Last synced: 3 months ago
JSON representation

Linkify urls in an Ember app with a fancy helper

• Host: GitHub
• URL: https://github.com/johno/ember-linkify
• Owner: johno
• License: mit
• Created: 2014-11-18T02:02:44.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2023-06-08T12:17:49.000Z (over 1 year ago)
• Last Synced: 2024-10-09T09:58:33.780Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 155 KB
• Stars: 22
• Watchers: 6
• Forks: 30
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ember-linkify [![Build Status](https://travis-ci.org/johnotander/ember-linkify.svg?branch=master)](https://travis-ci.org/johnotander/ember-linkify) [![Ember Observer Score](http://emberobserver.com/badges/ember-linkify.svg)](http://emberobserver.com/addons/ember-linkify)

Linkify URLs in an Ember app with a helper that uses a tested

[url-regex](https://github.com/kevva/url-regex) and Handlebars `Utils.escapeExpression`

to ensure links are safe.

Installation

------------------------------------------------------------------------------

```

ember install ember-linkify

```

## Usage

```hbs

{{linkify post.description}}

```

```hbs

{{linkify commentText}}

```

##### Use the helper with a raw string

```hbs

{{linkify 'Here is a link: https://google.com and some attempted XSS alert("xss!");'}}

{{! => 'Here is a link: https://google.com and some attempted XSS <script>alert("xss!");</script>'}}

```

##### Or with a variable bound to an input

```hbs

{{textarea value=text placeholder='Enter some text with a url'}}

{{linkify text}}

```

##### You can specify options to the helper such as 'urlLength' which shortens the URL by 'urlLength' and add 3 dots to the end 

```hbs

{{linkify text urlLength=30}}

```

##### The 'defaultScheme' option specifies a scheme to use for URLs that don’t already have one.

For instance, the following will ensure that the `https` scheme is used for the created link:

```hbs

{{linkify 'Link without a scheme: www.foo.com' defaultScheme='https'}}

```

##### Also use options to specify attributes you want to add to the generated anchor tags. Currently, "target", "rel" and "class" are the only recognized attributes.

```hbs

{{linkify text target='_blank' rel='nofollow' class='external-link'}}

```

## Development

### Installation

* `git clone` this repository

* `cd my-addon`

* `npm install`

### Running

* `ember server`

* Visit your app at [http://localhost:4200](http://localhost:4200).

### Running Tests

* `ember test`

* `ember test --server`

* `ember try:each` – Runs the test suite against multiple Ember versions

### Building

* `ember build`

For more information on using `ember-cli`, visit [http://www.ember-cli.com/](http://www.ember-cli.com/).

## License

MIT

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

***

> Crafted with <3 by [John Otander](http://johnotander.com)([@4lpine](https://twitter.com/4lpine)).