Skip to content

Commit b98a73c

Browse files
committed
\n
1 parent c483eba commit b98a73c

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

CONFIG.adoc

+28-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22
:toc-placement!:
33
toc::[]
44

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+
515
= Config format
616

717
Has 6 sections:
@@ -20,9 +30,10 @@ There are functions for building query string: `formatConj`, `formatValue`, `for
2030
They have common param `isForDisplay` - false by default, true will be used for `QbUtils.queryString(immutableTree, config, true)` (see 3rd param true). +
2131
Also there are similar `mongoConj`, `mongoFormatOp`, `mongoFormatValue` for building MongoDb query with `QbUtils.mongodbFormat()`.
2232

23-
Example: https://github.com/ukrbublik/react-awesome-query-builder/tree/master/examples/demo/config.js[`demo config`]
33+
TIP: Example: https://github.com/ukrbublik/react-awesome-query-builder/tree/master/examples/demo/config.js[`demo config`]
2434

2535

36+
{nbsp} +
2637

2738
== Basic config
2839

@@ -96,6 +107,8 @@ const myConfig = {
96107

97108

98109

110+
{nbsp} +
111+
99112
== Sections
100113

101114
[[configfields]]
@@ -153,6 +166,8 @@ const myConfig = {
153166

154167

155168

169+
{nbsp} +
170+
{nbsp} +
156171
[[configsettings]]
157172
=== config.settings
158173

@@ -274,6 +289,8 @@ Localization:
274289

275290

276291

292+
{nbsp} +
293+
{nbsp} +
277294
[[configconjunctions]]
278295
=== config.conjunctions
279296

@@ -306,6 +323,8 @@ where `AND` and `OR` - available conjuctions (logical operators). You can add `N
306323

307324

308325

326+
{nbsp} +
327+
{nbsp} +
309328
[[configoperators]]
310329
=== config.operators
311330

@@ -347,6 +366,8 @@ where `AND` and `OR` - available conjuctions (logical operators). You can add `N
347366
|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)
348367
|===
349368

369+
[NOTE]
370+
====
350371
There is also special `proximity` operator, its options are rendered with `<ProximityOperator>`.
351372
352373
[source,javascript]
@@ -355,9 +376,12 @@ import {Operators: {ProximityOperator}} from 'react-awesome-query-builder';
355376
----
356377
357378
See https://github.com/ukrbublik/react-awesome-query-builder/tree/master/examples/demo/config.js[`examples/demo`]
379+
====
358380

359381

360382

383+
{nbsp} +
384+
{nbsp} +
361385
[[configwidgets]]
362386
=== config.widgets
363387

@@ -424,12 +448,14 @@ const {
424448
Used together with operator `range_between` having `isSpecialRange=true` option.
425449
|===
426450

427-
There is special `field` widget, rendered by `<ValueFieldWidget>`. +
451+
NOTE: There is special `field` widget, rendered by `<ValueFieldWidget>`. +
428452
It can be used to compare field with another field of same type. +
429453
To enable this feature set `valueSources` of type to `['value', 'field'']` (see below in link:#configtypes[config.types]).
430454

431455

432456

457+
{nbsp} +
458+
{nbsp} +
433459
[[configtypes]]
434460
=== config.types
435461

0 commit comments

Comments
 (0)