Skip to content

Update required filter behavior documentation #421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jesshitchcock merged 2 commits into from
Feb 18, 2026
Merged

Update required filter behavior documentation #421

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2f8b9a
Update required filter docs: field locked, value/operator editable
mintlify[bot] Feb 18, 2026
14740dd
Enhance explanation of required filters in tables.mdx
jesshitchcock Feb 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions references/tables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -595,7 +595,9 @@ The order that the fields are listed in `default_show_underlying_values` is the

Use `default_filters` to define filters on Dimensions that will be applied when no other user-defined filter on those Dimensions exists. Default filters will apply to tables on load and can be populated with a pre-determined value. Use them to suggest to users the kind of filters they might want to consider, or provide a default filtered view of a table that can be changed if needed.

An optional `required` flag can be added - in which case the filter _cannot_ be removed or modified. This can be particulalry useful if you have a large table and want to force users to filter on a partitioned date.
An optional `required` flag can be added, and if this flag is set to `required: true`, the filter for this field cannot be removed from the UI but users can still modify the operator and value to adjust how this filter is applied to the data. This ensures the filter is always applied in some form, while giving users flexibility to change the date range or other values. This can be particularly useful if you have a large table and want to force users to filter on a partitioned date.

In contrast, when `required: false` (or omitted), the filter is pre-populated but fully editable — users can change the field, operator, value, or remove it entirely.

Below you can see there is a default filter with the optional required flag, that will have show the last 14 days of data by default.

Expand Down Expand Up @@ -652,9 +654,7 @@ Below you can see there is a default filter with the optional required flag, tha
</Tabs>

<Info>
When a filter has `required: true`, the filter is completely locked in the UI — the field, operator, and value cannot be modified, and the filter cannot be removed. It will always be applied exactly as defined in the model YAML.

In contrast, when `required: false` (or omitted), the filter is pre-populated but fully editable — users can change the field, operator, value, or remove it entirely.
Note: Required filters are not a security feature. For secure data access control, use [user attributes](/references/user-attributes).
</Info>

### If you have many filters in your list, they will be joined using `AND`
Expand Down
Loading