Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paulpflug/vue-filters
A collection of filters for vue
https://github.com/paulpflug/vue-filters
Last synced: 4 months ago
JSON representation
A collection of filters for vue
- Host: GitHub
- URL: https://github.com/paulpflug/vue-filters
- Owner: paulpflug
- Created: 2016-02-12T22:28:15.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-24T12:00:11.000Z (almost 8 years ago)
- Last Synced: 2024-10-21T00:40:38.770Z (4 months ago)
- Language: CoffeeScript
- Size: 13.7 KB
- Stars: 15
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-vue-cn - vue-filters ★2
README
# DEPRECATED
# vue-filters
A collection of filters for vue.
## Policy
all sorts of filters can be submitted. There will be no removes because of deprecation. If the API of a filter changes, the name has to change.
## Install
```sh
npm install --save-dev vue-filters
```
or include `bundle.js`
## Usage
```coffee
## whithin your module
components:
filters:
escape: require("vue-filters/escape")
# if you have used the bundle.js
components:
filters:
escape: window.vueFilters.escape
```
## List of filters
| Name | arguments| description |
| ---: | ------ | ------- |
| escape | string | turns `&`,`<` and `>` to `&`, `<` and `>` (usage [raw html](http://vuejs.org/guide/syntax.html#Raw_HTML))|
| nl2br | string | turns `\n` to `
` (usage [raw html](http://vuejs.org/guide/syntax.html#Raw_HTML))|
| byObject | array, object | only entries in the array matching all keys and values of the provided object will be included|
| notPrevented | function | only call function when `event.defaultPrevented` is false |
| prevent | function | call function and call `event.preventDefault()` afterwards |
## Detailed usage
### byObject
```html
// dynamic
// or just pass an object from your Vue instance
```
### notPrevented
read: https://css-tricks.com/dangers-stopping-event-propagation/
```html
// when clicked on the child, parentClick won't be called
```
### prevent
read: https://css-tricks.com/dangers-stopping-event-propagation/
```html
// won't work
// will work
```
## Develop
Clone rep
```
npm install
```
Available scripts:
```
npm run build # compiles coffee-script in src/
npm run test # runs a single-run karma in chrome and firefox
npm run watch # runs karma in chrome (uses src/*.coffee files direclty, no need for build)
# to run only single tests:
karma start --browsers Chrome --auto-watch --reporters spec --files ['test/onClick.coffee']
```
## License
Copyright (c) 2015 Paul Pflugradt
Licensed under the MIT license.