fix: fix tsdocs (#21)

Co-authored-by: Panpan <wurui.dev@gmail.com>
uni-helper · Nov 6, 2024 · fc0877a · fc0877a
1 parent e59bdb7
commit fc0877a
Show file tree

Hide file tree

Showing 108 changed files with 791 additions and 108 deletions.
diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css
@@ -1,16 +1,16 @@
 /**
  * Colors
  * -------------------------------------------------------------------------- */
- :root {
+:root {
   --vp-c-brand-1: hsl(128, 56%, 38%);
   --vp-c-brand-2: hsl(128, 56%, 55%);
   --vp-c-brand-3: hsl(128, 56%, 45%);
   --vp-c-brand-soft: rgba(98, 133, 208, 0.16);
 }
 
 /**
-   * Component: Home
-   * -------------------------------------------------------------------------- */
+ * Component: Home
+ * -------------------------------------------------------------------------- */
 
 :root {
   --vp-home-hero-name-color: transparent;

diff --git a/packages/uni-app-types/src/ad/ad-content-page.ts b/packages/uni-app-types/src/ad/ad-content-page.ts
@@ -211,7 +211,13 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 短视频内容联盟广告 */
+    /**
+     * 短视频内容联盟广告
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/uni-ad/ad-content-page.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
     AdContentPage: _AdContentPage;
   }
 }
diff --git a/packages/uni-app-types/src/ad/ad-draw.ts b/packages/uni-app-types/src/ad/ad-draw.ts
@@ -67,7 +67,13 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 沉浸视频流广告 */
+    /**
+     * 沉浸视频流广告
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/uni-ad/ad-draw.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
     AdDraw: _AdDraw;
   }
 }
diff --git a/packages/uni-app-types/src/ad/ad-fullscreen-video.ts b/packages/uni-app-types/src/ad/ad-fullscreen-video.ts
@@ -97,7 +97,13 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 全屏视频广告 */
+    /**
+     * 全屏视频广告
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/uni-ad/ad-fullscreen-video.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
     AdFullscreenVideo: _AdFullscreenVideo;
   }
 }
diff --git a/packages/uni-app-types/src/ad/ad-interactive.ts b/packages/uni-app-types/src/ad/ad-interactive.ts
@@ -68,7 +68,13 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 互动广告 */
+    /**
+     * 互动广告
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/uni-ad/ad-interactive.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
     AdInteractive: _AdInteractive;
   }
 }
diff --git a/packages/uni-app-types/src/ad/ad-interstitial.ts b/packages/uni-app-types/src/ad/ad-interstitial.ts
@@ -90,7 +90,13 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 插屏广告 */
+    /**
+     * 插屏广告
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/uni-ad/ad-interstitial.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
     AdInterstitial: _AdInterstitial;
   }
 }
diff --git a/packages/uni-app-types/src/ad/ad-rewarded-video.ts b/packages/uni-app-types/src/ad/ad-rewarded-video.ts
@@ -102,7 +102,13 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 激励视频广告 */
+    /**
+     * 激励视频广告
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/uni-ad/ad-rewarded-video.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
     AdRewardedVideo: _AdRewardedVideo;
   }
 }
diff --git a/packages/uni-app-types/src/ad/ad.ts b/packages/uni-app-types/src/ad/ad.ts
@@ -121,7 +121,13 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 信息流广告 */
-    Ad: _Ad;
+    /**
+     * 信息流广告
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/uni-ad/ad-component.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
+    ad: _Ad;
   }
 }
diff --git a/packages/uni-app-types/src/basic-components/icon.ts b/packages/uni-app-types/src/basic-components/icon.ts
@@ -41,7 +41,13 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 图标 */
-    Icon: _Icon;
+    /**
+     * 图标
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/icon.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
+    icon: _Icon;
   }
 }
diff --git a/packages/uni-app-types/src/basic-components/progress.ts b/packages/uni-app-types/src/basic-components/progress.ts
@@ -130,16 +130,28 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 进度条 */
-    Progress: _Progress;
+    /**
+     * 进度条
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/progress.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
+    progress: _Progress;
   }
 }
 
 // 3.0 <= Vue <= 3.2
 declare global {
   namespace JSX {
     interface IntrinsicElements {
-      /** 进度条 */
+      /**
+       * 进度条
+       * ***
+       * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/progress.html)
+       * |
+       * [使用说明](https://uni-typed.netlify.app/)
+       */
       progress: _Progress;
     }
   }
@@ -150,7 +162,13 @@ declare global {
 declare module "vue/jsx-runtime" {
   namespace JSX {
     interface IntrinsicElements {
-      /** 进度条 */
+      /**
+       * 进度条
+       * ***
+       * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/progress.html)
+       * |
+       * [使用说明](https://uni-typed.netlify.app/)
+       */
       progress: _Progress;
     }
   }

diff --git a/packages/uni-app-types/src/basic-components/rich-text.ts b/packages/uni-app-types/src/basic-components/rich-text.ts
@@ -110,7 +110,13 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 富文本 */
+    /**
+     * 富文本
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/rich-text.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
     RichText: _RichText;
   }
 }
diff --git a/packages/uni-app-types/src/basic-components/text.ts b/packages/uni-app-types/src/basic-components/text.ts
@@ -80,6 +80,10 @@ declare global {
      * 文本组件
      *
      * 用于包裹文本内容
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/text.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
      */
     export type Text = _Text;
     /** 文本组件实例 */
@@ -93,8 +97,12 @@ declare module "vue" {
      * 文本组件
      *
      * 用于包裹文本内容
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/text.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
      */
-    Text: _Text;
+    text: _Text;
   }
 }
 
@@ -106,6 +114,10 @@ declare global {
        * 文本组件
        *
        * 用于包裹文本内容
+       * ***
+       * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/text.html)
+       * |
+       * [使用说明](https://uni-typed.netlify.app/)
        */
       text: _Text;
     }
@@ -121,6 +133,10 @@ declare module "vue/jsx-runtime" {
        * 文本组件
        *
        * 用于包裹文本内容
+       * ***
+       * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/text.html)
+       * |
+       * [使用说明](https://uni-typed.netlify.app/)
        */
       text: _Text;
     }

diff --git a/packages/uni-app-types/src/canvas/index.ts b/packages/uni-app-types/src/canvas/index.ts
@@ -131,16 +131,26 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 画布 */
-    Canvas: _Canvas;
+    /** 画布
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/canvas.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
+    canvas: _Canvas;
   }
 }
 
 // 3.0 <= Vue <= 3.2
 declare global {
   namespace JSX {
     interface IntrinsicElements {
-      /** 画布 */
+      /** 画布
+       * ***
+       * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/canvas.html)
+       * |
+       * [使用说明](https://uni-typed.netlify.app/)
+       */
       canvas: _Canvas;
     }
   }
