Skip to content
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

Basic docs structure done for all core-ui demos #31

Merged
merged 4 commits into from
May 28, 2024
Merged

Basic docs structure done for all core-ui demos #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dd1da21
added missing demos for documentation, cannot build packages because …
May 24, 2024
ffecb76
added missing demos for documentation, cannot build packages because …
May 24, 2024
34b78ce
Fix lockfile
apuntovanini May 24, 2024
0070855
added remaining mdx files for core ui and adjusted relatives demos
May 27, 2024
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
243 changes: 107 additions & 136 deletions docs/content/docs/core/breadcrumb.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,90 +3,84 @@ title: "Breadcrumb"
description: a great way to use breadcrumbs!
---

import { Button } from "@uidu/button-ui";
import BreadcrumbDemo from "../../../src/docs/demos/core/breadcrumb-demo";

<div className="flex items-center">
<a className="mr-4 " href="https://www.npmjs.com/package/@uidu/breadcrumb-ui" target="_blank">@uidu/breadcrumb-ui</a>
<a className="mx-4" href="https://github.com/uidu-org/Guidu-native/tree/main/packages/web/components/core/breadcrumb" target="_blank">Source</a>
<Button variant="link"><a className="mr-4 !no-underline" href="https://www.npmjs.com/package/@uidu/breadcrumb-ui" target="_blank">@uidu/breadcrumb-ui</a></Button>
<Button variant="link"><a className="mx-4 !no-underline" href="https://github.com/uidu-org/Guidu-native/tree/main/packages/web/components/core/breadcrumb" target="_blank">Source</a></Button>
</div>

## Breadcrumb

{" "}

<BreadcrumbDemo />

## Usage

<Tabs items={["preview", "code"]}>

<Tab value="preview">

{" "}

<div className="flex items-center justify-center py-16">
<BreadcrumbDemo />
</div>

</Tab>

<Tab value="code">

```tsx
"use client";

import {
Breadcrumb,
BreadcrumbEllipsis,
BreadcrumbItem,
BreadcrumbLink,
BreadcrumbList,
BreadcrumbPage,
BreadcrumbSeparator,
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuTrigger,
} from "@uidu/core-ui";

export default function BreadcrumbDemo() {
return (
<Breadcrumb>
<BreadcrumbList>
<BreadcrumbItem>
<BreadcrumbLink href="/">Home</BreadcrumbLink>
</BreadcrumbItem>
<BreadcrumbSeparator />
<BreadcrumbItem>
<DropdownMenu>
<DropdownMenuTrigger className="flex items-center gap-1">
<BreadcrumbEllipsis className="h-4 w-4" />
<span className="sr-only">Toggle menu</span>
</DropdownMenuTrigger>
<DropdownMenuContent align="start">
<DropdownMenuItem>Documentation</DropdownMenuItem>
<DropdownMenuItem>Themes</DropdownMenuItem>
<DropdownMenuItem>GitHub</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>
</BreadcrumbItem>
<BreadcrumbSeparator />
<BreadcrumbItem>
<BreadcrumbLink href="/docs/core/accordion">Accordion</BreadcrumbLink>
</BreadcrumbItem>
<BreadcrumbSeparator />
<BreadcrumbItem>
<BreadcrumbPage>Breadcrumb</BreadcrumbPage>
</BreadcrumbItem>
</BreadcrumbList>
</Breadcrumb>
);
}
```

</Tab>

