Skip to content

docs: fence the TSDoc usage examples (Tabs, Dropdown) so they render as code #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lifeiscontent merged 1 commit into from
Jun 10, 2026
Merged

docs: fence the TSDoc usage examples (Tabs, Dropdown) so they render as code #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions packages/propel/src/components/dropdown/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@ import { CheckboxVisual } from "../checkbox/index";
* The dropdown menu root — a Base UI `Menu.Root`. Holds open state and wires the
* trigger to the content. Compose it with `DropdownTrigger` + `DropdownContent`:
*
* <Dropdown>
* <DropdownTrigger>Open</DropdownTrigger>
* <DropdownContent>
* <DropdownItem label="Edit" />
* <DropdownSeparator />
* <DropdownItem label="Delete" />
* </DropdownContent>
* </Dropdown>
* ```tsx
* <Dropdown>
* <DropdownTrigger>Open</DropdownTrigger>
* <DropdownContent>
* <DropdownItem label="Edit" />
* <DropdownSeparator />
* <DropdownItem label="Delete" />
* </DropdownContent>
* </Dropdown>
* ```
*/
export const Dropdown = Menu.Root;
export type DropdownProps = React.ComponentProps<typeof Menu.Root>;
Expand Down
18 changes: 10 additions & 8 deletions packages/propel/src/components/tabs/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,16 @@ export type TabsProps = Omit<
* Root of a tab set. Groups a `TabsList` of `Tab`s with their `TabsPanel`s and
* tracks which tab is active. Build the compound API from its parts:
*
* <Tabs variant="contained" defaultValue="overview">
* <TabsList>
* <Tab value="overview">Overview</Tab>
* <Tab value="activity">Activity</Tab>
* </TabsList>
* <TabsPanel value="overview">…</TabsPanel>
* <TabsPanel value="activity">…</TabsPanel>
* </Tabs>
* ```tsx
* <Tabs variant="contained" defaultValue="overview">
* <TabsList>
* <Tab value="overview">Overview</Tab>
* <Tab value="activity">Activity</Tab>
* </TabsList>
* <TabsPanel value="overview">…</TabsPanel>
* <TabsPanel value="activity">…</TabsPanel>
* </Tabs>
* ```
*/
export function Tabs({ variant, ...props }: TabsProps) {
return (
Expand Down