<query-box>
Polymer query editor widget webcomponent
Status
This is a work in progrees. You should consider the API and the internals unstable.
Demo
Install
Install the component using Bower:
$ bower install query-box --save
Or download as ZIP.
Usage
-
Import Web Components' polyfill:
<script src="bower_components/platform/platform.js"></script>
-
Import Custom Element:
<link rel="import" href="bower_components/query-box/dist/query-box.html">
-
Start using it!
<query-box></query-box>
Options
Attribute | Options | Default | Description |
---|---|---|---|
query |
list of objects | [] |
Eg: `[{field: "field1", operator: "==", target: "value", value: ""}] |
fields |
list of strings | [] |
The list of fields to make available in the query box. |
Development
In order to run it locally you'll need to fetch some dependencies and a basic server setup.
-
$ [sudo] npm install -g bower grunt-cli
-
Install local dependencies:
$ bower install && npm install
-
To test your project, start the development server and open
http://localhost:8000
.$ grunt server
-
To build the distribution files before releasing a new version.
$ grunt build
-
To provide a live demo, send everything to
gh-pages
branch.$ grunt deploy
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
History
For detailed changelog, check Releases.