docs: improve the installation section for each component

This commit is contained in:
Selemondev 2023-09-14 12:05:51 +03:00
parent 7abf5b29ef
commit 79f346a629
37 changed files with 77 additions and 63 deletions

View File

@ -11,5 +11,6 @@ module.exports = {
'symbol-description': 'off', 'symbol-description': 'off',
'no-console': 'warn', 'no-console': 'warn',
'no-tabs': 'off', 'no-tabs': 'off',
'no-invalid-character': 'off',
}, },
} }

View File

@ -31,15 +31,30 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Accordion, AccordionContent, AccordionItem, AccordionTrigger } from '@/lib/registry/default/ui/accordion' import { Accordion, AccordionContent, AccordionItem, AccordionTrigger } from '@/components/ui/accordion'
</script> </script>
<AccordionRoot> <template>
<AccordionItem value="item-1"> <Accordion type="single" collapsible class="w-full">
<AccordionTrigger>Is it accessible?</AccordionTrigger> <AccordionItem value="item-1">
<AccordionContent> <AccordionTrigger>Is it accessible?</AccordionTrigger>
Yes. It adheres to the WAI-ARIA design pattern. <AccordionContent>
</AccordionContent> Yes. It adheres to the WAI-ARIA design pattern.
</AccordionItem> </AccordionContent>
</AccordionRoot> </AccordionItem>
<AccordionItem value="item-2">
<AccordionTrigger>Is it styled?</AccordionTrigger>
<AccordionContent>
Yes. It comes with default styles that matches the other
components&apos; aesthetic.
</AccordionContent>
</AccordionItem>
<AccordionItem value="item-3">
<AccordionTrigger>Is it animated?</AccordionTrigger>
<AccordionContent>
Yes. It's animated by default, but you can disable it if you prefer.
</AccordionContent>
</AccordionItem>
</Accordion>
</template>
``` ```

View File

@ -42,7 +42,7 @@ import {
AlertDialogHeader, AlertDialogHeader,
AlertDialogTitle, AlertDialogTitle,
AlertDialogTrigger, AlertDialogTrigger,
} from '@/lib/registry/default/ui/alert-dialog' } from '@/components/ui/alert-dialog'
</script> </script>
<template> <template>

View File

@ -29,7 +29,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Alert, AlertDescription, AlertTitle } from '@/lib/registry/default/ui/alert' import { Alert, AlertDescription, AlertTitle } from '@/components/ui/alert'
</script> </script>
<template> <template>

View File

@ -29,14 +29,14 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { AspectRatio } from '@/lib/registry/default/ui/aspect-ratio' import { AspectRatio } from '@/components/ui/aspect-ratio'
</script> </script>
<template> <template>
<AspectRatio> <div class="w-[450px]">
<img <AspectRatio :ratio="16 / 9">
src="https://images.unsplash.com/photo-1588345921523-c2dcdb7f1dcd?w=800&dpr=2&q=80" <img src="https://images.unsplash.com/photo-1588345921523-c2dcdb7f1dcd?w=800&dpr=2&q=80">
> </AspectRatio>
</AspectRatio> </div>
</template> </template>
``` ```

View File

@ -30,7 +30,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Avatar, AvatarFallback, AvatarImage } from '@/lib/registry/default/ui/avatar' import { Avatar, AvatarFallback, AvatarImage } from '@/components/ui/avatar'
</script> </script>
<template> <template>

View File

@ -28,7 +28,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Badge } from '@/lib/registry/default/ui/badge' import { Badge } from '@/components/ui/badge'
</script> </script>
<template> <template>

View File

@ -27,7 +27,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Button } from '@/lib/registry/default/ui/button' import { Button } from '@/components/ui/button'
</script> </script>
<template> <template>

View File

@ -31,7 +31,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Calendar } from '@/lib/registry/default/ui/calendar' import { Calendar } from '@/components/ui/calendar'
</script> </script>
<template> <template>

View File

@ -35,7 +35,7 @@ import {
CardFooter, CardFooter,
CardHeader, CardHeader,
CardTitle, CardTitle,
} from '@/lib/registry/default/ui/card' } from '@/components/ui/card'
</script> </script>
<template> <template>

View File

@ -30,7 +30,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Checkbox } from '@/lib/registry/default/ui/checkbox' import { Checkbox } from '@/components/ui/checkbox'
</script> </script>
<template> <template>

View File

