Skip to content

docs(list): document responsive filter controls and column groups - #142

Merged
markdumay merged 1 commit into
mainfrom
docs/list-filter-wrap-args
Aug 24, 2026
Merged

docs(list): document responsive filter controls and column groups#142
markdumay merged 1 commit into
mainfrom
docs/list-filter-wrap-args

Conversation

@markdumay

Copy link
Copy Markdown
Contributor

Summary

Documents the three table arguments the list block forwards but never covered: filter_responsive, wrap and wrap_cols.

wrap was not mentioned in list.md at all, so a block author had no way to discover that a list can fold on small screens rather than run off the side of one. The shortcode-level docs on the Table component page cover the same features, but nothing pointed a block author at the snake_case equivalents.

What's added

  • Category Filter — a paragraph on filter_responsive: what it swaps, that the two controls stay in step across the breakpoint, and that it defaults to false.
  • Responsive Tables (new section) — wrap for the common one-wide-column case, and wrap_cols for folding a record into groups, with a live example. Covers the rule the counts must satisfy, the fallback when a list no longer sums (one left stale by a column being added), and that folded columns hide their headings — which is what makes the grouping a decision rather than a default.

The example uses the existing table-filter-hook, which renders three columns, so "1,2" is a valid split against a hook the page already documents.

Host requirement

Important

These examples need mod-blocks v2.6.0 in the consuming site. The block examples render live, so a host on an older mod-blocks does not merely fail to fold — it fails the build:

ERROR partial [component-library/components/list/list.hugo.html] - Invalid arguments: docs/blocks/list.md

Verified both ways: hinode's example site on mod-blocks v2.4.0 errors as above; on v2.6.0 the page builds and the example emits data-table-wrap-cols=1,2.

gethinode.com mounts this module too and will need the same floor.

Testing

Built through hinode's example site with this branch mounted in place of the released module. Both sections render, and the wrap_cols example produces a genuinely folded table rather than only documenting one.

markdownlint-cli2 reports 0 issues on the changed file.

Note on existing lint failures

pnpm lint fails on content/blocks/preview.md, content/blocks/testimonials.md and content/components/testimonial.md (MD060, MD012, MD009). Pre-existing on main and untouched here — content/blocks/list.md is the only changed file and lints clean.

The list block forwards `filter_responsive`, `wrap` and `wrap_cols` to the table
it renders, and none of the three were documented — `wrap` was not mentioned at
all, so a block author had no way to discover that a list can fold on small
screens rather than run off the side.

Add `filter_responsive` to the Category Filter section, and a Responsive Tables
section for `wrap` and `wrap_cols` with a live example. States the rule the group
counts must satisfy, what happens to a list left stale by a column being added,
and that folded columns hide their headings — which is what makes the grouping a
decision rather than a default.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@markdumay
markdumay merged commit 8d91470 into main Aug 24, 2026
8 checks passed
@markdumay
markdumay deleted the docs/list-filter-wrap-args branch August 24, 2026 08:54
@markdumay

Copy link
Copy Markdown
Contributor Author

🎉 This PR is included in version 1.15.9 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant