docs: update docs

novlan1 · Jul 8, 2024 · 1b38038 · 1b38038
1 parent 57479e7
commit 1b38038
Show file tree

Hide file tree

Showing 68 changed files with 127 additions and 102 deletions.
diff --git a/packages/press-ui/docs/.vuepress/components/debug-online.vue b/packages/press-ui/docs/.vuepress/components/debug-online.vue
@@ -13,14 +13,12 @@
       Vue3
     </button>
     <button
-      v-if="false"
       class="press-button press-button--default press-button--small"
       @click.stop="clickVue2Pure"
     >
       Vue2 非 uni-app
     </button>
     <button
-      v-if="false"
       class="press-button press-button--default press-button--small"
       @click.stop="clickVue3Pure"
     >
@@ -32,6 +30,8 @@
 const STACKBLITZ_MAP = {
   VUE3: 'https://stackblitz.com/~/github.com/novlan1/press-ui-demo-vue3?file=src/',
   VUE2: 'https://stackblitz.com/~/github.com/novlan1/press-ui-demo-vue2?file=src/',
+  VUE2_PURE: 'https://stackblitz.com/~/github.com/novlan1/press-ui-demo-vue2-pure?file=src/',
+  VUE3_PURE: 'https://stackblitz.com/~/github.com/novlan1/press-ui-demo-vue3-pure?file=src/',
 };
 
 export default {
@@ -56,10 +56,10 @@ export default {
       window.open(`${STACKBLITZ_MAP.VUE2}${this.currentComponent}.vue`);
     },
     clickVue2Pure() {
-
+      window.open(`${STACKBLITZ_MAP.VUE2_PURE}${this.currentComponent}.vue`);
     },
     clickVue3Pure() {
-
+      window.open(`${STACKBLITZ_MAP.VUE3_PURE}${this.currentComponent}.vue`);
     },
   },
 

diff --git a/packages/press-ui/script/component-config/generate-entry.js b/packages/press-ui/script/component-config/generate-entry.js
@@ -29,7 +29,6 @@ export default {
   ...components,
 };
 export * from './packages/common/public/public';
-
 `;
 const CSS_BASE = `@import "./packages/common/style/press/index.scss";
 @import "./packages/common/style/press/var.scss";

diff --git a/packages/press-ui/src/index.js b/packages/press-ui/src/index.js
@@ -214,4 +214,3 @@ export default {
   ...components,
 };
 export * from './packages/common/public/public';
-
diff --git a/packages/press-ui/src/packages/common/im/helper/tim.d.ts b/packages/press-ui/src/packages/common/im/helper/tim.d.ts
@@ -1,4 +1,5 @@
 import TIM_WEB from 'tim-js-sdk';
