Repository navigation
Show the scroll-state example on the Message Scroller page - #66
Open
ryoaonetsuki wants to merge 2 commits into
Open
ryoaonetsuki wants to merge 2 commits into
ryoaonetsuki wants to merge 2 commits into
Conversation
Signed-off-by: ryoaonetsuki <ryoaonetsuki@users.noreply.github.com>
Signed-off-by: ryoaonetsuki <ryoaonetsuki@users.noreply.github.com>
This branch has not been deployed
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.
Why
The Message Scroller page's "Reading Scroll State" section documents
useMessageScrollerScrollableand says "in the example below" — but thepreview it names,
message-scroller-scrollable, has no example file, sobuild-docssilently drops it and the section shows no example. The exampleitself exists:
src/examples/message-scroller-state.tsxrenders exactly this(a status bar driven by
useMessageScrollerScrollable), but nothing referencesit.
What changes
The example file is renamed to
message-scroller-scrollable.tsx, and itsexported component to
MessageScrollerScrollable, so the page's previewresolves. No page text is touched.
How it was checked
node scripts/build-docs.mjsoutput for the Message Scroller page now listsmessage-scroller-scrollableas a preview, under the "Reading Scroll State"heading, alongside the two previews that already worked.
npm run typecheckandnpm run buildpass;registry.jsonis unchanged.Limitation, stated honestly: the other 7 missing Message Scroller previews on
the same page are still dropped — they need their examples written, which is
bigger work than this rename. The companion warning from the build (see the
dropped-previews PR) now lists them on every build instead of hiding them.