Skip to content

Commit 048bd77

Browse files
committed
Auto-generate category pages for API and Tips & Tricks
1 parent 8901cbe commit 048bd77

11 files changed

+28
-4
lines changed

docs/api/export.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Export
3+
description: Convert query builder objects to SQL, etc.
34
---
45

56
import TypeScriptAdmonition from "./_ts_admonition.md";

docs/api/import.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Import
3+
description: Convert SQL to query builder objects
34
---
45

56
import TypeScriptAdmonition from "./_ts_admonition.md";

docs/api/misc.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Miscellaneous
33
hide_table_of_contents: true
4+
description: Assorted utilities and other exports
45
---
56

67
import TypeScriptAdmonition from "./_ts_admonition.md";
@@ -19,7 +20,7 @@ function defaultValidator(query: RuleGroupType): {
1920

2021
Pass `validator={defaultValidator}` to automatically validate groups (rules will be ignored). A group will be marked invalid if either 1) it has no child rules or groups (`query.rules.length === 0`), or 2) it has a missing/invalid `combinator` and more than one child rule or group (`rules.length >= 2`).
2122

22-
You can see an example of the default validator in action in the [demo](https://react-querybuilder.github.io/react-querybuilder/) if you check the "Use validation" option. Empty groups will have bold text on their "+Rule" button and a description of the situation where the rules normally appear.
23+
You can see an example of the default validator in action in the [demo](https://react-querybuilder.github.io/react-querybuilder/) if you check the ["Use validation" option](https://react-querybuilder.github.io/react-querybuilder/#validateQuery=true). Empty groups will have bold text on their "+Rule" button and a description of the situation where the rules normally appear.
2324

2425
### `findPath`
2526

docs/api/querybuilder.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: <QueryBuilder />
3+
description: Props and other configuration for the main component
34
---
45

56
import TypeScriptAdmonition from "./_ts_admonition.md";

docs/api/validation.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Validation
3+
description: Query validation methods and configuration
34
---
45

56
import TypeScriptAdmonition from "./_ts_admonition.md";

docs/tips/adding-removing-query-properties.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Adding and removing query properties
3+
description: Customizing the query object
34
hide_table_of_contents: true
45
---
56

docs/tips/common-mistakes.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Common mistakes
3+
description: How to resolve some frequently-reported issues
34
hide_table_of_contents: true
45
---
56

docs/tips/custom-bind-variables.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Custom bind variables
3+
description: Altering the SQL for certain RDBMS's
34
hide_table_of_contents: true
45
---
56

docs/tips/custom-with-fallback.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Custom components with fallbacks
3+
description: Adding functionality without replacing default components
34
hide_table_of_contents: true
45
---
56

docs/tips/limit-groups.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Limit rule groups
3+
description: Methods to prevent new groups
34
hide_table_of_contents: true
45
---
56

0 commit comments

Comments
 (0)