docs(native): fix button compound API and useThemeColor destructuring in docs#6299
Open
docs(native): fix button compound API and useThemeColor destructuring in docs#6299
Conversation
|
commit: |
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.
📝 Description
Updates two HeroUI Native documentation files to reflect the correct component API. The
popover.mdxexample is corrected to use the properButton.Labelcompound component (instead ofButton.LabelContent) and removes the now-unnecessaryButton.StartContentwrapper. Thecolors.mdxexample is updated to use array destructuring foruseThemeColor, which matches the actual hook return signature.⛳️ Current behavior (updates)
The popover example uses
Button.StartContentandButton.LabelContentsub-components that do not reflect the current API. The colors guide shows object destructuring foruseThemeColor, which is incorrect since the hook returns an array.🚀 New behavior
Button.Label(correct compound API) and places the icon directly insideButtonwithout a wrapperuseThemeColormulti-select example uses array destructuringconst [accent, accentForeground, success, danger] = useThemeColor([...])💣 Is this a breaking change (Yes/No):
No — These are documentation-only changes correcting code examples; no library source code is modified.
📝 Additional Information
Both fixes are in
apps/docs/content/docs/native/and require no dependency changes. Reviewers should verify the corrected examples match the current HeroUI Native Beta API forButtoncompound components anduseThemeColor.