Skip to content

ionelmc/polymer-query-box

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

<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!

Install

Install the component using Bower:

$ bower install query-box --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/platform/platform.js"></script>
  2. Import Custom Element:

    <link rel="import" href="bower_components/query-box/dist/query-box.html">
  3. 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.

  • Install Bower & Grunt:

    $ [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

  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.

License

MIT License

About

Query editor widget implemented as a Polymer webcomponent

Resources

Stars

Watchers

Forks

Packages

No packages published