https://github.com/ionelmc/polymer-query-box
Query editor widget implemented as a Polymer webcomponent
https://github.com/ionelmc/polymer-query-box
Last synced: 7 months ago
JSON representation
Query editor widget implemented as a Polymer webcomponent
- Host: GitHub
- URL: https://github.com/ionelmc/polymer-query-box
- Owner: ionelmc
- Created: 2014-07-24T12:13:46.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2014-09-26T16:20:49.000Z (about 11 years ago)
- Last Synced: 2025-02-24T22:04:35.892Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 914 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# <query-box>
> Polymer query editor widget webcomponent
## Status
This is a work in progrees. You should consider the API and the internals unstable.
## Demo
[Check it live!](http://ionelmc.github.io/polymer-query-box)
## Install
Install the component using [Bower](http://bower.io/):
```sh
$ bower install query-box --save
```
Or [download as ZIP](https://github.com/ionelmc/polymer-query-box/archive/master.zip).
## Usage
1. Import Web Components' polyfill:
```html
```
2. Import Custom Element:
```html
```
3. Start using it!
```html
```
## 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.
* Install [Bower](http://bower.io/) & [Grunt](http://gruntjs.com/):
```sh
$ [sudo] npm install -g bower grunt-cli
```
* Install local dependencies:
```sh
$ bower install && npm install
```
* To test your project, start the development server and open `http://localhost:8000`.
```sh
$ grunt server
```
* To build the distribution files before releasing a new version.
```sh
$ grunt build
```
* To provide a live demo, send everything to `gh-pages` branch.
```sh
$ grunt deploy
```
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## History
For detailed changelog, check [Releases](https://github.com/ionelmc/polymer-query-box/releases).
## License
[MIT License](http://opensource.org/licenses/MIT)