Merge branch 'dev' of github.com:opentiny/tiny-vue into dev

Author: Davont

.github/workflows/auto-deploy-site.yml

@@ -0,0 +1,57 @@
+name: Auto Deploy Site
+
+on:
+  push:
+    branches: [dev]
+    paths:
+      - 'examples/sites/**'
+      - '!examples/sites/**/*.spec.ts'
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 9
+      - name: Install deps
+        run: pnpm -F @opentiny/vue-docs i --ignore-scripts --no-frozen-lockfile
+      - name: Build site
+        run: pnpm -F @opentiny/vue-docs build
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./examples/sites/dist
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

commitlint.config.js

@@ -1 +1,6 @@
-module.exports = { extends: ['@commitlint/config-conventional'] }
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'header-max-length': [1, 'always', 150]
+  }
+}

examples/blocks/package.json

@@ -16,7 +16,7 @@
     "@opentiny/unplugin-tiny-vue": "~0.0.2",
     "@vitejs/plugin-vue": "^4.5.2",
     "typescript": "^5.2.2",
-    "vite": "^5.0.8",
+    "vite": "catalog:",
     "vue-tsc": "^1.8.25"
   }
 }

examples/openinula-docs/package.json

@@ -22,8 +22,8 @@
     "eslint": "^8.44.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "postcss": "^8.4.16",
-    "typescript": "^5.0.2",
-    "vite": "^4.3.8",
+    "typescript": "catalog:",
+    "vite": "catalog:",
     "vite-plugin-svgr": "^3.2.0"
   }
 }

examples/react-docs/package.json

@@ -25,8 +25,8 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "postcss": "^8.4.16",
     "tailwindcss": "^3.3.3",
-    "typescript": "^5.0.2",
-    "vite": "^4.3.8",
+    "typescript": "catalog:",
+    "vite": "catalog:",
     "vite-plugin-react": "^4.0.1",
     "vite-plugin-svgr": "^3.2.0"
   }

examples/react-site/package.json

@@ -59,7 +59,7 @@
     "unplugin-auto-import": "0.8.7",
     "unplugin-vue-components": "^0.19.9",
     "uslug": "^1.0.4",
-    "vite": "^4.3.8",
+    "vite": "catalog:",
     "vite-plugin-html": "^2.0.0",
     "vite-plugin-inspect": "^0.5.0",
     "vite-plugin-md": "0.13.1"

examples/sites/demos/.eslintrc.js

@@ -3,6 +3,7 @@
 /** @type {import('eslint').Linter.Config} */
 module.exports = {
   rules: {
-    'no-console': 'off'
+    'no-console': 'off',
+    'vue/no-unused-vars': 'off'
   }
 }

examples/sites/demos/apis/bulletin-board.js

@@ -18,11 +18,12 @@ export default {
         },
         {
           name: 'data',
-          type: 'Array',
+          typeAnchorName: 'BulletinBoardData',
+          type: 'BulletinBoardData[]',
           defaultValue: '',
           desc: {
-            'zh-CN': 'tab-item 数据;tab-item 数据',
-            'en-US': 'tab-item data; tab-item data'
+            'zh-CN': 'tab-item 数据;',
+            'en-US': 'tab-item data;'
           },
           mode: ['pc'],
           pcDemo: 'base'
@@ -87,9 +88,38 @@ export default {
           pcDemo: 'title'
         }
       ],
-      events: [],
+      events: [
+        {
+          name: 'contentClick',
+          type: '(event: BulletinBoardData) => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '当公告牌内容被点击时触发的回调函数',
+            'en-US': 'The callback function triggered when the content of the bulletin board is clicked'
+          },
+          mode: ['pc'],
+          pcDemo: 'events',
+          meta: {
+            stable: '3.20.0'
+          }
+        }
+      ],
       methods: [],
       slots: []
     }
+  ],
+  types: [
+    {
+      name: 'BulletinBoardData',
+      type: 'interface',
+      code: `
+            interface BulletinBoardData {
+              text: string // 显示文本
+              date: string // 日期
+              url: string // 需要跳转的地址
+              target: string // <a> 标签的一个属性，该属性指定在何处显示链接的资源
+              }
+            `
+    }
   ]
 }

examples/sites/demos/apis/calendar-view.js

@@ -43,7 +43,7 @@ export default {
         },
         {
           name: 'height',
-          type: 'string',
+          type: 'string | number',
           defaultValue: '',
           desc: {
             'zh-CN': '日历高度',