docs(table): document filtering and the responsive filter controls - #139
Merged
Conversation
The table page documented wrapping and the data-table controls but never `filter` or `filter-col`, so the filter button group was undocumented despite shipping in v2.5.0. Add a Filtering section covering both, with a live example, and note that `filter-col` is positional — reordering a filtered table's columns means updating it. Document `filter-responsive` (v3.22.0) under it, since the new argument only makes sense once the button group it collapses has been introduced. The example carries enough categories to overflow a narrow viewport, which is the case the argument exists for. The generated argument table at the bottom of the page picks up `filter-responsive` automatically from the structure definition. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
Contributor
Author
|
🎉 This PR is included in version 1.15.8 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents table filtering on the Table component page, and the new
filter-responsiveargument from gethinode/hinode#2137.Why
filterandfilter-colwere undocumented entirely — the page covered wrapping and the data-table controls, but never filtering, despite the button group shipping in v2.5.0. Documentingfilter-responsiveon its own would have described collapsing a control the docs never introduced, so this adds a Filtering section covering all three.What's added
filterandfilter-col, with a live example. Notes thatfilter-colis positional, so reordering a filtered table's columns means updating it, and points atjustifyfor aligning the controls.filter-responsive, with an example carrying enough categories to overflow a narrow viewport, which is the case the argument exists for.The generated argument table at the bottom of the page picks up
filter-responsiveautomatically from the structure definition; no change needed there.Testing
Built and driven through hinode's example site with this branch mounted in place of the released module (
HUGO_MODULE_REPLACEMENTS), against gethinode/hinode#2137, at 390px:filter-responsiveexample — button group hidden, dropdown visible; selecting "Herb" narrowed 5 rows to Basil and relabeled the toggle.markdownlint-cli2reports 0 issues on the changed file.Important
Do not merge before gethinode/hinode#2137 ships in v3.22.0. The second example passes
filter-responsive, which an older theme does not recognize —InitArgswould raise an "Invalid arguments" warning and the example would render a plain button group.Note on existing lint failures
pnpm lintcurrently fails oncontent/blocks/preview.md,content/blocks/testimonials.mdandcontent/components/testimonial.md(MD060, MD012, MD009). Those are pre-existing onmainand untouched here —content/components/table.mdis the only changed file and lints clean.