Add usage guide with practical examples and integration patterns#21
Open
yuribodo wants to merge 1 commit into
Open
Add usage guide with practical examples and integration patterns#21yuribodo wants to merge 1 commit into
yuribodo wants to merge 1 commit into
Conversation
Comprehensive USAGE.md covering quickstart, API decision tree, core concepts (two-phase model, font strings, cursors), and practical patterns: height prediction, Canvas rendering, shrink-wrapping, variable- width layout, pre-wrap mode, and performance guidance. Includes React hook and vanilla JS integration examples. Linked from README. Closes chenglou#8
829397f to
1921b38
Compare
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
Comprehensive
USAGE.mdaddressing the gap identified in #8: "demos look amazing, but unclear how to use without poking through the code."The guide is organized by what you want to accomplish, not by function name:
layout()vslayoutWithLines()vswalkLineRanges()vslayoutNextLine()ResizeObserverlayoutWithLines()→ctx.fillText()loop{ whiteSpace: 'pre-wrap' }for textareasDoes not duplicate the README's API glossary — references it instead. Added a one-line link from the README.
Closes #8
Test plan
bun run checkpassesbun testpasses (60/60)