update docs

x-extends · Sep 14, 2024 · ae6f81c · ae6f81c
1 parent 6f6aed5
commit ae6f81c
Show file tree

Hide file tree

Showing 5 changed files with 108 additions and 14 deletions.
diff --git a/README.en.md b/README.en.md
@@ -1,6 +1,6 @@
 # vxe-pc-ui
 
-[简体中文](README.md) | [繁體中文](README.zh-TW.md) | English  
+[简体中文](README.md) | [繁體中文](README.zh-TW.md) | English | [日本語](README.ja-JP.md)  
 
 [![star](https://gitee.com/xuliangzhan_admin/vxe-pc-ui/badge/star.svg?theme=gvp)](https://gitee.com/xuliangzhan_admin/vxe-pc-ui/stargazers)
 [![npm version](https://img.shields.io/npm/v/vxe-pc-ui.svg?style=flat-square)](https://www.npmjs.com/package/vxe-pc-ui)
@@ -20,6 +20,11 @@ A [vue](https://www.npmjs.com/package/vue) based PC component library.
 --- | --- | --- | --- | --- |
 80+ ✔ | 80+ ✔ | 90+ ✔ | 75+ ✔ | 10+ ✔ |
 
+## Online Documents
+
+👉 [UI Document](https://vxeui.com)  
+👉 [Table Document](https://vxetable.cn)  
+
 ## Use
 
 ```shell

diff --git a/README.ja-JP.md b/README.ja-JP.md
@@ -0,0 +1,71 @@
+# vxe-pc-ui
+
+[简体中文](README.md) | [繁體中文](README.zh-TW.md) | [English](README.en.md) | 日本語  
+
+[![star](https://gitee.com/xuliangzhan/vxe-table/badge/star.svg?theme=gvp)](https://gitee.com/xuliangzhan/vxe-table/stargazers)
+[![npm version](https://img.shields.io/npm/v/vxe-table.svg?style=flat-square)](https://www.npmjs.com/package/vxe-table)
+[![NodeJS with Webpack](https://github.com/x-extends/vxe-table/actions/workflows/webpack.yml/badge.svg)](https://github.com/x-extends/vxe-table/actions/workflows/webpack.yml)
+[![npm downloads](https://img.shields.io/npm/dt/vxe-table.svg?style=flat-square)](https://npm-stat.com/charts.html?package=vxe-table)
+[![issues](https://img.shields.io/github/issues/x-extends/vxe-table.svg)](https://github.com/x-extends/vxe-table/issues)
+[![issues closed](https://img.shields.io/github/issues-closed/x-extends/vxe-table.svg)](https://github.com/x-extends/vxe-table/issues?q=is%3Aissue+is%3Aclosed)
+[![pull requests](https://img.shields.io/github/issues-pr/x-extends/vxe-table.svg)](https://github.com/x-extends/vxe-table/pulls)
+[![pull requests closed](https://img.shields.io/github/issues-pr-closed/x-extends/vxe-table.svg)](https://github.com/x-extends/vxe-table/pulls?q=is%3Apr+is%3Aclosed)
+[![npm license](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE)
+
+[vue](https://www.npmjs.com/package/vue)ベースのPCコンポーネントライブラリ。
+
+## ブラウザサポート
+
+![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/src/safari/safari_48x48.png)
+--- | --- | --- | --- | --- |
+80+ ✔ | 80+ ✔ | 90+ ✔ | 75+ ✔ | 10+ ✔ |
+
+## オンラインドキュメント
+
+👉 [UIドキュメント](https://vxeui.com)  
+👉 [テーブルドキュメント](https://vxetable.cn)  
+
+### テーブルとUIの使用
+
+```shell
+npm install vxe-pc-ui
+```
+
+```javascript
+// ...
+import VxeUI from 'vxe-pc-ui'
+import 'vxe-pc-ui/lib/style.css'
+// ...
+
+createApp(App).use(VxeUI).mount('#app')
+```
+
+## プロジェクトの実行
+
+依存関係をインストールする
+
+```shell
+npm install
+```
+
+ローカルデバッグを開始する
+
+```shell
+npm run serve
+```
+
+コンパイルパッケージング、生成されたコンパイルディレクトリ: es,lib
+
+```shell
+npm run lib
+```
+
+## 貢献者
+
+Thank you to everyone who contributed to this project.
+
+[![vxe-pc-ui](https://contrib.rocks/image?repo=x-extends/vxe-pc-ui)](https://github.com/x-extends/vxe-pc-ui/graphs/contributors)
+
+## ライセンス
+
+[MIT](LICENSE) © 2019-present, Xu Liangzhan
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # vxe-pc-ui
 
-简体中文 | [繁體中文](README.zh-TW.md) | [English](README.en.md)  
+简体中文 | [繁體中文](README.zh-TW.md) | [English](README.en.md) | [日本語](README.ja-JP.md)  
 
 [![star](https://gitee.com/xuliangzhan_admin/vxe-pc-ui/badge/star.svg?theme=gvp)](https://gitee.com/xuliangzhan_admin/vxe-pc-ui/stargazers)
 [![npm version](https://img.shields.io/npm/v/vxe-pc-ui.svg?style=flat-square)](https://www.npmjs.com/package/vxe-pc-ui)
@@ -98,6 +98,11 @@
 * [x] toolbar 表格-工具栏
 * [x] grid 表格-配置式
 
+## 在线文档
+
+👉 [组件文档](https://vxeui.com)  
+👉 [表格文档](https://vxetable.cn)  
+
 ## 安装
 
 ```shell
@@ -221,17 +226,17 @@ npm run serve
 npm run lib
 ```
 
-## PR
+## 贡献源码步骤
 
 1. 如果是修复 bug，必须有示例的复现链接
 2. 如果新功能，涉及代码风格、质量、还需有对应的示例页面
 
-## Contributors
+## 贡献者
 
 Thank you to everyone who contributed to this project.
 
 [![vxe-pc-ui](https://contrib.rocks/image?repo=x-extends/vxe-pc-ui)](https://github.com/x-extends/vxe-pc-ui/graphs/contributors)
 
-## License
+## 许可证
 
 [MIT](LICENSE) © 2019-present, Xu Liangzhan
diff --git a/README.zh-TW.md b/README.zh-TW.md
@@ -1,6 +1,6 @@
 # vxe-pc-ui
 
-[简体中文](README.md) | 繁體中文 | [English](README.en.md)  
+[简体中文](README.md) | 繁體中文 | [English](README.en.md) | [日本語](README.ja-JP.md)  
 
 [![star](https://gitee.com/xuliangzhan_admin/vxe-pc-ui/badge/star.svg?theme=gvp)](https://gitee.com/xuliangzhan_admin/vxe-pc-ui/stargazers)
 [![npm version](https://img.shields.io/npm/v/vxe-pc-ui.svg?style=flat-square)](https://www.npmjs.com/package/vxe-pc-ui)
@@ -20,6 +20,11 @@
 --- | --- | --- | --- | --- |
 80+ ✔ | 80+ ✔ | 90+ ✔ | 75+ ✔ | 10+ ✔ |
 
+## 線上檔案
+
+👉 [組件文檔](https://vxeui.com)  
+👉 [表格文檔](https://vxetable.cn)  
+
 ## 使用
 
 ```shell
@@ -55,12 +60,12 @@ npm run serve
 npm run lib
 ```
 
-## Contributors
+## 貢獻者
 
 Thank you to everyone who contributed to this project.
 
 [![vxe-pc-ui](https://contrib.rocks/image?repo=x-extends/vxe-pc-ui)](https://github.com/x-extends/vxe-pc-ui/graphs/contributors)
 
-## License
+## 許可證
 
 [MIT](LICENSE) © 2019-present, Xu Liangzhan
diff --git a/types/components/table.d.ts b/types/components/table.d.ts
@@ -3503,14 +3503,19 @@ export namespace VxeTableDefines {
     level: number
 
     /**
+     * 已废弃
      * @deprecated
+     * @private
      */
     visibleData: D[]
     /**
+     * 已废弃
      * @deprecated
+     * @private
      */
     data: D[]
     /**
+     * 已废弃
      * @deprecated
      */
     items: any[]
@@ -3533,10 +3538,13 @@ export namespace VxeTableDefines {
     fixed: VxeColumnPropTypes.Fixed
     type: string
 
-     /**
+    /**
+     * 已废弃
      * @deprecated
+     * @private
      */
     data: any[][]
+
     // 兼容旧
     itemIndex: number
     items: any[]
@@ -3603,17 +3611,17 @@ export namespace VxeTableDefines {
   export interface CheckboxChangeParams<D = any> extends TableBaseCellParams<D> {
     checked: boolean
     /**
-     * 请调用方法 getCheckboxRecords() 获取
+     * 已废弃，请调用方法 getCheckboxRecords() 获取
      * @deprecated
      */
     records: D[]
     /**
-     * 请调用方法 getCheckboxReserveRecords() 获取
+     * 已废弃，请调用方法 getCheckboxReserveRecords() 获取
      * @deprecated
      */
     reserves: D[]
     /**
-     * 请调用方法 getCheckboxIndeterminateRecords() 获取
+     * 已废弃，请调用方法 getCheckboxIndeterminateRecords() 获取
      * @deprecated
      */
     indeterminates: D[]
@@ -3625,12 +3633,12 @@ export namespace VxeTableDefines {
 
   export interface CheckboxRangeStartParams<D = any> {
     /**
-     * 请调用方法 getCheckboxRecords() 获取
+     * 已废弃，请调用方法 getCheckboxRecords() 获取
      * @deprecated
      */
     records: D[]
     /**
-     * 请调用方法 getCheckboxReserveRecords() 获取
+     * 已废弃，请调用方法 getCheckboxReserveRecords() 获取
      * @deprecated
      */
     reserves: D[]