Skip to content

Commit f42a9a8

Browse files
authored
Merge pull request #174 from ukrbublik/vanilla
2.0 - skins
2 parents 0eb2445 + ea00811 commit f42a9a8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+1459
-848
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
# Changelog
2+
- 2.0.0
3+
- Added `renderConjs`, `renderButton`, `renderButtonGroup`, `renderProvider`, `renderValueSources`, `renderConfirm`
4+
- Removed coupling with AntDesign. Now it should be possible to use another UI framework.
5+
- Added vanilla widgets. Added switcher between `antd` and `vanilla` in demo.
26
- 1.3.7
37
- Fixed [issue](https://github.com/ukrbublik/react-awesome-query-builder/issues/168) with dot in field name
48
- 1.3.6

CONFIG.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,10 @@ const myConfig = {
194194
[source,javascript]
195195
----
196196
import en_US from 'antd/lib/locale-provider/en_US';
197+
import {AntdWidgets} from 'react-awesome-query-builder/components/widgets/antd';
197198
import {Widgets} from 'react-awesome-query-builder';
198-
const { FieldCascader, FieldDropdown } = Widgets;
199+
const { VanillaFieldSelect } = Widgets;
200+
const { FieldCascader, FieldDropdown } = AntdWidgets;
199201
----
200202

201203
[source,javascript]
@@ -271,16 +273,16 @@ Render settings:
271273
|key |default |meaning
272274
|renderSize |`small` |Size of AntDesign components - `small` or `large`
273275
|renderField |`(props) => <FieldSelect {...props} />` |Render fields list +
274-
Available widgets: `FieldSelect`, `FieldDropdown`, `FieldCascader`, `VanillaFieldSelect` (from `Widgets`)
276+
Available widgets: `FieldSelect`, `FieldDropdown`, `FieldCascader`, `VanillaFieldSelect` (see `AntdWidgets` and `Widgets` above)
275277
|renderOperator |`(props) => <FieldSelect {...props} />` |Render operators list +
276278
Available widgets: `FieldSelect`, `FieldDropdown`, `VanillaFieldSelect`
277279
|renderFunc |`(props) => <FieldSelect {...props} />` |Render functions list +
278280
Available widgets: `FieldSelect`, `FieldDropdown`, `VanillaFieldSelect`
281+
|renderConjs, renderButton, renderButtonGroup, renderProvider, renderValueSources, renderConfirm | |Other internal render functions you can override if using another UI framework (https://github.com/ukrbublik/react-awesome-query-builder/blob/master/modules/config/antd.js#L47[example])
279282
|showLabels |false |Show labels above all fields?
280283
|hideConjForOne |true |Don't show conjunctions switcher for only 1 rule?
281284
|maxLabelsLength |100 |To shorten long labels of fields/values (by length, i.e. number of chars)
282285
|dropdownPlacement |`bottomLeft` |Placement of antdesign's https://ant.design/components/dropdown/[dropdown] pop-up menu
283-
|renderConjsAsRadios |false |How to render conjunctions switcher? true - use `RadioGroup`, false - use `ButtonGroup`
284286
|customFieldSelectProps |`{}` |You can pass props to `Select` field widget. Example: `{showSearch: true}`
285287
|groupActionsPosition |`topRight` |You can change the position of the group actions to the following: +
286288
`topLeft, topCenter, topRight, bottomLeft, bottomCenter, bottomRight`
@@ -446,18 +448,16 @@ See https://github.com/ukrbublik/react-awesome-query-builder/tree/master/example
446448
[source,javascript]
447449
----
448450
import {Widgets} from 'react-awesome-query-builder';
451+
import {AntdWidgets} from 'react-awesome-query-builder/components/widgets/antd';
449452
const {
450453
TextWidget,
451454
NumberWidget,
452-
SelectWidget,
453-
MultiSelectWidget,
454-
TreeSelectWidget,
455-
DateWidget,
456-
BooleanWidget,
457-
TimeWidget,
458-
DateTimeWidget,
459-
ValueFieldWidget,
460-
FuncWidget
455+
...
456+
} = AntdWidgets;
457+
const {
458+
VanillaTextWidget,
459+
VanillaNumberWidget,
460+
...
461461
} = Widgets;
462462
----
463463

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,23 @@ Also see [`examples/demo`](https://github.com/ukrbublik/react-awesome-query-buil
4646

4747

4848
## Usage
49+
*Note:* From v2.0 antd is now optional (peer) dependency.
50+
If you want to use another UI, don't import `config/antd` and `antd.less`.
51+
You can use `BasicConfig` for simple UI.
52+
4953
```javascript
5054
import React, {Component} from 'react';
5155
import {Query, Builder, BasicConfig, Utils as QbUtils} from 'react-awesome-query-builder';
56+
import AntdConfig from 'react-awesome-query-builder/config/antd';
5257
import 'react-awesome-query-builder/css/antd.less';
5358
// or import "antd/dist/antd.css";
5459
import 'react-awesome-query-builder/css/styles.scss';
5560
import 'react-awesome-query-builder/css/compact_styles.scss'; //optional, for more compact styles
61+
const InitialConfig = AntdConfig; // or BasicConfig
5662

5763
// You need to provide your own config. See below 'Config format'
5864
const config = {
59-
...BasicConfig,
65+
...InitialConfig,
6066
fields: {
6167
qty: {
6268
label: 'Qty',

0 commit comments

Comments
 (0)