From d5bb3a8a7a786309b98596b9e568dfd35804a0e6 Mon Sep 17 00:00:00 2001 From: Selemondev <106826371+selemondev@users.noreply.github.com> Date: Wed, 20 Sep 2023 08:02:01 +0300 Subject: [PATCH] docs: improve the installation section for each component (#50) * docs: improve the installation section for each component * docs: improve the installation section for each component --------- Co-authored-by: Selemondev --- .eslintrc.cjs | 1 + .../theme/components/TabPreview.vue | 39 ++ apps/www/.vitepress/theme/components/index.ts | 1 + apps/www/__registry__/index.ts | 56 +-- .../src/content/docs/components/accordion.md | 198 ++++++++- .../content/docs/components/alert-dialog.md | 135 +++++- apps/www/src/content/docs/components/alert.md | 21 +- .../content/docs/components/aspect-ratio.md | 69 ++- .../www/src/content/docs/components/avatar.md | 84 +++- apps/www/src/content/docs/components/badge.md | 40 +- .../www/src/content/docs/components/button.md | 43 +- .../src/content/docs/components/calendar.md | 139 +++++- apps/www/src/content/docs/components/card.md | 20 +- .../src/content/docs/components/checkbox.md | 78 +++- .../content/docs/components/collapsible.md | 97 ++++- .../src/content/docs/components/combobox.md | 123 +++++- .../src/content/docs/components/command.md | 17 +- .../content/docs/components/context-menu.md | 355 +++++++++++++++- .../content/docs/components/date-picker.md | 6 +- .../www/src/content/docs/components/dialog.md | 141 +++++- .../content/docs/components/dropdown-menu.md | 402 +++++++++++++++++- .../src/content/docs/components/hover-card.md | 143 ++++++- apps/www/src/content/docs/components/input.md | 46 +- apps/www/src/content/docs/components/label.md | 45 +- .../src/content/docs/components/menubar.md | 378 +++++++++++++++- .../docs/components/navigation-menu.md | 358 +++++++++++++++- .../src/content/docs/components/popover.md | 143 ++++++- .../src/content/docs/components/progress.md | 68 ++- .../content/docs/components/radio-group.md | 102 ++++- .../content/docs/components/scroll-area.md | 105 ++++- .../www/src/content/docs/components/select.md | 171 +++++++- .../src/content/docs/components/separator.md | 79 +++- apps/www/src/content/docs/components/sheet.md | 18 +- .../src/content/docs/components/skeleton.md | 34 +- .../www/src/content/docs/components/slider.md | 65 ++- .../www/src/content/docs/components/switch.md | 61 ++- apps/www/src/content/docs/components/table.md | 18 +- apps/www/src/content/docs/components/tabs.md | 144 ++++++- .../src/content/docs/components/textarea.md | 30 +- .../www/src/content/docs/components/toggle.md | 65 ++- .../src/content/docs/components/tooltip.md | 101 ++++- apps/www/src/content/docs/typography.md | 84 +--- .../registry/default/example/CardWithForm.vue | 10 +- .../default/example/CheckboxDisabled.vue | 20 + .../new-york/example/AccordionDemo.vue | 2 +- .../new-york/example/DatePickerDemo.vue | 6 +- 46 files changed, 3991 insertions(+), 370 deletions(-) create mode 100644 apps/www/.vitepress/theme/components/TabPreview.vue create mode 100644 apps/www/src/lib/registry/default/example/CheckboxDisabled.vue diff --git a/.eslintrc.cjs b/.eslintrc.cjs index 6a2af8cf..9caef3c0 100644 --- a/.eslintrc.cjs +++ b/.eslintrc.cjs @@ -11,5 +11,6 @@ module.exports = { 'symbol-description': 'off', 'no-console': 'warn', 'no-tabs': 'off', + 'no-invalid-character': 'off', }, } diff --git a/apps/www/.vitepress/theme/components/TabPreview.vue b/apps/www/.vitepress/theme/components/TabPreview.vue new file mode 100644 index 00000000..025e1c34 --- /dev/null +++ b/apps/www/.vitepress/theme/components/TabPreview.vue @@ -0,0 +1,39 @@ + + + diff --git a/apps/www/.vitepress/theme/components/index.ts b/apps/www/.vitepress/theme/components/index.ts index 49421ad1..bf7a4b3a 100644 --- a/apps/www/.vitepress/theme/components/index.ts +++ b/apps/www/.vitepress/theme/components/index.ts @@ -1,4 +1,5 @@ export { default as ComponentPreview } from './ComponentPreview.vue' +export { default as TabPreview } from './TabPreview.vue' export { default as Callout } from './Callout.vue' export { default as LinkedCard } from './LinkedCard.vue' export { default as ManualInstall } from './ManualInstall.vue' diff --git a/apps/www/__registry__/index.ts b/apps/www/__registry__/index.ts index e0a88842..a4666075 100644 --- a/apps/www/__registry__/index.ts +++ b/apps/www/__registry__/index.ts @@ -694,99 +694,99 @@ export const Index = { name: 'TypographyBlockquote', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyBlockquote.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyBlockquote.vue'], + component: () => import('../src/lib/registry/default/example/TypographyBlockquote.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyBlockquote.vue'], }, TypographyDemo: { name: 'TypographyDemo', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyDemo.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyDemo.vue'], + component: () => import('../src/lib/registry/default/example/TypographyDemo.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyDemo.vue'], }, TypographyH1: { name: 'TypographyH1', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyH1.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyH1.vue'], + component: () => import('../src/lib/registry/default/example/TypographyH1.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyH1.vue'], }, TypographyH2: { name: 'TypographyH2', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyH2.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyH2.vue'], + component: () => import('../src/lib/registry/default/example/TypographyH2.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyH2.vue'], }, TypographyH3: { name: 'TypographyH3', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyH3.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyH3.vue'], + component: () => import('../src/lib/registry/default/example/TypographyH3.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyH3.vue'], }, TypographyH4: { name: 'TypographyH4', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyH4.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyH4.vue'], + component: () => import('../src/lib/registry/default/example/TypographyH4.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyH4.vue'], }, TypographyInlineCode: { name: 'TypographyInlineCode', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyInlineCode.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyInlineCode.vue'], + component: () => import('../src/lib/registry/default/example/TypographyInlineCode.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyInlineCode.vue'], }, TypographyLarge: { name: 'TypographyLarge', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyLarge.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyLarge.vue'], + component: () => import('../src/lib/registry/default/example/TypographyLarge.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyLarge.vue'], }, TypographyLead: { name: 'TypographyLead', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyLead.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyLead.vue'], + component: () => import('../src/lib/registry/default/example/TypographyLead.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyLead.vue'], }, TypographyList: { name: 'TypographyList', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyList.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyList.vue'], + component: () => import('../src/lib/registry/default/example/TypographyList.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyList.vue'], }, TypographyMuted: { name: 'TypographyMuted', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyMuted.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyMuted.vue'], + component: () => import('../src/lib/registry/default/example/TypographyMuted.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyMuted.vue'], }, TypographyP: { name: 'TypographyP', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyP.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyP.vue'], + component: () => import('../src/lib/registry/default/example/TypographyP.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyP.vue'], }, TypographySmall: { name: 'TypographySmall', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographySmall.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographySmall.vue'], + component: () => import('../src/lib/registry/default/example/TypographySmall.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographySmall.vue'], }, TypographyTable: { name: 'TypographyTable', type: 'components:example', registryDependencies: [], - component: () => import('../src/lib/registry/new-york/example/TypographyTable.vue').then(m => m.default), - files: ['../src/lib/registry/new-york/example/TypographyTable.vue'], + component: () => import('../src/lib/registry/default/example/TypographyTable.vue').then(m => m.default), + files: ['../src/lib/registry/default/example/TypographyTable.vue'], }, }, } diff --git a/apps/www/src/content/docs/components/accordion.md b/apps/www/src/content/docs/components/accordion.md index e664a141..4f4c29cd 100644 --- a/apps/www/src/content/docs/components/accordion.md +++ b/apps/www/src/content/docs/components/accordion.md @@ -8,38 +8,204 @@ primitive: https://www.radix-vue.com/components/accordion.html - - ## Installation + + + + + ## Usage ```vue - - - Is it accessible? - - Yes. It adheres to the WAI-ARIA design pattern. - - - -``` \ No newline at end of file + +``` + diff --git a/apps/www/src/content/docs/components/alert-dialog.md b/apps/www/src/content/docs/components/alert-dialog.md index b771eee8..4e042861 100644 --- a/apps/www/src/content/docs/components/alert-dialog.md +++ b/apps/www/src/content/docs/components/alert-dialog.md @@ -7,26 +7,137 @@ primitive: https://www.radix-vue.com/components/alert-dialog.html - - - ## Installation -```bash -npx shadcn-vue@latest add alert-dialog -``` - - + + + + + + ## Usage @@ -42,7 +153,7 @@ import { AlertDialogHeader, AlertDialogTitle, AlertDialogTrigger, -} from '@/lib/registry/default/ui/alert-dialog' +} from '@/components/ui/alert-dialog'