docs(scrollbar): improve API discovery#251
Merged
Merged
Conversation
Add focused ScrollBar documentation and examples so callers can find styling, glyph, and interaction methods from the main widget page. Keep crate-level docs aligned with the generated README and docs.rs example scraping.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #251 +/- ##
==========================================
+ Coverage 87.57% 87.65% +0.07%
==========================================
Files 22 22
Lines 4210 4237 +27
==========================================
+ Hits 3687 3714 +27
Misses 523 523 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Member
Author
|
@tremby happy to take a review on language here if anything is unclear. I'd recommend rendering locally to view the docs there directly rather than just diff checking |
tremby
approved these changes
Jun 11, 2026
tremby
left a comment
There was a problem hiding this comment.
I read through all of it, looks good to me. Seems clear. Thanks.
(Caveat: I can't comment on accuracy, and I didn't run the example code.)
Member
Author
That's my bar on this sort of thing. Thanks for looking. |
This was referenced Jun 11, 2026
joshka
pushed a commit
that referenced
this pull request
Jun 11, 2026
## 🤖 New release * `tui-scrollbar`: 0.2.5 -> 0.2.6 (✓ API compatible changes) <details><summary><i><b>Changelog</b></i></summary><p> <blockquote> ## [0.2.6] - 2026-06-11 ### 📚 Documentation - *(scrollbar)* Improve API discovery ([#251](#251)) > ## Summary > > - Improve `tui-scrollbar` crate docs for API discovery, styling > behavior, glyph selection, and interaction flow. > - Add a small `scrollbar_styled` example that shows distinct track, > thumb, and arrow styles for vertical and horizontal scrollbars. > - Configure docs.rs example scraping and add a regression test for > custom thumb styling on full and partial thumb cells. > > ## Details > > This is a non-functional docs/examples/tests change. It reorganizes the > crate-level docs so important defaults and caveats are visible earlier, > replaces the loose `ScrollBar` “Key methods” list with a grouped method > map, and adds canonical examples for the main builder methods. > > The styling docs now spell out how `fg` and `bg` apply to terminal glyph > cells. In particular, they call out that the default minimal track > renders spaces, so empty track cells show background color, while > visible glyph sets can use foreground color for the track line. The docs > also note the partial-thumb caveat: when using visible tracks such as > `GlyphSet::box_drawing`, thumb background can show at partial glyph > edges, so matching it to the track background is usually less > surprising. > > The glyph docs keep repeated `Symbols for Legacy Computing` context > where readers may land directly, rather than relying on linear reading > through the crate docs. > > Related context: > > - Issue #193: #193 > - PR #201: #201 > > ## Validation > > - `cargo test -p tui-scrollbar --all-features` > - `cargo test -p tui-scrollbar --doc --all-features` > - `cargo check -p tui-scrollbar --examples --all-features` > - `cargo clippy -p tui-scrollbar --all-targets --all-features` > - `RUSTDOCFLAGS='-D warnings' cargo doc -p tui-scrollbar --no-deps > --all-features` > - `just fmt-check` > - `cargo rdme --check --manifest-path tui-scrollbar/Cargo.toml` > - `markdownlint-cli2 tui-scrollbar/README.md` </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
joshka
pushed a commit
that referenced
this pull request
Jun 12, 2026
## 🤖 New release * `tui-widgets`: 0.7.4 -> 0.7.5 (✓ API compatible changes) <details><summary><i><b>Changelog</b></i></summary><p> <blockquote> ## [0.7.5] - 2026-06-11 ### 📚 Documentation - *(scrollbar)* Improve API discovery ([#251](#251)) > ## Summary > > - Improve `tui-scrollbar` crate docs for API discovery, styling > behavior, glyph selection, and interaction flow. > - Add a small `scrollbar_styled` example that shows distinct track, > thumb, and arrow styles for vertical and horizontal scrollbars. > - Configure docs.rs example scraping and add a regression test for > custom thumb styling on full and partial thumb cells. > > ## Details > > This is a non-functional docs/examples/tests change. It reorganizes the > crate-level docs so important defaults and caveats are visible earlier, > replaces the loose `ScrollBar` “Key methods” list with a grouped method > map, and adds canonical examples for the main builder methods. > > The styling docs now spell out how `fg` and `bg` apply to terminal glyph > cells. In particular, they call out that the default minimal track > renders spaces, so empty track cells show background color, while > visible glyph sets can use foreground color for the track line. The docs > also note the partial-thumb caveat: when using visible tracks such as > `GlyphSet::box_drawing`, thumb background can show at partial glyph > edges, so matching it to the track background is usually less > surprising. > > The glyph docs keep repeated `Symbols for Legacy Computing` context > where readers may land directly, rather than relying on linear reading > through the crate docs. > > Related context: > > - Issue #193: #193 > - PR #201: #201 > > ## Validation > > - `cargo test -p tui-scrollbar --all-features` > - `cargo test -p tui-scrollbar --doc --all-features` > - `cargo check -p tui-scrollbar --examples --all-features` > - `cargo clippy -p tui-scrollbar --all-targets --all-features` > - `RUSTDOCFLAGS='-D warnings' cargo doc -p tui-scrollbar --no-deps > --all-features` > - `just fmt-check` > - `cargo rdme --check --manifest-path tui-scrollbar/Cargo.toml` > - `markdownlint-cli2 tui-scrollbar/README.md` ### ⚙️ Miscellaneous Tasks - *(tui-scrollbar)* Release v0.2.6 ([#258](#258)) > ## 🤖 New release > > * `tui-scrollbar`: 0.2.5 -> 0.2.6 (✓ API compatible changes) > > <details><summary><i><b>Changelog</b></i></summary><p> > > <blockquote> > > ## [0.2.6] - 2026-06-11 > > ### 📚 Documentation > > - *(scrollbar)* Improve API discovery > ([#251](#251)) > > ## Summary > > > > - Improve `tui-scrollbar` crate docs for API discovery, styling > > behavior, glyph selection, and interaction flow. > > - Add a small `scrollbar_styled` example that shows distinct track, > > thumb, and arrow styles for vertical and horizontal scrollbars. > > - Configure docs.rs example scraping and add a regression test for > > custom thumb styling on full and partial thumb cells. > > > > ## Details > > > > This is a non-functional docs/examples/tests change. It reorganizes > the > > crate-level docs so important defaults and caveats are visible > earlier, > > replaces the loose `ScrollBar` “Key methods” list with a grouped > method > > map, and adds canonical examples for the main builder methods. > > > > The styling docs now spell out how `fg` and `bg` apply to terminal > glyph > > cells. In particular, they call out that the default minimal track > > renders spaces, so empty track cells show background color, while > > visible glyph sets can use foreground color for the track line. The > docs > > also note the partial-thumb caveat: when using visible tracks such as > > `GlyphSet::box_drawing`, thumb background can show at partial glyph > > edges, so matching it to the track background is usually less > > surprising. > > > > The glyph docs keep repeated `Symbols for Legacy Computing` context > > where readers may land directly, rather than relying on linear reading > > through the crate docs. > > > > Related context: > > > > - Issue #193: #193 > > - PR #201: #201 > > > > ## Validation > > > > - `cargo test -p tui-scrollbar --all-features` > > - `cargo test -p tui-scrollbar --doc --all-features` > > - `cargo check -p tui-scrollbar --examples --all-features` > > - `cargo clippy -p tui-scrollbar --all-targets --all-features` > > - `RUSTDOCFLAGS='-D warnings' cargo doc -p tui-scrollbar --no-deps > > --all-features` > > - `just fmt-check` > > - `cargo rdme --check --manifest-path tui-scrollbar/Cargo.toml` > > - `markdownlint-cli2 tui-scrollbar/README.md` > </blockquote> > > > </p></details> > > --- > This PR was generated with > [release-plz](https://github.com/release-plz/release-plz/). </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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
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
tui-scrollbarcrate docs for API discovery, styling behavior, glyph selection, and interaction flow.scrollbar_styledexample that shows distinct track, thumb, and arrow styles for vertical and horizontal scrollbars.Details
This is a non-functional docs/examples/tests change. It reorganizes the crate-level docs so important defaults and caveats are visible earlier, replaces the loose
ScrollBar“Key methods” list with a grouped method map, and adds canonical examples for the main builder methods.The styling docs now spell out how
fgandbgapply to terminal glyph cells. In particular, they call out that the default minimal track renders spaces, so empty track cells show background color, while visible glyph sets can use foreground color for the track line. The docs also note the partial-thumb caveat: when using visible tracks such asGlyphSet::box_drawing, thumb background can show at partial glyph edges, so matching it to the track background is usually less surprising.The glyph docs keep repeated
Symbols for Legacy Computingcontext where readers may land directly, rather than relying on linear reading through the crate docs.Related context:
Validation
cargo test -p tui-scrollbar --all-featurescargo test -p tui-scrollbar --doc --all-featurescargo check -p tui-scrollbar --examples --all-featurescargo clippy -p tui-scrollbar --all-targets --all-featuresRUSTDOCFLAGS='-D warnings' cargo doc -p tui-scrollbar --no-deps --all-featuresjust fmt-checkcargo rdme --check --manifest-path tui-scrollbar/Cargo.tomlmarkdownlint-cli2 tui-scrollbar/README.md