docs: add card doc

oil-oil · Sep 18, 2023 · c1a5f4d · c1a5f4d
2 parents 3422b33 + f406915
commit c1a5f4d
Show file tree

Hide file tree

Showing 26 changed files with 211 additions and 72 deletions.
diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/alert.md b/packages/docs/docs/.vitepress/docs/documentation/components/alert.md
@@ -49,25 +49,20 @@ slots :
       type: slot
       values:
       description: Add an icon to the alert.
-      default: 
       usageUrl: alert#icon
     - name: title
       type: slot
       values:
       description: Add a title to the alert.
-      default: 
       usageUrl: alert#title
     - name: page-{n}
       type: slot
       values: (page-1 - page-{n})
       description: Add the pages to the alert if it is page one would be (slot='page-1').
-      default: 
       usageUrl: alert#title
     - name: footer
       type: slot
-      values:
       description: Add a footer to the alert.
-      default: 
       usageUrl: alert#footer
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/avatar.md b/packages/docs/docs/.vitepress/docs/documentation/components/avatar.md
@@ -89,15 +89,11 @@ props :
 slots : 
     - name: badge
       type: slot
-      values:
       description: Add to the badge everything that is inside the slot, commonly used for numbers and an icon.
-      default: 
       usageUrl: avatar#badge
     - name: icons
       type: slot
-      values:
       description: Add a space to put icons next to the avatar.
-      default: 
       usageUrl: avatar#badge
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/button.md b/packages/docs/docs/.vitepress/docs/documentation/components/button.md
@@ -77,9 +77,7 @@ props :
 slots : 
     - name: animate
       type: slot
-      values:
       description: Slot for adding elements that will be displayed in the animation.
-      default: 
       usageUrl: button#animate
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/card.md b/packages/docs/docs/.vitepress/docs/documentation/components/card.md
@@ -1,3 +1,35 @@
+---
+prev: Sidebar
+props : 
+    - name: type
+      type: String
+      values: 1,2,3,4,5
+      description: Change the color of the checkbox and some of its sub components.
+      default: 1
+      usageUrl: card#Type2
+slots : 
+    - name: text
+      type: slot
+      description: Add text to the card in the section determined by the card type.	
+      usageUrl: card#default
+    - name: title
+      type: slot
+      description: Add the title to the card in the section determined by the type of card.
+      usageUrl: card#default
+    - name: buttons
+      type: slot
+      description: Add the buttons to the card in the section determined by the type of card.
+      usageUrl: card#default
+    - name: interactions
+      type: slot
+      description: Add the interactions to the card in the section determined by the card type.
+      usageUrl: card#default
+    - name: img
+      type: slot
+      description: Add the image or video to the card in the section determined by the type of card.
+      usageUrl: card#default
+---
+
 # Card
 
 <card>
@@ -12,4 +44,50 @@ Add a card with the vs-card component for the structure of this component we hav
 - interactions
 - img
 
-</card>
+</card>
+
+<card subtitle="Type2">
+
+## Type 2
+
+Completely change the style of the letter with the property type and the value `2`
+
+</card>
+
+<card subtitle="Type3">
+
+## Type 3
+
+Completely change the style of the letter with the property type and the value `3`
+
+</card>
+
+<card subtitle="Type4">
+
+## Type 4
+
+Completely change the style of the letter with the property type and the value `4`
+
+</card>
+
+<card subtitle="Type5">
+
+## Type 5
+
+Completely change the style of the letter with the property type and the value `5`
+
+</card>
+
+<card subtitle="Group">
+
+## Group
+
+To have a group of scrolling cards you can use the `VsCardGroup` component
+
+</card>
+
+<script setup>
+import Api from "../../../theme/global-components/template/API.tsx"
+</script>
+
+<Api/>
diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/checkbox.md b/packages/docs/docs/.vitepress/docs/documentation/components/checkbox.md
@@ -47,15 +47,11 @@ props :
 slots : 
     - name: icon
       type: slot
-      values:
       description: Change the checkbox icon.
-      default: 
       usageUrl: checkbox#icon
     - name: default
       type: slot
-      values:
       description: Add a label to the checkbox.
-      default: 
       usageUrl: checkbox#default
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/input.md b/packages/docs/docs/.vitepress/docs/documentation/components/input.md
@@ -6,19 +6,16 @@ props :
       type: String
       values: String
       description: Add a placeholder to the input.
-      default: 
       usageUrl: input#label-placeholder
     - name: label
       type: String
       values: string
       description: Add a label above the input.
-      default: 
       usageUrl: input#label
     - name: labelPlaceholder
       type: String
       values: string
       description: Add a placeholder converts to focus on a label.
-      default: 
       usageUrl: input#label-placeholder
     - name: color
       type: String
@@ -30,7 +27,6 @@ props :
       type: String
       values: VuesaxColors | RGB | HEX
       description: Change the background color of the input by changing its status.
-      default: 
       usageUrl: input#status
     - name: progress
       type: Number
@@ -79,13 +75,11 @@ slots :
       type: slot
       values:
       description: Add an icon to the input.
-      default: 
       usageUrl: input#icon
     - name: message
       type: slot
       values:
       description: Add an informative text below the input.
-      default: 
       usageUrl: input#message
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/loading.md b/packages/docs/docs/.vitepress/docs/documentation/components/loading.md
@@ -18,19 +18,16 @@ props :
       type: String
       values: String
       description: Add a text below the loading animation.
