From 7bcb5b5428f2eb0c1843064f12dc74bfa3ac1312 Mon Sep 17 00:00:00 2001 From: Gerzon05 Date: Fri, 20 Sep 2024 13:35:18 -0500 Subject: [PATCH] docs: the card component is documented --- docs/content/docs/components/accordion.mdx | 2 +- docs/content/docs/components/card.mdx | 131 ++++++++++++++++++++- docs/mdx-components.tsx | 8 +- 3 files changed, 138 insertions(+), 3 deletions(-) diff --git a/docs/content/docs/components/accordion.mdx b/docs/content/docs/components/accordion.mdx index a7c3340..416df05 100644 --- a/docs/content/docs/components/accordion.mdx +++ b/docs/content/docs/components/accordion.mdx @@ -269,7 +269,7 @@ function App() { } ``` -## Api +## API ### AccordionItem Props diff --git a/docs/content/docs/components/card.mdx b/docs/content/docs/components/card.mdx index 71b2ac6..86d9fee 100644 --- a/docs/content/docs/components/card.mdx +++ b/docs/content/docs/components/card.mdx @@ -1,4 +1,133 @@ --- title: Card description: A card is a flexible and extensible content container. ---- \ No newline at end of file +--- + +# Imports + +- **Card**: The main component to display a list of accordion items. +- **CardHeader**: The main component to display a list of accordion items. +- **CardTitle**: The main component to display a list of accordion items. +- **CardContent**: The main component to display a list of accordion items. +- **CardDescription**: The main component to display a list of accordion items. +- **CardFooter**: The main component to display a list of accordion items. + +## Usage + + +
+ +
+ + + Card Title + + + Sagittis, eu pretium massa quisque cursus augue massa cursus. Sed quisque velit, auctor at lobortis hac tincidunt sodales id. Elit interdum vel nisi, in enim sagittis at. Netus sagittis eleifend aliquet urna quis. + + + + $99.90 + + + + + +
+ +```jsx +import {Card, CardHeader, CardTitle, CardContent, CardDescription, CardFooter} from '@openlite/ui' + +function App() { + return( + +
+ +
+ + + Card Title + + + Sagittis, eu pretium massa quisque cursus augue massa cursus. Sed quisque velit, auctor at lobortis hac tincidunt sodales id. Elit interdum vel nisi, in enim sagittis at. Netus sagittis eleifend aliquet urna quis. + + + + $99.90 + + + + + +
+ ) +} +``` + +## Examples + +### Card with horizontal orientation + + +
+ +
+
+ + + Card Title + + + Sagittis, eu pretium massa quisque cursus augue massa cursus. Sed quisque velit, auctor at lobortis hac tincidunt sodales id. Elit interdum vel nisi, in enim sagittis at. Netus sagittis eleifend aliquet urna quis. + + + + $99.90 + + + + + +
+
+ +```jsx +import {Card, CardHeader, CardTitle, CardContent, CardDescription, CardFooter} from '@openlite/ui' + +function App() { + return( + +
+ +
+
+ + + Card Title + + + Sagittis, eu pretium massa quisque cursus augue massa cursus. Sed quisque velit, auctor at lobortis hac tincidunt sodales id. Elit interdum vel nisi, in enim sagittis at. Netus sagittis eleifend aliquet urna quis. + + + + $99.90 + + + + + +
+
+ ) +} +``` + +## API + +### Card Props + +| Props | Type | Description | +| --- | --- | --- | +| `rounded` | `'none' \| 'sm' \| 'md' \| 'lg'` | The rounded of the Card. | +| `orientation` | `'horizontal' \| 'vertical'` | The orientation of the Card. | +| `padded` | `'none' \| 'sm' \| 'md' \| 'lg'` | The padding of the CardHeader, CardTitle, CardContent, CardFooter | diff --git a/docs/mdx-components.tsx b/docs/mdx-components.tsx index f23c238..3c6ba30 100644 --- a/docs/mdx-components.tsx +++ b/docs/mdx-components.tsx @@ -12,7 +12,7 @@ import { import type { ReactNode } from 'react' import { Popup, PopupContent, PopupTrigger } from 'fumadocs-ui/twoslash/popup' import { cn } from '@openlite/ui/tailwind' -import { Alert, AlertDescription, AlertTitle, AspectRatio, Avatar, AvatarFallback, AvatarImage, Badge, Breadcrumb, BreadcrumbEllipsis, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator, AccordionContent, AccordionItem, AccordionTrigger, Accordion as AccordionUi, Button } from '@openlite/ui' +import { AccordionContent, AccordionItem, AccordionTrigger, Accordion as AccordionUi, Alert, AlertDescription, AlertTitle, AspectRatio, Avatar, AvatarFallback, AvatarImage, Badge, Breadcrumb, BreadcrumbEllipsis, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator, Button, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle } from '@openlite/ui' export function useMDXComponents(components: MDXComponents): MDXComponents { return { @@ -47,6 +47,12 @@ export function useMDXComponents(components: MDXComponents): MDXComponents { BreadcrumbPage, BreadcrumbSeparator, BreadcrumbEllipsis, + Card, + CardHeader, + CardTitle, + CardContent, + CardDescription, + CardFooter, Callout, TypeTable, Accordion,