Skip to content

docs(skill): document a data grid's column filters where a data grid is documented - #1167

Merged
ako merged 3 commits into
mendixlabs:mainfrom
tgolembiewski:docs/datagrid-column-filters
Sep 22, 2026
Merged

ako merged 3 commits into
mendixlabs:mainfrom
tgolembiewski:docs/datagrid-column-filters

Conversation

@tgolembiewski

Copy link
Copy Markdown
Contributor

Closes #1166

What

Documentation only. A DataGrid2 filters itself and mxcli supports every part of it; the pages that say so are not the pages a reader building a grid opens.

  • create-page/reference/widgets.md opened its filter section with "Filter widgets are used inside GALLERY FILTER containers". Everything under that line — textfilter, numberfilter, datefilter, dropdownfilter and the association form — applies to a data grid column too, but the section announced itself as being about galleries. The lead-in now names both homes, the grid column first, with a two-line example of each.
  • overview-pages/SKILL.md had a table mapping each attribute type to its filter widget and nothing else. It gains the two forms a real list needs first: a dropdownfilter over an association (Association: + datasource: + CaptionAttribute:), and FilterType: between for a date range. Plus one short paragraph saying the grid filters itself, because the alternative keeps being written.

Why the last paragraph

Two apps generated with mxcli, by different models, independently built the same filter bar on their order list: a non-persistent filter entity, inputs bound to its attributes, an apply microflow on every OnChange, a Clear button, and an XPath on the grid reading the filter object back. One of them cost three microflows (66 lines of MDL), nine input widgets and 1,100 characters of XPath where five column filters do the same job — and the hand-built version loses the paging, sorting and per-user personalisation the grid does on its own.

Verified

Blank 11.12.1 project, binary built from main at 643271e:

column colCreated (attribute: "Created", caption: 'Created') { datefilter fltCreated (FilterType: between) }

mxcli check --references passes, exec applies it, mx check reports 0 errors, and DESCRIBE PAGE returns the same line. The association form round-trips the same way.

overview-pages/SKILL.md goes 675 → 696 lines, under the 700 TestLargeSkillsWereSplit allows.

Validation

Full local run of push-test.yml, green: make build, make test, check-tunnel-deps, make check-mdl, make check-skill-pack-js, make check-findings, make check-wiki-pages, check-skill-mdl.sh over .claude/skills/mendix and docs-site/src, make lint-go, make test-integration against mx 11.12.1.

The filter widgets section of the create-page widget reference opened
with "Filter widgets are used inside GALLERY FILTER containers", so a
reader building a data grid stopped at the first line -- everything
under it, including the association form, applies to a grid column just
as well. The lead-in now names both homes, the grid column first, with
a two-line example of each.
The type table in overview-pages maps each attribute type to its filter
widget and stops there, so the two forms a real list reaches for first
were nowhere on the page a reader building that list opens: a
dropdownfilter over an association (Association + datasource +
CaptionAttribute), and FilterType: between for a date range. Both
verified on a blank 11.12.1 project -- check, exec, mx check 0 errors,
and DESCRIBE returning the same line.

The section also says now that the grid filters itself, because the
alternative keeps being written: a non-persistent filter entity, inputs
bound to it, an apply microflow on every change and an XPath reading
that object back -- three microflows and 1,100 characters of XPath on
one generated app, against five lines.

675 -> 696 lines, under the 700 the split test allows.
@github-actions

Copy link
Copy Markdown

AI Code Review

Critical Issues

  • None

Moderate Issues

  • None

Minor Issues

  • None

What Looks Good

  • The PR is documentation-only, improving clarity for DataGrid2 column filters in two skill files:
    • .claude/skills/mendix/create-page/reference/widgets.md now correctly states filter widgets live in both data grid columns and gallery filter containers, with clear examples for each.
    • .claude/skills/mendix/overview-pages/SKILL.md adds missing association filter form (Association: + datasource: + CaptionAttribute:), FilterType: between for date ranges, and reinforces that grids filter themselves (discouraging manual filter bars).
  • CHANGELOG.md entry accurately summarizes the documentation improvements.
  • Author verified all documented syntax works end-to-end: mxcli check --references passes, exec applies changes, mx check reports 0 errors, and DESCRIBE PAGE roundtrips correctly.
  • No code changes, so no risk of introducing bugs or violating architectural guidelines.
  • Changes are scoped to documentation improvements only, maintaining atomicity.

Recommendation

  • Approve. The documentation improvements are accurate, verified, and address a real user confusion point without modifying any code or MDL syntax. No further changes needed.

Automated review via OpenRouter (Nemotron Super 120B) — workflow source

@ako
ako merged commit 1ec3333 into mendixlabs:main Sep 22, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: a data grid's column filters are documented as a gallery feature, so generated pages hand-build a filter bar

2 participants