1- # Angular URL-Encode Filter
1+ # angular-url-encode
22
3- A simple Angular filter to encode or decode a string using ` encodeURI ` and ` decodeURI ` .
3+ [ ![ MIT License ] [ license_image ]] [ license_url ] [ ![ NPM version ] [ npm_version_image ]] [ npm_url ]
44
5- [ ** Demo on Plunker** ] ( http://plnkr.co/edit/oPJZWt?p=preview )
5+ :arrows_counterclockwise : A simple Angular filter to URL-encode or decode a string using ` encodeURI `
6+ and ` decodeURI ` .
7+ 8+ > [ ** :tv : Demo** ] [ demo ]
9+
10+ _ [ Comments and Pull Requests welcome!] [ issues ] _
11+ 12+ ---
13+ 14+ ## Contents
15+ 16+ - [ Installation] ( #installation )
17+ - [ Dependencies] ( #dependencies )
18+ - [ Usage] ( #usage )
19+ - [ Development] ( #development )
20+ 21+ ## Dependencies
22+ 23+ - AngularJS (^1.4.0)
624
725
826## Installation
927
10- ` $ bower install angular-url-encode --save `
28+ #### NPM
1129
12- Add ` bc.AngularUrlEncode ` to your module's dependencies:
30+ ``` bash
31+ $ npm install angular-url-encode --S
32+ ```
1333
34+ #### Bower
35+ 36+ ``` bash
37+ $ bower install angular-url-encode --S
1438```
39+ 40+ #### Manually
41+ 42+ Add the script and styles to your HTML:
43+ 44+ ``` html
45+ <script src =" ../path/to/angular-url-encode/dist/angular-url-encode.js" script >
46+ ```
47+ 48+ Add ` bc.AngularUrlEncode ` to your module's dependencies:
49+ 50+ ``` javascript
1551angular .module (' myModule' ' bc.AngularUrlEncode'
1652```
1753
1854
1955## Usage
2056
57+ #### HTML
58+ 2159As a filter in the DOM:
2260
23- ```
24- {{ myPlainString | bcEncode }}
25- {{ encodedString | bcDecode }}
61+ ``` html
62+ < p > {{ myPlainString | bcEncode }}</ p >
63+ < p > {{ encodedString | bcDecode }}</ p >
2664```
2765
28- Using the ` $filter ` service in JS:
66+ #### JavaScript
2967
30- ```
68+ Using the ` $filter ` service:
69+ 70+ ``` javascript
3171// Encode
32- this.encodedString = $filter('bcEncode')(myPlainString);
72+ this .encodedString = $filter (' bcEncode' this . myPlainString );
3373
3474// Decode
35- this.decodedString = $filter('bcDecode')(encodedString);
75+ this .decodedString = $filter (' bcDecode' this . encodedString );
3676```
3777
3878
3979- - -
4080
4181
42- ### Development Scripts
82+ ## Development
4383
4484* ` npm run build ` - produces production version of your library under the ` dist ` folder
4585* ` npm run dev ` - produces development version of your library and runs a watcher
@@ -48,6 +88,10 @@ this.decodedString = $filter('bcDecode')(encodedString);
4888- - -
4989
5090
51- [ All idea and code contributions
52- welcome!] ( https://github.com/benjamincharity/angular-url-encode/issues )
91+ [ demo ] : http://codepen.io/benjamincharity/pen/wzyNqQ?editors=1000
92+ [ issues ] : https://github.com/benjamincharity/angular-url-encode/issues
93+ [ license_image ] : http://img.shields.io/badge/license-MIT-blue.svg
94+ [ license_url ] : LICENSE
95+ [ npm_url ] : https://npmjs.org/package/angular-url-encode
96+ [ npm_version_image ] : http://img.shields.io/npm/v/angular-url-encode.svg
5397
0 commit comments