@ -31,24 +31,22 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { ref } from 'vue'
import { import {
Collapsible, Collapsible,
CollapsibleContent, CollapsibleContent,
CollapsibleTrigger, CollapsibleTrigger,
} from '@/lib/registry/default/ui/collapsible' } from '@/components/ui/collapsible'
const isOpen = ref(false) const isOpen = ref(false)
</script> </script>
<template> <template>
<Collapsible <Collapsible v-model:open="isOpen">
v-model:open="isOpen" <CollapsibleTrigger>Can I use this in my project?</CollapsibleTrigger>
>
<CollapsibleTrigger>
Trigger
</CollapsibleTrigger>
<CollapsibleContent> <CollapsibleContent>
Content Yes. Free to use for personal and commercial projects. No attribution
required.
</CollapsibleContent> </CollapsibleContent>
</Collapsible> </Collapsible>
</template> </template>

View File

@ -45,7 +45,7 @@ import {
ContextMenuSubContent, ContextMenuSubContent,
ContextMenuSubTrigger, ContextMenuSubTrigger,
ContextMenuTrigger, ContextMenuTrigger,
} from '@/lib/registry/default/ui/context-menu' } from '@/components/ui/context-menu'
</script> </script>
<template> <template>

View File

@ -21,13 +21,13 @@ import { Calendar as CalendarIcon } from 'lucide-vue-next'
import { ref } from 'vue' import { ref } from 'vue'
import { cn } from '@/lib/utils' import { cn } from '@/lib/utils'
import { Button } from '@/lib/registry/default/ui/button' import { Button } from '@/components/ui/button'
import { Calendar } from '@/lib/registry/default/ui/calendar' import { Calendar } from '@/components/ui/calendar'
import { import {
Popover, Popover,
PopoverContent, PopoverContent,
PopoverTrigger, PopoverTrigger,
} from '@/lib/registry/default/ui/popover' } from '@/components/ui/popover'
const date = ref<Date>() const date = ref<Date>()
</script> </script>

View File

@ -38,7 +38,7 @@ import {
DialogHeader, DialogHeader,
DialogTitle, DialogTitle,
DialogTrigger, DialogTrigger,
} from '@/lib/registry/default/ui/dialog' } from '@/components/ui/dialog'
</script> </script>
<template> <template>

View File

@ -37,7 +37,7 @@ import {
DropdownMenuLabel, DropdownMenuLabel,
DropdownMenuSeparator, DropdownMenuSeparator,
DropdownMenuTrigger, DropdownMenuTrigger,
} from '@/lib/registry/default/ui/dropdown-menu' } from '@/components/ui/dropdown-menu'
</script> </script>
<template> <template>

View File

@ -34,14 +34,14 @@ import {
HoverCard, HoverCard,
HoverCardContent, HoverCardContent,
HoverCardTrigger, HoverCardTrigger,
} from '@/lib/registry/default/ui/hover-card' } from '@/components/ui/hover-card'
</script> </script>
<template> <template>
<HoverCard> <HoverCard>
<HoverCardTrigger>Hover</HoverCardTrigger> <HoverCardTrigger>Hover</HoverCardTrigger>
<HoverCardContent> <HoverCardContent>
The React Framework created and maintained by @vercel. The Vue Framework created and maintained by @vuejs.
</HoverCardContent> </HoverCardContent>
</HoverCard> </HoverCard>
</template> </template>

View File

@ -29,7 +29,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Input } from '@/lib/registry/default/ui/input' import { Input } from '@/components/ui/input'
</script> </script>
<template> <template>

View File

@ -11,7 +11,7 @@ primitive: https://www.radix-vue.com/components/label.html
## Installation ## Installation
```bash ```bash
npx shadcn-vue@latest add input npx shadcn-vue@latest add label
``` ```
<ManualInstall> <ManualInstall>
@ -29,7 +29,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Label } from '@/lib/registry/default/ui/label' import { Label } from '@/components/ui/label'
</script> </script>
<template> <template>

View File

@ -38,7 +38,7 @@ import {
MenubarSeparator, MenubarSeparator,
MenubarShortcut, MenubarShortcut,
MenubarTrigger, MenubarTrigger,
} from '@/lib/registry/default/ui/menubar' } from '@/components/ui/menubar'
</script> </script>
<template> <template>

View File

@ -38,7 +38,7 @@ import {
NavigationMenuList, NavigationMenuList,
NavigationMenuTrigger, NavigationMenuTrigger,
NavigationMenuViewport, NavigationMenuViewport,
} from '@/lib/registry/default/ui/navigation-menu' } from '@/components/ui/navigation-menu'
</script> </script>
<template> <template>

