1 | # jQuery QueryBuilder
|
2 |
|
3 | [![npm version](https://img.shields.io/npm/v/jQuery-QueryBuilder.svg?style=flat-square)](https://www.npmjs.com/package/jQuery-QueryBuilder)
|
4 | [![jsDelivr CDN](https://data.jsdelivr.com/v1/package/npm/jQuery-QueryBuilder/badge)](https://www.jsdelivr.com/package/npm/jQuery-QueryBuilder)
|
5 | [![Build Status](https://github.com/mistic100/jQuery-QueryBuilder/workflows/CI/badge.svg)](https://github.com/mistic100/jQuery-QueryBuilder/actions)
|
6 | [![gitlocalized](https://gitlocalize.com/repo/5259/whole_project/badge.svg)](https://gitlocalize.com/repo/5259/whole_project?utm_source=badge)
|
7 |
|
8 | jQuery plugin offering an simple interface to create complex queries.
|
9 |
|
10 | [![screenshot](https://raw.githubusercontent.com/mistic100/jQuery-QueryBuilder/master/examples/screenshot.png)](https://querybuilder.js.org)
|
11 |
|
12 |
|
13 |
|
14 | ## Documentation
|
15 | [querybuilder.js.org](https://querybuilder.js.org)
|
16 |
|
17 |
|
18 |
|
19 | ## Install
|
20 |
|
21 | #### Manually
|
22 |
|
23 | [Download the latest release](https://github.com/mistic100/jQuery-QueryBuilder/releases)
|
24 |
|
25 | #### With npm
|
26 |
|
27 | ```bash
|
28 | $ npm install jQuery-QueryBuilder
|
29 | ```
|
30 |
|
31 | #### Via CDN
|
32 |
|
33 | jQuery-QueryBuilder is available on [jsDelivr](https://www.jsdelivr.com/package/npm/jQuery-QueryBuilder).
|
34 | ### Dependencies
|
35 | * [jQuery 3](https://jquery.com)
|
36 | * [Bootstrap 5](https://getbootstrap.com/docs/5.3/) CSS and bundle.js which includes `Popper` for tooltips and popovers
|
37 | * [Bootstrap Icons](https://icons.getbootstrap.com/)
|
38 | * [jQuery.extendext](https://github.com/mistic100/jQuery.extendext)
|
39 | * [MomentJS](https://momentjs.com) (optional, for Date/Time validation)
|
40 | * [SQL Parser](https://github.com/mistic100/sql-parser) (optional, for SQL methods)
|
41 | * Other Bootstrap/jQuery plugins used by plugins
|
42 |
|
43 | ($.extendext is directly included in the [standalone](https://github.com/mistic100/jQuery-QueryBuilder/blob/master/dist/js/query-builder.standalone.js) file)
|
44 |
|
45 |
|
46 |
|
47 | ## Developement
|
48 |
|
49 | Install Node dependencies with `npm install`.
|
50 |
|
51 | #### Build
|
52 |
|
53 | Run `npm run build` in the root directory to generate production files inside `dist`.
|
54 |
|
55 | #### Serve
|
56 |
|
57 | Run `npm run serve` to open the example page with automatic build and livereload.
|
58 |
|
59 |
|
60 | ## License
|
61 | This library is available under the MIT license.
|