Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion demo.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h1 id="widgets" class="page-header">
Widgets
</h1>

<p>This demo shows how to integrates widgets into QueryBuilder rules. Widgets used are <a
<p>This demo shows how to integrate widgets into QueryBuilder rules. Widgets used are <a
href="https://github.com/eternicode/bootstrap-datepicker">Bootstrap Datepicker</a>,
<a href="https://github.com/seiyria/bootstrap-slider">Bootstrap Slider</a> and <a
href="https://github.com/brianreavis/selectize.js">Selectize</a>.<br>
Expand Down
2 changes: 1 addition & 1 deletion dev/events.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ <h1 id="intro" class="page-header">
when a validation error happens. The events system is also used by plugins.</p>

<p>There are two types of events: <b>triggers</b> are used to identify a point in the code and <b>changers</b> are
used to modify a value before it used (eg: template, output rules). Both types are used the same way with the jQuery
used to modify a value before it is used (eg: template, output rules). Both types are used the same way with the jQuery
<code>on</code> method on the builder container.</p>

<div class="bs-callout bs-callout-info">
Expand Down
6 changes: 3 additions & 3 deletions dev/plugins.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ <h1 id="intro" class="page-header">
to offer a plugins system.</p>
<p>Plugins can simply add public methods or make use of events to change the behavior of the builder.</p>

<p>Each plugin is a folder in <code>plugins</code> directory, it contains at least a <code>plugin.js</code> file and
optionally a <code>plugin.scss</code> file and a <code>i18n</code> folder. Everything needed to the plugin operation
<p>Each plugin is a folder in the <code>plugins</code> directory, which contains at least a <code>plugin.js</code> file and
optionally a <code>plugin.scss</code> file and a <code>i18n</code> folder. Everything needed for the plugin to operate
must be contained in these two files (but third-party dependencies of course).</p>

<p>Plugins are included in the <code>dist</code> files by the Grunt task (depending on <b>plugins</b> build option)
Expand Down Expand Up @@ -140,7 +140,7 @@ <h1 id="javascript" class="page-header">

<p>The plugins' SCSS files are imported at the end of the core SCSS, allowing you to use all defined variable. One
interesting variable is <code>$theme-name</code> which contains... the theme name (currently "default" or "dark")
you can use to make conditionnal formating.</p>
you can use to make conditional formatting.</p>

<b>Basic SCSS from Filter Description plugin :</b>
<!-- @formatter:off -->
Expand Down
26 changes: 13 additions & 13 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -628,12 +628,12 @@ <h3 id="methods">Methods</h3>
{% endhighlight %}
<!-- @formatter:on -->

<p>Only main methods are described are.</p>
<p>Only main methods are described.</p>

<div class="bs-callout">
<h4><code>.validate()</code></h4>

<p>Returns a boolean whereas the builder is valid or not. Use the <code>validationError</code> event to catch
<p>Returns a boolean indicating whether the builder is valid or not. Use the <code>validationError</code> event to catch
per-rule validation errors. If <code>display_errors</code> is enabled the invalid rules will turn red.</p>
</div>

Expand Down Expand Up @@ -688,7 +688,7 @@ <h4>Other formats</h4>
<div class="bs-callout">
<h4><code>.setRules(rules)</code></h4>

<p>Clears the builder and set new rules. The parameters must have the same structure has the output of <code>getRules</code>.
<p>Clears the builder and sets new rules. The parameters must have the same structure as the output of <code>getRules</code>.
<a data-bootbox="rules_format"> <i class="glyphicon glyphicon-info-sign"></i> See an example</a></p>
<!-- @formatter:off -->
{% highlight javascript %}
Expand Down Expand Up @@ -884,8 +884,8 @@ <h3 id="themes">Themes</h3>
<p>QueryBuilder comes with two colors-schemes: <a href="{{site.rawUrl}}/dist/css/query-builder.default.min.css"
target="_blank"><i class="glyphicon glyphicon-file"></i> default</a>
(clear) and <a href="{{site.rawUrl}}/dist/css/query-builder.dark.min.css" target="_blank"><i
class="glyphicon glyphicon-file"></i> dark</a>. Change the active theme by switching stylesheet, you cannot use
the two colors-schemes on the same page.</p>
class="glyphicon glyphicon-file"></i> dark</a>. Change the active theme by switching stylesheets. You cannot use
both color-schemes on the same page.</p>
</section>

<section class="bs-docs-section">
Expand All @@ -895,7 +895,7 @@ <h1 id="advanced" class="page-header">

<h3 id="operators">Operators</h3>

<p>QueryBuilder is bundle with an <a data-bootbox="default_operators"><i class="glyphicon glyphicon-info-sign"></i>
<p>QueryBuilder is bundled with an <a data-bootbox="default_operators"><i class="glyphicon glyphicon-info-sign"></i>
extensive list of operators</a>. You can change which operators are available for each filter (see <a
href="#filters">filters</a> configuration) but you can also modify/reorder the operators globally and even add new
custom operators.</p>
Expand All @@ -916,7 +916,7 @@ <h3 id="operators">Operators</h3>
<tr>
<td>type</td>
<td>string</td>
<td>Identifier of the operator, use the <code>lang.operators</code> to translate give a human readable name to
<td>Identifier of the operator, use the <code>lang.operators</code> to translate or give a human readable name to
your operator.
</td>
</tr>
Expand Down Expand Up @@ -1072,15 +1072,15 @@ <h3 id="icons">Icons</h3>

<h3 id="templates">Templates</h3>

<p>For very custom customizations, QueryBuilder provides a way to completely overwrite de HTML templates used to
display rules and groups. It uses the <a href="http://olado.github.io/doT">doT.js</a> template engine by default but
<p>For very custom customizations, QueryBuilder provides a way to completely overwrite the HTML templates used to
display rules and groups. It uses the <a href="http://olado.github.io/doT">doT.js</a> template engine by default, but
can be used with most JS template engines, like <i>underscore.js</i> one.</p>

<div class="bs-callout bs-callout-danger">
<h4>Very advanced feature</h4>

<p>Modifying templates can leads to a not functionnal builder if the general layout differs too much. Particularly
you should keep all CSS classes which are not part of Bootstrap.</p>
<p>Modifying templates can lead to a non-functionnal builder if the general layout differs too much. In particular,
non-Bootstrap CSS classes should not be removed.</p>
</div>

<p>Templates can be provided as a <a href="http://olado.github.io/doT/#samples">doT.js template string</a> or as a
Expand Down Expand Up @@ -1140,8 +1140,8 @@ <h4>operatorSelect</h4>

<h3 id="inside_the_box">Inside the box</h3>

<p>You might have noticed that callbacks and events reffer to two objects <b>Rule</b> and <b>Group</b>. These objects
are part of the data model with partial data-binding used internally by QueryBuilder. Here the structure of these
<p>You might have noticed that callbacks and events refer to two objects <b>Rule</b> and <b>Group</b>. These objects
are part of the data model with partial data-binding used internally by QueryBuilder. Here are the structures of these
two objects. Most attributes will live-update the builder when modified.</p>

<div class="container-fluid">
Expand Down
2 changes: 1 addition & 1 deletion plugins.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h1 id="presentation" class="page-header">
{% endhighlight %}
<!-- @formatter:on -->

<p>You can find bellow the plugins shipped by default with QueryBuilder, with their identifiers.</p>
<p>Below you can find the plugins shipped by default with QueryBuilder, with their identifiers.</p>

<p><b>Want to create a new plugin ?</b> Check our <a href="{{site.github.url}}/dev/plugins.html">developer doc</a>.
</p>
Expand Down