Skip to content

Commit c1e6dba

Browse files
danciaclaradanciaclara
committed
Rich filters
1 parent 972df21 commit c1e6dba

File tree

3 files changed

+187
-44
lines changed

3 files changed

+187
-44
lines changed

‎docs/core-concepts/issues/display-options.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Display
2+
title: Display options
33
description: Customize display by showing specific properties, grouping by attributes, subgrouping, and ordering items to create the perfect project view.
44
---
55

‎docs/core-concepts/issues/visualise_filter.mdx‎

Lines changed: 183 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,189 @@
11
---
2-
title: Filters
2+
title: Work item filters
33
description: Learn how to filter work items in Plane.
44
---
55

66
# Filter work items
77

8-
Filtering work items in Plane helps you quickly locate, analyze, and manage tasks based on specific criteria.
9-
10-
![Filter work items](https://media.docs.plane.so/issues/filter-issues.webp#center)
11-
12-
## Options
13-
14-
- **Priority**
15-
Filter work items by their priority level (e.g., Urgent, High, Medium, Low) to focus on the most critical tasks.
16-
- **State**
17-
View work items based on their current state, such as Todo, In Progress, or Done.
18-
- **Work item Type**
19-
Filter by custom work item types, such as Bug, Feature, or Task.
20-
- **Assignee**
21-
Focus on work items assigned to specific team members to track workloads or identify pending tasks.
22-
- **Cycle**
23-
View work items tied to specific cycles to monitor progress within a timeframe.
24-
- **Module**
25-
Filter work items by their associated module to analyze related tasks together.
26-
- **Mention**
27-
Filter tasks where you or another team member has been mentioned to ensure no critical tasks are missed.
28-
- **Created by**
29-
Identify work items created by specific individuals.
30-
- **Label**
31-
Filter work items based on custom tags, such as "Frontend", or "Marketing".
32-
- **Work item grouping**
33-
View all, active or backlog work items.
34-
- **Start date and Target date**
35-
Filter work items by start dates to view tasks that are planned or already in progress, and by target dates to track upcoming deadlines or overdue tasks. For even more flexibility, you can specify a custom date range to focus on a specific timeframe.
36-
37-
## Multiple filters
38-
39-
You can apply multiple filters to refine your results further. Only work items that match all the selected criteria will be displayed. For instance, filtering for "High Priority" and "Assigned to Alice" will only show high-priority work items assigned to Alice.
40-
41-
## Save filters
42-
43-
Once you’ve applied filters, you can save your configuration as a custom view for easy access in the future. Custom views allow you to quickly switch between different perspectives, such as a high-priority tasks dashboard or a specific team’s workload. See [Views](/core-concepts/views) for more info.
8+
Filters help you find exactly the work items you need by applying conditions across multiple fields. Whether you're looking for overdue tasks assigned to your team or tracking items in specific states, filters give you the control to slice through your work items with precision.
9+
10+
With rich filters, you can now choose from different operators for each field type, giving you even more control over how you filter your work items.
11+
12+
![Filter work items](https://media.docs.plane.so/issues/filter-work-items.webp#center)
13+
14+
## How to use filters
15+
16+
Filters live in their own dedicated row below the main toolbar, making them always accessible while you work with your work items.
17+
18+
### Basic filtering
19+
20+
To start filtering your work items:
21+
22+
1. Click the **Filter** button to open a dropdown with all the fields.
23+
2. Select any field (State, Priority, Assignee, etc.) to add a filter condition.
24+
3. Choose your operator from the dropdown (like "is", "is not", "after", etc.).
25+
4. Select one or more values you want to filter the field by.
26+
5. Your work items update instantly to match your criteria.
27+
28+
### Build complex filters
29+
30+
You can combine multiple filters to create powerful queries:
31+
32+
**Find urgent items for your team:**
33+
- Set **Priority** → **is** → `High`
34+
- Add **Assignee** → **in** → [Select team members]
35+
- Add **State** → **is not** → `Done`
36+
37+
**Track overdue work:**
38+
- Set **Target date** → **before** → [Today's date]
39+
- Add **State group** → **is not** → `Completed`
40+
41+
**Review items without assignments:**
42+
- Set **Assignee** → is → [empty]
43+
- Add State → in → [Backlog, To Do]
44+
45+
### Work with date filters
46+
47+
Date filters are particularly powerful for project management:
48+
49+
**This week's deliverables:**
50+
- Set **Target date** → **between** → [Monday] and [Sunday]
51+
52+
**Items starting soon:**
53+
- Set **Start Date** → **after or on** → [Today]
54+
- Add **Start Date** → **before or on** → [One week from today]
55+
56+
**Overdue items:**
57+
- Set **Target date** → **before** → [Today]
58+
- Add **State group** → **is not** → [Completed]
59+
60+
## Manage your filters
61+
62+
- **Clear specific filters:**
63+
Click the **X** next to any filter condition to remove just that filter.
64+
65+
- **Clear all filters:**
66+
Use the **Clear all** button to start fresh.
67+
68+
- **Save your view:**
69+
Once you've built the perfect filter combination, use **Save view** to preserve your configuration as a custom view for easy access in the future. Views allow you to quickly switch between different perspectives, such as a high-priority tasks dashboard or a specific team’s workload. See [Views](/core-concepts/views) for more details.
70+
71+
## Filter operators reference
72+
73+
Each field supports different operators to give you precise control over your filtering.
74+
75+
:::info[Operator availability]
76+
**Free plan**
77+
You get essential filtering with the `is` operator, plus `between` for date fields. This covers the most common filtering needs.
78+
79+
**Paid plans**
80+
Unlock advanced filtering with additional operators including `is not`, `after`, `before`, and more specialized conditions. We will be adding more conditions here such as `in`, `contains`, `is empty`, etc. .
81+
:::
82+
83+
### Type
84+
85+
Filter by custom work item types, such as Bug, Feature, or Task.
86+
87+
| Operator | Description | Use case |
88+
|----------|-------------|----------|
89+
| `is` | Exactly matches one type | Show only work items with type *Bug* |
90+
91+
### State
92+
93+
View work items based on their current state, such as Todo, In Progress, or Done.
94+
95+
| Operator | Description | Use case |
96+
|----------|-------------|----------|
97+
| `is` | Exactly matches one state | Only items In Progress |
98+
| `is not` | Excludes one state | Everything except Done |
99+
100+
### State Group
101+
102+
View all, active or backlog work items.
103+
104+
| Operator | Description | Use case |
105+
|----------|-------------|----------|
106+
| `is` | Exactly matches one group | Show only Started work items |
107+
| `is not` | Excludes one group | Everything except Backlog |
108+
109+
### Assignees
110+
111+
Focus on work items assigned to specific team members to track workloads or identify pending tasks.
112+
113+
| Operator | Description | Use case |
114+
|----------|-------------|----------|
115+
| `is` | Exactly matches one person | Find work assigned to Sarah |
116+
| `is not` | Excludes one person | Hide items assigned to John |
117+
118+
### Priority
119+
120+
Filter work items by their priority level (e.g., Urgent, High, Medium, Low) to focus on the most critical tasks.
121+
122+
| Operator | Description | Use case |
123+
|----------|-------------|----------|
124+
| `is` | Exactly matches one priority | Only high priority items |
125+
| `is not` | Excludes one priority | Everything except low priority |
126+
127+
### Mentions
128+
129+
Filter tasks where you or another team member has been mentioned to ensure no critical tasks are missed.
130+
131+
| Operator | Description | Use case |
132+
|----------|-------------|----------|
133+
| `is` | Exactly matches one person | Items mentioning Sarah |
134+
| `is not` | Excludes one person | Not mentioning John |
135+
136+
### Label
137+
138+
Filter work items based on custom tags, such as "Frontend", or "Marketing".
139+
140+
| Operator | Description | Use case |
141+
|----------|-------------|----------|
142+
| `is` | Exact label match | Label exactly "bug" |
143+
| `is not` | Not exact label match | Label not exactly "bug" |
144+
145+
### Cycle
146+
147+
View work items tied to specific cycles to monitor progress within a timeframe.
148+
149+
| Operator | Description | Use case |
150+
|----------|-------------|----------|
151+
| `is` | Exactly this cycle | Items in Sprint 23 |
152+
| `is not` | Not this specific cycle | Not in Sprint 23 |
153+
154+
### Module
155+
156+
Filter work items by their associated module to analyze related tasks together.
157+
158+
| Operator | Description | Use case |
159+
|----------|-------------|----------|
160+
| `is` | Exactly this module | Items in Authentication module |
161+
| `is not` | Not this specific module | Not in Authentication module |
162+
163+
### Start date and Target date
164+
165+
Filter work items by start dates to view tasks that are planned or already in progress, and by target dates to track upcoming deadlines or overdue tasks. For even more flexibility, you can specify a custom date range to focus on a specific timeframe.
166+
167+
| Operator | Description | Use case |
168+
|----------|-------------|----------|
169+
| `is` | Exactly this date | Items due today |
170+
| `is not` | Not this specific date | Not due today |
171+
| `before` | Earlier than this date | Due before Monday |
172+
| `not before` | This date or later | Not due before Monday (due Monday or later) |
173+
| `before or on` | This date or earlier | Due Monday or earlier |
174+
| `not before or on` | Later than this date | Not due Monday or earlier (due after Monday) |
175+
| `after` | Later than this date | Due after Friday |
176+
| `not after` | This date or earlier | Not due after Friday (due Friday or earlier) |
177+
| `after or on` | This date or later | Due Friday or later |
178+
| `not after or on` | Earlier than this date | Not due Friday or later (due before Friday) |
179+
| `between` | Within date range | Due this week |
180+
| `not between` | Outside date range | Not due this week |
181+
182+
### Created by
183+
184+
Identify work items created by specific individuals.
185+
186+
| Operator | Description | Use case |
187+
|----------|-------------|----------|
188+
| `is` | Exactly matches one person | Items created by Sarah |
189+
| `is not` | Excludes one person | Not created by John |

‎sidebars.ts‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,9 @@ const sidebars: SidebarsConfig = {
7777
items: [
7878
"core-concepts/account/overview",
7979
"your-work",
80-
{
81-
type: "category",
82-
label: "Layouts",
83-
link: { type: "doc", id: "core-concepts/issues/layouts" },
84-
items: ["core-concepts/issues/visualise_filter", "core-concepts/issues/display-options"],
85-
},
80+
"core-concepts/issues/layouts",
81+
"core-concepts/issues/visualise_filter",
82+
"core-concepts/issues/display-options",
8683
"core-concepts/views",
8784
"core-concepts/analytics",
8885
"dashboards",

0 commit comments

Comments
 (0)