aurelia-filter
v3.0.0
Published
A plugin for aurelia to populate search/filter criteria. Works well with aurelia-orm.
Downloads
98
Maintainers
Readme
aurelia-filter
A plugin for aurelia to populate search/filter criteria. Works well with aurelia-orm and aurelia-filter
Features:
- Conditional
AND
andOR
blocks - Dynamic input type casting
- All sailsJS operators
- ORM entities
- And more
Breaking changes
v3.0 of aurelia-filter uses the latest version of aurelia-form.
Uses
aurelia-filter needs following plugins installed and configured:
Documentation
You can find usage examples and the documentation here.
The changelog provides you with information about important changes.
Example
Here's a snippet to give you an idea of what this module supports.
@bindable columns = [
{name : "id", value: "id", type: 'number'},
{name : "Name", value: "name", type: 'text'},
{name : "Created at", value: "createdAt", type: 'date'},
// For enumeration
{name : "State", value: "state", type: 'select'}
];
<filter columns.bind="columns" criteria.bind="criteria"></filter>
or:
this.userEntity = entityManager.getEntity('users');
<filter entity.bind="userEntity" criteria.bind="criteria" exclude-columns="password, createdAt"></filter>
Installation
Aureli-Cli
Run npm i aurelia-filter --save
from your project root.
Aurelia-filter uses extend
, soa add following to the build.bundles.dependencies
section of aurelia-project/aurelia.json
:
"dependencies": [
"extend",
{
"name": "aurelia-filter",
"path": "../node_modules/aurelia-filter/dist/amd",
"main": "aurelia-filter",
"resources": [
"bootstrap/filter.html"
]
},
// ...
],
Jspm
Run jspm i aurelia-filter
from your project root.
Aurelia-filter uses extend
, so add following to the bundles.dist.aurelia.includes
section of build/bundles.js
:
"extend",
"aurelia-filter",
"[aurelia-filter/**/*.js]",
"aurelia-filter/**/*.html!text",
If the installation results in having forks, try resolving them by running:
jspm inspect --forks
jspm resolve --only registry:package-name@version
Webpack
Run npm i aurelia-filter --save
from your project root.
And add aurelia-filter
in the coreBundles.aurelia
section of your webpack.config.js
.
Typescript
Npm-based installations pick up the typings automatically. For Jspm-based installations, run typings i github:spoonx/aurelia-filter
or add "aurelia-filter": "github:spoonx/aurelia-filter",
to your typings.json
and run typings i
.