docs: fence the TSDoc usage examples (Tabs, Dropdown) so they render as code#65
Merged
Merged
Conversation
Autodocs renders the component description as Markdown, so an indented JSX example gets parsed with its tags as raw HTML and the wrapper tag (e.g. </Tabs>) leaks outside the code box. Wrap both examples in ```tsx fences so they render as a single code block. Same fix as Popover (#53).
|
📚 Storybook preview: https://pr-65-propel-storybook.vamsi-906.workers.dev |
There was a problem hiding this comment.
Pull request overview
This PR fixes Storybook autodocs rendering for the Tabs and Dropdown root TSDoc usage examples by converting indented JSX snippets (which Markdown can misparse as raw HTML) into fenced tsx code blocks so they render as a single syntax-highlighted code block.
Changes:
- Fence the Tabs root TSDoc JSX usage example with a
tsxMarkdown code block. - Fence the Dropdown root TSDoc JSX usage example with a
tsxMarkdown code block.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/propel/src/components/tabs/index.tsx | Converts the Tabs root usage example to a fenced tsx code block for correct autodocs rendering. |
| packages/propel/src/components/dropdown/index.tsx | Converts the Dropdown root usage example to a fenced tsx code block for correct autodocs rendering. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
bhaveshraja
approved these changes
Jun 10, 2026
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.
Autodocs renders each component's description as Markdown. The Tabs and Dropdown root TSDoc had indented JSX usage examples, and Markdown parses the JSX tags as raw HTML, so the wrapper tag (
</Tabs>/</Dropdown>) leaks out of the code box and the example renders broken (see the Popover report).Fix: wrap both examples in
```tsxfenced blocks so they render as one syntax-highlighted code block. Comment-only; no code change. Same fix is on #53 (Popover) and #15 (TableEditableCell). Verified the equivalent fix renders correctly on the Popover docs page.