https://github.com/garrettmac/angular-slugs
A tool to help manage and convert text into slugs and converting slugs into text through a service, filter, and a directive.
https://github.com/garrettmac/angular-slugs
Last synced: 2 months ago
JSON representation
A tool to help manage and convert text into slugs and converting slugs into text through a service, filter, and a directive.
- Host: GitHub
- URL: https://github.com/garrettmac/angular-slugs
- Owner: garrettmac
- Created: 2016-03-05T22:48:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-03-05T23:41:31.000Z (over 9 years ago)
- Last Synced: 2025-03-21T15:13:59.496Z (3 months ago)
- Size: 6.84 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# angular-slug
[Inspired by paulsmith's angular-slugify](https://github.com/paulsmith/angular-slugify) angular-slugs converts converts text into slugs or slugs into text with desired capitalization through a service and filter.
## Installation
You can install the filter using [Bower](http://bower.io/):
```bash
$ bower install angular-slugs
```
Or [npm](https://www.npmjs.com/):
```bash
$ npm install angular-slugs
```
Then you have to include it in your HTML:
```html
```
And inject the desired modules into your application:
```js
angular.module('webApp', ['capitalizer','slugifier','unslugifier']);
```
## Service
The `Slug` service provides a single function `slug` that takes a string
input as argument and returns the slugified string.
```js
function MyCtrl($scope, Slug) {
$scope.slug = function(input) {
$scope.mySlug = Slug.slug(input);
};
}
```
or
```js
function MyCtrl($scope, Unslug) {
$scope.unslug = function(input) {
$scope.myUnslug = Unslug.slug(input);
};
}
```
### Filter
To use add a `slug` or `unslug` pipe filter in your AngularJS curly-brace
expression.
Filters `hello world` to `hello-world`
```html
Slug: {{msg | slug}}
```
Filters `hello-world` to `hello world`
```html
Unslug: {{msg | unslug}}
```
Filters `hello world` to `Hello world`
```html
Unslug: {{msg | unslug| capitalize}}
```
Filters `hello world` to `Hello World`
```html
Unslug: {{msg | unslug| capitalize:true}}
```
## Capitalize
You can use it like any other AngularJS filter:
First word only:
```html
{{msg | capitalize}}
```
First Letter In All Words:
```html
{{msg | capitalize:true}}
```
## License
Copyright © 2016 Garrett M.
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.
# angular-slugs