docs(ui-components): update color highlight button doc #503
+125
−22
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for the color highlight button component, adding comprehensive information about the new mode parameter that enables both mark and node-level highlighting. The documentation now includes complete parameter tables, usage examples, and documentation for two new utility functions.
Key Changes:
- Added
modeparameter support throughout the API (props, utilities, and callbacks) - Added missing imports to code examples for better clarity
- Documented two new utility functions:
removeHighlight()andpickHighlightColorsByValue()
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/content/ui-components/components/color-highlight-button.mdx |
Comprehensive documentation update including new mode parameter, parameter tables for utilities, usage examples, and two new utility function documentations |
.changeset/fluffy-pugs-go.md |
Changeset documenting all the documentation updates made in this PR |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
useColorHighlight()modeparameter to the hook props tableonAppliedcallback type to include mode parametercanColorHighlight()signature to include optional mode parametercanColorHighlight()isColorHighlightActive()signature: renamedcolorparameter tohighlightColorand added optionalmodeparameterisColorHighlightActive()removeHighlight()utility functionpickHighlightColorsByValue()utility function