View File

@ -35,7 +35,7 @@ import {
Popover, Popover,
PopoverContent, PopoverContent,
PopoverTrigger, PopoverTrigger,
} from '@/lib/registry/default/ui/popover' } from '@/components/ui/popover'
</script> </script>
<template> <template>

View File

@ -30,7 +30,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Progress } from '@/lib/registry/default/ui/progress' import { Progress } from '@/components/ui/progress'
</script> </script>
<template> <template>

View File

@ -30,8 +30,8 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Label } from '@/lib/registry/default/ui/label' import { Label } from '@/components/ui/label'
import { RadioGroup, RadioGroupItem } from '@/lib/registry/default/ui/radio-group' import { RadioGroup, RadioGroupItem } from '@/components/ui/radio-group'
</script> </script>
<template> <template>

View File

@ -30,7 +30,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { ScrollArea } from '@/lib/registry/default/ui/scroll-area' import { ScrollArea } from '@/components/ui/scroll-area'
</script> </script>
<template> <template>

View File

@ -39,7 +39,7 @@ import {
SelectLabel, SelectLabel,
SelectTrigger, SelectTrigger,
SelectValue, SelectValue,
} from '@/lib/registry/default/ui/select' } from '@/components/ui/select'
</script> </script>
<template> <template>

View File

@ -30,7 +30,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Separator } from '@/lib/registry/default/ui/separator' import { Separator } from '@/components/ui/separator'
</script> </script>
<template> <template>

View File

@ -36,7 +36,7 @@ import {
SheetHeader, SheetHeader,
SheetTitle, SheetTitle,
SheetTrigger, SheetTrigger,
} from '@/lib/registry/default/ui/sheet' } from '@/components/ui/sheet'
</script> </script>
<template> <template>

View File

@ -27,7 +27,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Skeleton } from '@/lib/registry/default/ui/skeleton' import { Skeleton } from '@/components/ui/skeleton'
</script> </script>
<template> <template>

View File

@ -30,7 +30,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Slider } from '@/lib/registry/default/ui/slider' import { Slider } from '@/components/ui/slider'
</script> </script>
<template> <template>

View File

@ -29,7 +29,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Switch } from '@/lib/registry/default/ui/switch' import { Switch } from '@/components/ui/switch'
</script> </script>
<template> <template>

View File

@ -35,7 +35,7 @@ import {
TableHead, TableHead,
TableHeader, TableHeader,
TableRow, TableRow,
} from '@/lib/registry/default/ui/table' } from '@/components/ui/table'
</script> </script>
<template> <template>

View File

@ -29,7 +29,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Tabs, TabsContent, TabsList, TabsTrigger } from '@/lib/registry/default/ui/tabs' import { Tabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'
</script> </script>
<template> <template>

View File

@ -27,7 +27,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Textarea } from '@/lib/registry/default/ui/textarea' import { Textarea } from '@/components/ui/textarea'
</script> </script>
<template> <template>

View File

@ -30,7 +30,7 @@ npm install radix-vue
```vue ```vue
<script setup lang="ts"> <script setup lang="ts">
import { Toggle } from '@/lib/registry/default/ui/toggle' import { Toggle } from '@/components/ui/toggle'
</script> </script>
<template> <template>

View File

@ -34,7 +34,7 @@ import {
TooltipContent, TooltipContent,
TooltipProvider, TooltipProvider,
TooltipTrigger TooltipTrigger
} from '@/lib/registry/default/ui/tooltip' } from '@/components/ui/tooltip'
</script> </script>
<template> <template>

View File

@ -4,13 +4,13 @@ import { ref } from 'vue'
import RadixIconsCalendar from '~icons/radix-icons/calendar' import RadixIconsCalendar from '~icons/radix-icons/calendar'
import { cn } from '@/lib/utils' import { cn } from '@/lib/utils'
import { Button } from '@/lib/registry/new-york/ui/button' import { Button } from '@/components/ui/button'
import { Calendar } from '@/lib/registry/new-york/ui/calendar' import { Calendar } from '@/components/ui/calendar'
import { import {
Popover, Popover,
PopoverContent, PopoverContent,
PopoverTrigger, PopoverTrigger,
} from '@/lib/registry/new-york/ui/popover' } from '@/components/ui/popover'
const date = ref<Date>() const date = ref<Date>()
</script> </script>