https://github.com/williamboman/angular-slugify
Provides "slugification" for AngularJS. "wb-angular-slugify" on Bower.
https://github.com/williamboman/angular-slugify
Last synced: 3 months ago
JSON representation
Provides "slugification" for AngularJS. "wb-angular-slugify" on Bower.
- Host: GitHub
- URL: https://github.com/williamboman/angular-slugify
- Owner: williamboman
- License: mit
- Fork: true (paulsmith/angular-slugify)
- Created: 2014-06-10T17:53:25.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-06-07T10:31:49.000Z (over 10 years ago)
- Last Synced: 2025-10-13T21:39:51.242Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 493 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
***This is an _active_ fork that fixes some issues and has new features. It has its own bower/npm package (wb-angular-slugify).***
# angular-slugify
Provides “slugification” for AngularJS in the form of a service, filter, and
a directive.
## What is a slug?
A slug is that final portion of a URL which is derived from some other piece of
information, usually the title of a page.
For example, “Man Bites Dog” might produce the slug `man-bites-dog` for the URL:
`http://example.com/2013/04/man-bites-dog.html`
## Demo
[Click here for demo](http://paulsmith.github.io/angular-slugify/).
## Installation
### Bower
```bash
$ bower install wb-angular-slugify
```
### npm
```bash
$ npm install wb-angular-slugify
```
### Download
[Click here to download.](https://github.com/williamboman/angular-slugify/releases/download/v1.2.0/angular-slugify.min.js)
## Usage
Make `slugifier` a dependency in your AngularJS app.
```js
angular.module("myApp", ["slugifier"]);
```
### Service
The `Slug` service provides a single function `slugify` that takes a string
input as argument and returns the slugified string.
```js
function MyCtrl($scope, Slug) {
$scope.slugify = function(input) {
$scope.mySlug = Slug.slugify(input);
};
}
```
### Filter
The `slugify` filter slugifies any text passed to it in an AngularJS curly-brace
expression.
```html
Slug: {{title | slugify}}
```
### Directive
The `slug` directive is a way to declaratively say one model is the
slugification of another.
```html
My slug is {{post.slug}}
It also works out here: {{post.slug}}
```
The `from` attribute is the name of the model in the current scope you want to
slugify. The `to` attribute is the name of the model you want to be
automatically updated with the slugification whenever `from` changes.
## Tests
```bash
$ grunt test:dist
$ grunt test:dev
# Or test both
$ grunt test
```
## License
Copyright © 2013 Paul Smith
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.