+// eslint-disable-next-line @typescript-eslint/naming-convention
 export type TIM_TYPE = typeof TIM_WEB;
 /**
  * @type {TIM_TYPE}

diff --git a/packages/press-ui/src/packages/common/im/im.d.ts b/packages/press-ui/src/packages/common/im/im.d.ts
@@ -2,6 +2,7 @@ import type { IChatSDK, EventCallback } from './types';
 import type TIM_TYPE from 'tim-js-sdk/tim-js';
 export declare class IM {
   tim: IChatSDK;
+  // eslint-disable-next-line @typescript-eslint/naming-convention
   TIM: typeof TIM_TYPE;
   constructor({ appId, logLevel }: {
     appId: number;

diff --git a/packages/press-ui/src/packages/common/public/public.js b/packages/press-ui/src/packages/common/public/public.js
@@ -1,10 +1,10 @@
 export { timeStampFormat } from '../format/time';
-export { showFunctionalComponent, selectComponent } from '../functional-component'
+export { showFunctionalComponent, selectComponent } from '../functional-component';
 export { setData } from '../component-handler/set-data';
-export { initH5Instance } from '../component-handler/h5-handler'
+export { initH5Instance } from '../component-handler/h5-handler';
 
 export { saveMpImage } from '../utils/save-mp-image';
-export { isNotInUni } from '../utils/utils'
+export { isNotInUni } from '../utils/utils';
 
 export { forceUpdate } from '../vue3/adapter';
 export { getWindowWidth } from '../dom/rect';

diff --git a/packages/press-ui/src/packages/press-action-sheet/README.md b/packages/press-ui/src/packages/press-action-sheet/README.md
@@ -216,9 +216,6 @@ export default {
 | appParameter     | 打开 APP 时，向 APP 传递的参数，openType=launchApp 时有效                                                                                                     | _string_  | -            |
 
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
 

diff --git a/packages/press-ui/src/packages/press-avatar/README.md b/packages/press-ui/src/packages/press-avatar/README.md
@@ -177,3 +177,7 @@ export default {
 | 事件名   | 说明         | 参数 |
 | -------- | ------------ | ---- |
 | showMore | 点击展示更多 | -    |
+
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-badge/README.md b/packages/press-ui/src/packages/press-badge/README.md
@@ -141,3 +141,6 @@ export default {
 | default | 徽标包裹的子元素 |
 | content | 自定义徽标内容   |
 
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-barcode/README.md b/packages/press-ui/src/packages/press-barcode/README.md
@@ -95,4 +95,8 @@ const DEFAULT_OPTIONS = {
   marginLeft: undefined, // 设置条形码周围的左边距
   marginRight: undefined, // 设置条形码周围的右边距
 };
-```
+```
+
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-button/README.md b/packages/press-ui/src/packages/press-button/README.md
@@ -232,9 +232,6 @@ export default {
 - e-sport-border
 
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
 

diff --git a/packages/press-ui/src/packages/press-calendar/README.md b/packages/press-ui/src/packages/press-calendar/README.md
@@ -360,3 +360,7 @@ export default {
 | 方法名 | 说明                   | 参数 | 返回值 |
 | ------ | ---------------------- | ---- | ------ |
 | reset  | 重置选中的日期到默认值 | -    | -      |
+
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-card/README.md b/packages/press-ui/src/packages/press-card/README.md
@@ -260,4 +260,6 @@ export default {
 | cover | 卡片头部 |
 | title | 操作栏   |
 
+## 在线调试
 
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-cell/README.md b/packages/press-ui/src/packages/press-cell/README.md
@@ -231,9 +231,6 @@ export default {
 | icon       | 自定义`icon`显示内容，如果设置了`icon`属性则不生效             |
 | right-icon | 自定义右侧按钮，默认是`arrow`，如果设置了`is-link`属性则不生效 |
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
 

diff --git a/packages/press-ui/src/packages/press-checkbox/README.md b/packages/press-ui/src/packages/press-checkbox/README.md
@@ -178,9 +178,6 @@ export default {
 | ------ | ---- | ------ | ------------ |
 | toggle | -    | -      | 切换选中状态 |
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
 

diff --git a/packages/press-ui/src/packages/press-circle/README.md b/packages/press-ui/src/packages/press-circle/README.md
@@ -115,9 +115,6 @@ Page({
 | ---- | ---------------------------------------------------------- |
 | -    | 自定义文字内容，如果设置了`fill`，插槽内容会被原生组件覆盖 |
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
 

diff --git a/packages/press-ui/src/packages/press-code-input/README.md b/packages/press-ui/src/packages/press-code-input/README.md
@@ -160,3 +160,7 @@ export default {
 | change | 输入内容发生改变时触发              | `value` |
 | input  | 输入内容发生改变时触发              | `value` |
 | finish | 输入字符个数达到`maxlength`值时触发 | `value` |
+
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-collapse/README.md b/packages/press-ui/src/packages/press-collapse/README.md
@@ -213,9 +213,6 @@ export default {
 | title      | 自定义`title`                 |
 | right-icon | 自定义右侧按钮，默认是`arrow` |
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
 

diff --git a/packages/press-ui/src/packages/press-count-down/README.md b/packages/press-ui/src/packages/press-count-down/README.md
@@ -179,6 +179,10 @@ export default {
 | pause  | -    | -      | 暂停倒计时                                                 |
 | reset  | -    | -      | 重设倒计时，若`auto-start`为`true`，重设后会自动开始倒计时 |
 
+## 在线调试
+
+<debug-online />
+
 ## 常见问题
 
 ### 多个 CountDown 组件互相影响

diff --git a/packages/press-ui/src/packages/press-count-to/README.md b/packages/press-ui/src/packages/press-count-to/README.md
@@ -199,11 +199,13 @@ export default {
 | resume  | 暂停的情况下，重新开始                         |
 | reStart | 暂定状态，重新再开始滚动；或者滚动状态下，暂停 |
 
-
-
 ### Events
 
 | 事件名 | 说明                   | 参数 |
 | ------ | ---------------------- | ---- |
 | end    | 数值滚动到目标值时触发 | -    |
 | change | 数值改变               | -    |
+
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-datetime-picker/README.md b/packages/press-ui/src/packages/press-datetime-picker/README.md
@@ -374,3 +374,7 @@ export default {
 | getValues()                    | 获取所有列中被选中的值，返回一个数组       |
 | setValues(values)              | `values`为一个数组，设置所有列中被选中的值 |
 
+## 在线调试
+
+<debug-online />
+
diff --git a/packages/press-ui/src/packages/press-dialog-plus/README.md b/packages/press-ui/src/packages/press-dialog-plus/README.md
@@ -289,3 +289,7 @@ export default {
 | 名称  | 说明                                                 |
 | ----- | ---------------------------------------------------- |
 | title | 自定义`title`显示内容，如果设置了`title`属性则不生效 |
+
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-dialog/README.md b/packages/press-ui/src/packages/press-dialog/README.md
@@ -178,3 +178,6 @@ export default {
 | field-value         | 输入框内容                                  | _string_   | -          |
 | field-placeHolder   | 输入框占位文字                              | _string_   | -          |
 
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-divider/README.md b/packages/press-ui/src/packages/press-divider/README.md
@@ -84,6 +84,6 @@ export default {
 | ---- | -------------- |
 | 默认 | 自定义文本内容 |
 
-## 主题定制
+## 在线调试
 
-<theme-config type="divider"/>
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-dropdown-menu/README.md b/packages/press-ui/src/packages/press-dropdown-menu/README.md
@@ -234,3 +234,6 @@ export default {
 | value | 标识符                                      | _number \| string_ |
 | icon  | 左侧[图标名称](./press-icon-plus)或图片链接 | _string_           |
 
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-empty/README.md b/packages/press-ui/src/packages/press-empty/README.md
@@ -106,9 +106,6 @@ Empty 组件内置了多种占位图片类型，可以在不同业务场景下
 | image       | 自定义图标     |
 | description | 自定义描述文字 |
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
 

diff --git a/packages/press-ui/src/packages/press-fab/README.md b/packages/press-ui/src/packages/press-fab/README.md
@@ -113,3 +113,7 @@ export default {
 | direction | 展开菜单显示方式。horizontal:水平显示，vertical：垂直显示 | _string_ | horizontal |
 | content   | 展开菜单内容配置项                                        | _Array_  | -          |
 | top       | 顶部高度                                                  | _number_ | -          |
+
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-field/README.md b/packages/press-ui/src/packages/press-field/README.md
@@ -247,6 +247,6 @@ export default {
 
 `value` 字段 在 Vue3 中使用的是 `model-value`。
 
-## 主题定制
+## 在线调试
 
-<theme-config type="field"/>
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-grid/README.md b/packages/press-ui/src/packages/press-grid/README.md
@@ -177,3 +177,7 @@ export default {
 | -    | 自定义宫格的所有内容，需要设置`use-slot`属性           |
 | icon | 自定义图标，如果设置了`use-slot`或者`icon`属性则不生效 |
 | text | 自定义文字，如果设置了`use-slot`或者`text`属性则不生效 |
+
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-icon/README.md b/packages/press-ui/src/packages/press-icon/README.md
@@ -98,4 +98,8 @@ export default {
 | number | 竖条个数，支持`1-5` | _number_ | `3`       |
 | color  | 图标颜色            | _string_ | `#2979ff` |
 | width  | 图标整体高度        | _string_ | `40px`    |
-| height | 图标整体宽度        | _string_ | `50px`    |
+| height | 图标整体宽度        | _string_ | `50px`    |
+
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-image-preview/README.md b/packages/press-ui/src/packages/press-image-preview/README.md
@@ -153,3 +153,6 @@ imagePreview({
 | close  | 关闭时触发     | -                |
 | change | 切换图片时触发 | active(当前索引) |
 
+## 在线调试
+
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-image-preview/index.js b/packages/press-ui/src/packages/press-image-preview/index.js
@@ -23,4 +23,4 @@ export function imagePreview(options) {
   });
 }
 
-export const imagePreviewHandler = imagePreview;
+export const imagePreviewHandler = imagePreview;
diff --git a/packages/press-ui/src/packages/press-index-bar/README.md b/packages/press-ui/src/packages/press-index-bar/README.md
@@ -112,9 +112,6 @@ export default {
 | ---- | -------------------------------- |
 | -    | 锚点位置显示内容，默认为索引字符 |
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
 

diff --git a/packages/press-ui/src/packages/press-list/README.md b/packages/press-ui/src/packages/press-list/README.md
@@ -133,6 +133,10 @@ export default {
 | loading  | 自定义底部加载中提示       |
 | finished | 自定义加载完成后的提示文案 |
 
+## 在线调试
+
+<debug-online />
+
 
 ## 常见问题
 

diff --git a/packages/press-ui/src/packages/press-loading-plus/README.md b/packages/press-ui/src/packages/press-loading-plus/README.md
@@ -76,5 +76,7 @@ export default {
 | ---- | -------- |
 | -    | 加载文案 |
 
+## 在线调试
 
+<debug-online />
 
diff --git a/packages/press-ui/src/packages/press-loading/README.md b/packages/press-ui/src/packages/press-loading/README.md
@@ -58,9 +58,9 @@ export default {
 | loading-bg     | `loading`背景色                     | _string_ | -      |
 | loading-scenes | `loading`的场景，可选项：`page/btn` | _string_ | `page` |
 
+## 在线调试
 
-
-
+<debug-online />
 
 ## 常见问题
 

diff --git a/packages/press-ui/src/packages/press-nav-bar/README.md b/packages/press-ui/src/packages/press-nav-bar/README.md
@@ -88,9 +88,6 @@ export default {
 | click-left  | 点击左侧按钮时触发 | -    |
 | click-right | 点击右侧按钮时触发 | -    |
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
 

diff --git a/packages/press-ui/src/packages/press-notice-bar/README.md b/packages/press-ui/src/packages/press-notice-bar/README.md
@@ -142,9 +142,6 @@ export default {
 | --notice-bar-icon-size        | _16px_                                            | -    |
 | --notice-bar-icon-min-width   | _24px_                                            | -    |
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
 

diff --git a/packages/press-ui/src/packages/press-notify/README.md b/packages/press-ui/src/packages/press-notify/README.md
@@ -109,10 +109,7 @@ Notify({
 | onClose          | 关闭时的回调函数                                       | _Function_ | -              |
 | safeAreaInsetTop | 是否留出顶部安全距离（状态栏高度）                     | _boolean_  | `false`        |
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
 
-<debug-online />
+<debug-online />
diff --git a/packages/press-ui/src/packages/press-overlay/README.md b/packages/press-ui/src/packages/press-overlay/README.md
@@ -142,9 +142,6 @@ export default {
 | ---- | ---------------------------------- |
 | -    | 默认插槽，用于在遮罩层上方嵌入内容 |
 
-## 主题定制
-
-<theme-config />
 
 ## 在线调试
Original file line number	Diff line number	Diff line change
Expand Up		@@ -214,4 +214,3 @@ export default {
		...components,
		};
		export * from './packages/common/public/public';
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,4 +23,4 @@ export function imagePreview(options) { @@
       });
     }
-    export const imagePreviewHandler = imagePreview;
+    export const imagePreviewHandler = imagePreview;