@@ -151,7 +161,12 @@ declare global {
 declare module "vue/jsx-runtime" {
   namespace JSX {
     interface IntrinsicElements {
-      /** 画布 */
+      /** 画布
+       * ***
+       * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/canvas.html)
+       * |
+       * [使用说明](https://uni-typed.netlify.app/)
+       */
       canvas: _Canvas;
     }
   }

diff --git a/packages/uni-app-types/src/form-components/button.ts b/packages/uni-app-types/src/form-components/button.ts
@@ -756,16 +756,26 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 按钮 */
-    Button: _Button;
+    /** 按钮
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/button.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
+    button: _Button;
   }
 }
 
 // 3.0 <= Vue <= 3.2
 declare global {
   namespace JSX {
     interface IntrinsicElements {
-      /** 按钮 */
+      /** 按钮
+       * ***
+       * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/button.html)
+       * |
+       * [使用说明](https://uni-typed.netlify.app/)
+       */
       button: _Button;
     }
   }
@@ -776,7 +786,12 @@ declare global {
 declare module "vue/jsx-runtime" {
   namespace JSX {
     interface IntrinsicElements {
-      /** 按钮 */
+      /** 按钮
+       * ***
+       * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/button.html)
+       * |
+       * [使用说明](https://uni-typed.netlify.app/)
+       */
       button: _Button;
     }
   }

diff --git a/packages/uni-app-types/src/form-components/checkbox-group.ts b/packages/uni-app-types/src/form-components/checkbox-group.ts
@@ -50,7 +50,12 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 多项选择器，内部由多个 checkbox 组成 */
+    /** 多项选择器，内部由多个 checkbox 组成
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/checkbox.html#checkbox-group)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
     CheckboxGroup: _CheckboxGroup;
   }
 }
diff --git a/packages/uni-app-types/src/form-components/checkbox.ts b/packages/uni-app-types/src/form-components/checkbox.ts
@@ -65,7 +65,12 @@ declare global {
 
 declare module "vue" {
   export interface GlobalComponents {
-    /** 多选项目 */
-    Checkbox: _Checkbox;
+    /** 多选项目
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/checkbox.html#checkbox)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
+     */
+    checkbox: _Checkbox;
   }
 }
diff --git a/packages/uni-app-types/src/form-components/editor.ts b/packages/uni-app-types/src/form-components/editor.ts
@@ -166,7 +166,11 @@ declare module "vue" {
      * 进行插入
      *
      * 图片控件仅初始化时设置有效
+     * ***
+     * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/editor.html)
+     * |
+     * [使用说明](https://uni-typed.netlify.app/)
      */
-    Editor: _Editor;
+    editor: _Editor;
   }
 }
diff --git a/packages/uni-app-types/src/form-components/form.ts b/packages/uni-app-types/src/form-components/form.ts
@@ -143,6 +143,10 @@ declare module "vue/jsx-runtime" {
        * 表单
        *
        * 将组件内的用户输入的 switch、input、checkbox、slider、radio、picker 提交
+       * ***
+       * [👉🏻点击查看组件文档](https://uniapp.dcloud.net.cn/component/form.html)
+       * |
+       * [使用说明](https://uni-typed.netlify.app/)
        */
       form: _Form;
     }