You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONFIG.adoc
+28-2
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,16 @@
2
2
:toc-placement!:
3
3
toc::[]
4
4
5
+
ifdef::env-github[]
6
+
:tip-caption: :bulb:
7
+
:note-caption: :information_source:
8
+
:important-caption: :heavy_exclamation_mark:
9
+
:caution-caption: :fire:
10
+
:warning-caption: :warning:
11
+
endif::[]
12
+
13
+
14
+
5
15
= Config format
6
16
7
17
Has 6 sections:
@@ -20,9 +30,10 @@ There are functions for building query string: `formatConj`, `formatValue`, `for
20
30
They have common param `isForDisplay` - false by default, true will be used for `QbUtils.queryString(immutableTree, config, true)` (see 3rd param true). +
21
31
Also there are similar `mongoConj`, `mongoFormatOp`, `mongoFormatValue` for building MongoDb query with `QbUtils.mongodbFormat()`.
@@ -306,6 +323,8 @@ where `AND` and `OR` - available conjuctions (logical operators). You can add `N
306
323
307
324
308
325
326
+
{nbsp} +
327
+
{nbsp} +
309
328
[[configoperators]]
310
329
=== config.operators
311
330
@@ -347,6 +366,8 @@ where `AND` and `OR` - available conjuctions (logical operators). You can add `N
347
366
|isSpecialRange | |false |Special for `cardinality==2`. Used to show 1 range widget instead of 2 widgets (see `range_between` operator for `rangeslider` widget in demo)
348
367
|===
349
368
369
+
[NOTE]
370
+
====
350
371
There is also special `proximity` operator, its options are rendered with `<ProximityOperator>`.
351
372
352
373
[source,javascript]
@@ -355,9 +376,12 @@ import {Operators: {ProximityOperator}} from 'react-awesome-query-builder';
355
376
----
356
377
357
378
See https://github.com/ukrbublik/react-awesome-query-builder/tree/master/examples/demo/config.js[`examples/demo`]
379
+
====
358
380
359
381
360
382
383
+
{nbsp} +
384
+
{nbsp} +
361
385
[[configwidgets]]
362
386
=== config.widgets
363
387
@@ -424,12 +448,14 @@ const {
424
448
Used together with operator `range_between` having `isSpecialRange=true` option.
425
449
|===
426
450
427
-
There is special `field` widget, rendered by `<ValueFieldWidget>`. +
451
+
NOTE: There is special `field` widget, rendered by `<ValueFieldWidget>`. +
428
452
It can be used to compare field with another field of same type. +
429
453
To enable this feature set `valueSources` of type to `['value', 'field'']` (see below in link:#configtypes[config.types]).
0 commit comments