asva-vue-filters

Vue Filter Block

Bundle of several mixins and coomponents aimed to simplify table sorting in vue.js applications. Take a look at the demo.

Features

• No duplication (you set filters only in template).
• State support (local storage). Version safe, extensible to multiple states.
• Throttling.

Installing

npm install vue-filter-block

Getting Started

As it's not a plugin, you don't have to install much. Just require the package when needed:

var vueFilterBlock = require('vue-filter-block')

Getting started

Let's assume you have a table and you want to add some filters on top of it. To sort by name and date, for instance. The component for parent mixin is one that contains both table and filters.

vueFilterBlock.mixins.child is used for every filter in filters. Take a look into components/filters for usage hints.

Demo

Yes, we have a demo.

Components

In demo every component has line such as vm-wrapper-filter. Just convert it into camelCase and you have correct import name:

import {vmWrapperFilter} from 'asva-vue-filters'

Then you can add component to parent:

components: {
    vmWrapperFilter
}

Prerequisities

Required npm packages:

• lockr
• lodash
• vue

You probably will also require bundling solution such as webpack or browserify.

TODO

• Filter group.

Contributing

• Fork it!
• Create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -am 'Add some feature'
• Push to the branch: git push origin my-new-feature
• Submit a pull request.

History

• 15.04.2016 (0.0.1): Initial commit.
• 26.04.2016 (0.3.0): Add filter wrapper component.
• 11.06.2016 (1.0.0): Add jasmine tests.

Credits

• Yauheni Prakopchyk - Asva

License

This project is licensed under the MIT License