Skip to content

Commit

Permalink
doc(): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
panoti committed Oct 13, 2023
1 parent 4c14607 commit 1781439
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,6 @@ config: QueryBuilderConfig = {

## Custom Styling (with Bootstrap 4)

[Bootstrap demo](https://zebzhao.github.io/Angular-QueryBuilder/demo/).

##### `app.component.html`
```html
<query-builder [(ngModel)]='query' [config]='config' [classNames]='classNames'></query-builder>
Expand Down Expand Up @@ -143,7 +141,7 @@ classNames: QueryBuilderClassNames = {

## Customizing with Angular Material

Example of how you can completely customize the query component with another library like Angular Material. For the full example, please look at the [source code](https://github.com/zebzhao/Angular-QueryBuilder/blob/master/demo/src/app/app.component.ts) provided in the demo.
Example of how you can completely customize the query component with another library like Angular Material. For the full example, please look at the [source code](https://github.com/angular-ex/ngx-condition-builder/blob/main/projects/ngx-condition-builder-demo/src/app/app.component.ts) provided in the demo.

#### `app.component.html`

Expand Down Expand Up @@ -199,13 +197,11 @@ Example of how you can completely customize the query component with another lib

## Property Bindings Quick Reference

See [documentation](https://zebzhao.github.io/Angular-QueryBuilder/) for more details on interfaces and properties.

#### `query-builder`
|Name|Type|Required|Default|Description|
|:--- |:--- |:--- |:--- |:--- |
|`allowRuleset`|`boolean`|Optional|`true`| Displays the `+ Ruleset` button if `true`. |
|`allowCollapse`|`boolean`|Optional|`false`| Enables collapsible rule sets if `true`. ([See Demo](https://zebzhao.github.io/Angular-QueryBuilder/demo/)) |
|`allowCollapse`|`boolean`|Optional|`false`| Enables collapsible rule sets if `true`. |
|`classNames`|`object`|Optional|| CSS class names for different child elements in `query-builder` component. |
|`config`|`QueryBuilderConfig`|Required|| Configuration object for the main component. |
|`data`|`Ruleset`|Optional|| (Use `ngModel` or `value` instead.) |
Expand All @@ -218,7 +214,7 @@ See [documentation](https://zebzhao.github.io/Angular-QueryBuilder/) for more de

## Structural Directives

Use these directives to replace different parts of query builder with custom components. See [example](#customizing-with-angular-material), or [demo](https://zebzhao.github.io/Angular-QueryBuilder/demo/) to see how it's done.
Use these directives to replace different parts of query builder with custom components. See [example](#customizing-with-angular-material).

#### `queryInput`

Expand Down

0 comments on commit 1781439

Please sign in to comment.