refactor: Rewrite Refs doc #1212
Merged
Conversation
This file contains 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
rschristian
commented
Dec 24, 2024
rschristian
force-pushed
the
refactor/reword-refs
branch
from
59e07d5 to
e9fee0a
Compare
rschristian
commented
Dec 24, 2024
Comment on lines
+5
to
+17
| /** | ||
| * Used in markdown files to switch between different API styles, i.e, | ||
| * Class Components and Hooks. This displays either-or, not both at once, | ||
| * so it's not necessarily meant for directly comparing API styles. | ||
| * | ||
| * Primarily adopted from MDN's tabs example: | ||
| * https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/tab_role#example | ||
| * | ||
| * @param {Object} props | ||
| * @param {string} props.tabstring - Comma-separated list of tab names | ||
| * @param {Array<import('preact').Component | string>} props.children - Array of JSX elements | ||
| */ | ||
| export default function TabGroup({ tabstring, children }) { |
There was a problem hiding this comment.
I'm super pleased with this (almost unreasonably so), should be great for showing off different API styles/options in the future.
As noted, MDN has a brilliant tutorial in which they go over all of the accessibility complexities which I believe I mirrored correctly. Everything seems to be labeled, connected, and following practices as intended.
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.
I've found the refs doc rather lacking for a while, hope this is an improvement. Notably, it adds hooks examples, mentions values other than DOM nodes, and mentions the new cleanup functions added in 10.23.
Should address #1001 too, I expanded the warning for the callback refs section to (hopefully) clarify that a bit better.
Edit: Will try to do something similar to the Context doc, either during more gaps in holiday celebrations or in the next couple of weeks.