-      default: 
       usageUrl: loading#text
     - name: percent
       type: String
       values: (0% - 100%)
       description: Add a percentage text inside the loading.
-      default: 
       usageUrl: loading#percent
     - name: progress
       type: Number
       values: (0 - 100)
       description: Add a progress bar to the loading and the progress would be the value.
-      default: 
       usageUrl: loading#percent
     - name: opacity
       type: String

diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/notification.md b/packages/docs/docs/.vitepress/docs/documentation/components/notification.md
@@ -6,7 +6,6 @@ props :
       type: String
       values: string
       description: Add a title to the notification.
-      default: 
       usageUrl: notification#default
     - name: text
       type: String
@@ -24,13 +23,11 @@ props :
       type: String
       values: VuesaxColors | RGB | HEX
       description: Add a background color to the notification.
-      default: 
       usageUrl: notification#color
     - name: border
       type: String
       values: VuesaxColors | RGB | HEX
       description: Add a color border to the notification.
-      default: 
       usageUrl: notification#border
     - name: duration
       type: Number
@@ -90,13 +87,11 @@ props :
       type: VNode
       values: VNode
       description: Add an icon at the notification beginning
-      default: 
       usageUrl: notification#icons
     - name: content
       type: VNode
       values: VNode
       description: Change the content of the notification to the one provided as a value
-      default: 
       usageUrl: notification#example
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/radio.md b/packages/docs/docs/.vitepress/docs/documentation/components/radio.md
@@ -24,20 +24,17 @@ props :
       type: String
       values: String
       description: Determine the value of the radio input.
-      default: 
       usageUrl: radio#default
 slots : 
     - name: default
       type: slot
       values:
       description: Add a label to the radio.
-      default: 
       usageUrl: radio#default
     - name: icon
       type: slot
       values:
       description: Add an icon inside the radio.
-      default: 
       usageUrl: radio#default
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/select.md b/packages/docs/docs/.vitepress/docs/documentation/components/select.md
@@ -72,13 +72,11 @@ slots :
       type: slot
       values:
       description: Add a message below the select.
-      default: 
       usageUrl: select#message
     - name: noData
       type: slot
       values:
       description: Customize the element that is displayed when there is no data after filtering.
-      default: 
       usageUrl: select#filter
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/table.md b/packages/docs/docs/.vitepress/docs/documentation/components/table.md
@@ -54,37 +54,31 @@ slots :
       type: slot
       values:
       description: Space to put an element at the top of the table such as the input search.
-      default: 
       usageUrl: table#search-and-sort
     - name: thead
       type: slot
       values:
       description: Space representing thead element of the table where the `VsTh` components will be placed.
-      default: 
       usageUrl: table#default
     - name: tbody
       type: slot
       values:
       description: Represents the tbody element in the table and here we will put the `VsTr` components.
-      default: 
       usageUrl: table#default
     - name: header
       type: slot
       values:
       description: Space to put an element at the bottom of the table such as the pagination.
-      default: 
       usageUrl: table#pagination
     - name: notFount
       type: slot
       values:
       description: Change the item to display when there are no items in the table.
-      default: 
       usageUrl: table#search-and-sort
     - name: VsTr:#expand
       type: slot
       values:
       description: Represents the interior of the VsTr when it is expanded.
-      default: 
       usageUrl: table#expand-data
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/tooltip.md b/packages/docs/docs/.vitepress/docs/documentation/components/tooltip.md
@@ -79,13 +79,11 @@ slots :
       type: slot
       values:
       description: Add the trigger element of the tooltip.
-      default: 
       usageUrl: tooltip#default
     - name: tooltip
       type: slot
       values:
       description: It is the content that will go inside the tooltip.
-      default: 
       usageUrl: tooltip#default
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/zh/documentation/components/alert.md b/packages/docs/docs/.vitepress/docs/zh/documentation/components/alert.md
@@ -49,25 +49,21 @@ slots :
       type: slot
       values:
       description: 为警告添加图标
-      default: 
       usageUrl: alert#icon
     - name: title
       type: slot
       values:
       description: 为警告添加标题
-      default: 
       usageUrl: alert#title
     - name: page-{n}
       type: slot
       values: (page-1 - page-{n})
       description: 将页面添加到警告中，例如第一页为（slot='page-1'）
-      default: 
       usageUrl: alert#title
     - name: footer
       type: slot
       values:
       description: 为警告添加页脚
-      default: 
       usageUrl: alert#footer
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/zh/documentation/components/button.md b/packages/docs/docs/.vitepress/docs/zh/documentation/components/button.md
@@ -79,7 +79,6 @@ slots :
       type: slot
       values:
       description: 用于添加将在动画中显示的元素的插槽
-      default: 
       usageUrl: button#animate
 ---
 

diff --git a/packages/docs/docs/.vitepress/docs/zh/documentation/components/checkbox.md b/packages/docs/docs/.vitepress/docs/zh/documentation/components/checkbox.md
@@ -49,13 +49,11 @@ slots :
       type: slot
       values:
       description: 更改组件图标
-      default: 
       usageUrl: checkbox#icon
     - name: default
       type: slot
       values:
       description: 为组件添加标签
-      default: 
       usageUrl: checkbox#default
 ---