</Tabs>
<Tabs items={["preview" , "code"]}>
<Tab value="preview">
<div className="py-16 flex items-center justify-center">
<BreadcrumbDemo />
</div>
</Tab>
<Tab value="code">
```tsx
"use client";

import {
Breadcrumb,
BreadcrumbEllipsis,
BreadcrumbItem,
BreadcrumbLink,
BreadcrumbList,
BreadcrumbPage,
BreadcrumbSeparator,
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuTrigger,
} from "@uidu/core-ui";

export default function BreadcrumbDemo() {
return (
<div className="not-prose">
<Breadcrumb>
<BreadcrumbList>
<BreadcrumbItem>
<BreadcrumbLink href="/">Home</BreadcrumbLink>
</BreadcrumbItem>
<BreadcrumbSeparator />
<BreadcrumbItem>
<DropdownMenu>
<DropdownMenuTrigger className="flex items-center gap-1">
<BreadcrumbEllipsis className="w-4 h-4" />
<span className="sr-only">Toggle menu</span>
</DropdownMenuTrigger>
<DropdownMenuContent align="start">
<DropdownMenuItem>Documentation</DropdownMenuItem>
<DropdownMenuItem>Themes</DropdownMenuItem>
<DropdownMenuItem>GitHub</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>
</BreadcrumbItem>
<BreadcrumbSeparator />
<BreadcrumbItem>
<BreadcrumbLink href="/docs/core/accordion">
Accordion
</BreadcrumbLink>
</BreadcrumbItem>
<BreadcrumbSeparator />
<BreadcrumbItem>
<BreadcrumbPage>Breadcrumb</BreadcrumbPage>
</BreadcrumbItem>
</BreadcrumbList>
</Breadcrumb>
</div>
);
}
```
</Tab>
</Tabs>

## Installation

Expand All @@ -103,66 +97,43 @@ export default function BreadcrumbDemo() {
</Tab>
</Tabs>

<Tabs items={["preview", "code"]}>
<Tab value="preview">
<div style={{ height: 300, display: "grid", placeItems: "center" }} className="not-prose">
<BreadcrumbDemo />
</div>
</Tab>

<Tab value="code">
```tsx
"use client";

import {
Breadcrumb,
BreadcrumbEllipsis,
BreadcrumbItem,
BreadcrumbLink,
BreadcrumbList,
BreadcrumbPage,
BreadcrumbSeparator,
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuTrigger,
} from "@uidu/core-ui";

export default function BreadcrumbDemo() {
return (
<Breadcrumb>
<BreadcrumbList>
<BreadcrumbItem>
<BreadcrumbLink href="/">Home</BreadcrumbLink>
</BreadcrumbItem>
<BreadcrumbSeparator />
<BreadcrumbItem>
<DropdownMenu>
<DropdownMenuTrigger className="flex items-center gap-1">
<BreadcrumbEllipsis className="h-4 w-4" />
<span className="sr-only">Toggle menu</span>
</DropdownMenuTrigger>
<DropdownMenuContent align="start">
<DropdownMenuItem>Documentation</DropdownMenuItem>
<DropdownMenuItem>Themes</DropdownMenuItem>
<DropdownMenuItem>GitHub</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>
</BreadcrumbItem>
<BreadcrumbSeparator />
<BreadcrumbItem>
<BreadcrumbLink href="/docs/core/accordion">Accordion</BreadcrumbLink>
</BreadcrumbItem>
<BreadcrumbSeparator />
<BreadcrumbItem>
<BreadcrumbPage>Breadcrumb</BreadcrumbPage>
</BreadcrumbItem>
</BreadcrumbList>
</Breadcrumb>
);
}
```

</Tab>

</Tabs>
## Import

<Tabs items={["generic" , "individual"]}>
<Tab value="generic">
```tsx
import {
Breadcrumb,
BreadcrumbEllipsis,
BreadcrumbItem,
BreadcrumbLink,
BreadcrumbList,
BreadcrumbPage,
BreadcrumbSeparator,
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuTrigger,
} from "@uidu/core-ui";
```
</Tab>
<Tab value="individual">
```tsx
import {
Breadcrumb,
BreadcrumbEllipsis,
BreadcrumbItem,
BreadcrumbLink,
BreadcrumbList,
BreadcrumbPage,
BreadcrumbSeparator,
} from "@uidu/breadcrumb-ui";
import {
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuTrigger,
} from "@uidu/dropdown-menu-ui";
```
</Tab>
</Tabs>
4 changes: 4 additions & 0 deletions docs/content/docs/core/button-group.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Button Group"
description: "a beautiful button group"
---
2 changes: 1 addition & 1 deletion docs/content/docs/core/card.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ import CardWithForm from "../../../src/docs/demos/core/card-with-form";
<Tabs items={["preview" , "code"]}>
<Tab value="preview">
<div className="py-16 flex items-center justify-center">
<CardWithForm />
<CardWithForm />
</div>
</Tab>
<Tab value="code">
Expand Down
Loading
Loading