docs: add missing Box component properties and tests#1189
Open
karan74jaiswal wants to merge 3 commits into
Open
docs: add missing Box component properties and tests#1189karan74jaiswal wants to merge 3 commits into
karan74jaiswal wants to merge 3 commits into
Conversation
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.
What this PR does:
This PR updates the
Boxcomponent documentation to accurately reflect the availableBoxOptionsAPI inpackages/core/src/renderables/Box.ts. It also adds behavioral test coverage for these previously undocumented properties.While using
opentui, I noticed that the online documentation for theBoxcomponent was missing several functional properties (such as single-sided borders, focus colors, and layout gaps).Changes made:
box.mdxfor custom border characters (BorderCharacters), single-sided borders (BorderSides), layout gaps (rowGap,columnGap), andfocusablestates.input.mdxandtext.mdx).Box.test.tsforshouldFill,customBorderChars,focusedBorderColor, and flex gaps to ensure there are no regressions.Testing:
Box.test.tspass successfully.bun run validate:docs, and the documentation structure, links, and code examples passed flawlessly.