Skip to content

Commit

Permalink
docs: add groupBy documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jamiebrynes7 committed Mar 18, 2024
1 parent 24b7715 commit 58ed941
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion docs/docs/query-blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,34 @@ sorting:
```
````

### `groupBy`

The `groupBy` property controls how tasks are grouped when they are rendered. If omitted, there will be no grouping. The possible values are:

- `project`: group by project, using the project order as in Todoist
- `section`: group by project and section, using the project and section order as in Todoist
- `due` or `date`: group by due date, all overdue tasks are grouped and shown together
- `labels`: group by the task labels, all unlabelled tasks are grouped together
- `priority` group by task priority, priorities are shown in high-low order

For example:

````
```todoist
filter: "today | overdue"
groupBy: project
```
````

### `group`

The `group` property controls whether tasks are grouped into projects when rendered. This is a simple true or false option, further improvements to the grouping capabilities are planned.
:::warning

This option is deprecated and will be removed in a future release. Please use `groupBy` instead.

:::

The `group` property controls whether tasks are grouped into projects when rendered.

````
```todoist
Expand Down

0 comments on commit 58ed941

Please sign in to comment.