refactor(swipe): move to script setup (jd-opensource#2975)

8392 · Mar 18, 2024 · ac60b0d · ac60b0d
1 parent 8e1b59b
commit ac60b0d
Show file tree

Hide file tree

Showing 20 changed files with 556 additions and 513 deletions.
diff --git a/src/config.json b/src/config.json
@@ -472,13 +472,15 @@
           "name": "Swipe",
           "cName": "滑动手势",
           "desc": "列表项左滑删除场景使用",
+          "setup": true,
           "author": "richard1015"
         },
         {
           "name": "SwipeGroup",
           "cName": "滑动手势",
           "show": false,
           "desc": "Swipe 的集合，用于控制互斥",
+          "setup": true,
           "author": "eiinu"
         },
         {

diff --git a/src/packages/__VUE/addresslist/components/GeneralShell.taro.vue b/src/packages/__VUE/addresslist/components/GeneralShell.taro.vue
@@ -47,7 +47,7 @@ import { createComponent } from '@/packages/utils/create';
 const { create } = createComponent('address-list-general');
 import ItemContents from './ItemContents.taro.vue';
 import NutButton from '../../button/index.taro';
-import NutSwipe from '../../swipe/index.taro.vue';
+import NutSwipe from '../../swipe/index.taro';
 
 export default create({
   props: {

diff --git a/src/packages/__VUE/addresslist/components/GeneralShell.vue b/src/packages/__VUE/addresslist/components/GeneralShell.vue
@@ -47,7 +47,7 @@ import { createComponent } from '@/packages/utils/create';
 const { create } = createComponent('address-list-general');
 import ItemContents from './ItemContents.vue';
 import NutButton from '../../button';
-import NutSwipe from '../../swipe/index.vue';
+import NutSwipe from '../../swipe';
 
 export default create({
   props: {

diff --git a/src/packages/__VUE/swipe/__tests__/swipe.spec.tsx b/src/packages/__VUE/swipe/__tests__/swipe.spec.tsx
@@ -1,9 +1,6 @@
 import { DOMWrapper, mount } from '@vue/test-utils';
-import Swipe from '../index.vue';
-import SwipeGroup from '../../swipegroup/index.vue';
+import { Button, Cell, Swipe, SwipeGroup } from '@nutui/nutui';
 import { nextTick } from 'vue';
-import Button from '../../button';
-import Cell from '../../cell/index.vue';
 import { triggerDrag, mockGetBoundingClientRect } from '@/packages/utils/unit';
 
 test('Swipe: base swipe', () => {

diff --git a/src/packages/__VUE/swipe/doc.en-US.md b/src/packages/__VUE/swipe/doc.en-US.md
@@ -57,6 +57,7 @@ The prop `name` of Swipe is required.
 
 | Event | Description | Arguments |
 | --- | --- | --- |
+| click | click event | `name, position: 'left' \| 'content' \| 'right'` |
 | open | Emitted when Swipe is opened, swipe left/swipe right | `name, position: 'left' \| 'right' ` |
 | close | Emitted when Swipe is closed, swipe left/swipe right | `name, position: 'left' \| 'right' ` |
 
@@ -74,7 +75,6 @@ Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Swipe in
 
 | Name | Description | Arguments |
 | --- | --- | --- |
-| click | click event | `name, position: 'left' \| 'content' \| 'right'` |
 | open | open swipe, swipe left/swipe right | `name, position: 'left' \| 'right' ` |
 | close | close swipe, swipe left/swipe right | `name, position: 'left' \| 'right' ` |
 
@@ -85,3 +85,11 @@ Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Swipe in
 | Attribute | Description | Type | Default |
 | --- | --- | --- | --- |
 | lock`v4.1.1` | When a child Swipe opens, others will close. | boolean | `false` |
+
+### Types version
+
+The component exports the following type definitions:
+
+```ts
+import type { SwipePosition, SwipeProps, SwipeInstance, SwipeGroupProps, SwipeGroupInstance } from '@nutui/nutui';
+```
diff --git a/src/packages/__VUE/swipe/doc.md b/src/packages/__VUE/swipe/doc.md
@@ -57,6 +57,7 @@ app.use(Swipe);
 
 | 事件名 | 说明 | 回调参数 |
 | --- | --- | --- |
+| click | 点击事件 | `name, position: 'left' \| 'content' \| 'right'` |
 | open | 滑动时触发，left 指向左滑，right 指向右滑 | `name, position: 'left' \| 'right'` |
 | close | 关闭时触发，同上 | `name, position: 'left' \| 'right'` |
 
@@ -74,7 +75,6 @@ app.use(Swipe);
 
 | 方法名 | 说明 | 参数 |
 | --- | --- | --- |
-| click | 点击事件 | `name, position: 'left' \| 'content' \| 'right'` |
 | open | 滑动单元格侧边栏，left 指向左滑，right 指向右滑 | `name, position: 'left' \| 'right'` |
 | close | 收起单元格侧边栏，同上 | `name, position: 'left' \| 'right'` |
 
@@ -85,3 +85,11 @@ app.use(Swipe);
 | 参数 | 说明 | 类型 | 默认值 |
 | --- | --- | --- | --- |
 | lock`v4.1.1` | 控制内部 Swipe 互斥，即滑动打开某一个 Swipe 时，触发其余 Swipe 的 close 方法 | boolean | `false` |
+
+### 类型定义 version
+
+组件导出以下类型定义：
+
+```ts
+import type { SwipePosition, SwipeProps, SwipeInstance, SwipeGroupProps, SwipeGroupInstance } from '@nutui/nutui';
+```
diff --git a/src/packages/__VUE/swipe/doc.taro.md b/src/packages/__VUE/swipe/doc.taro.md
@@ -57,6 +57,7 @@ app.use(Swipe);
 
 | 事件名 | 说明 | 回调参数 |
 | --- | --- | --- |
+| click | 点击事件 | `name, position: 'left' \| 'content' \| 'right'` |
 | open | 滑动时触发，left 指向左滑，right 指向右滑 | `name, position: 'left' \| 'right'` |
 | close | 关闭时触发，同上 | `name, position: 'left' \| 'right'` |
 
@@ -74,7 +75,6 @@ app.use(Swipe);
 
 | 方法名 | 说明 | 参数 |
 | --- | --- | --- |
-| click | 点击事件 | `name, position: 'left' \| 'content' \| 'right'` |
 | open | 滑动单元格侧边栏，left 指向左滑，right 指向右滑 | `name, position: 'left' \| 'right'` |
 | close | 收起单元格侧边栏，同上 | `name, position: 'left' \| 'right'` |
 
@@ -85,3 +85,11 @@ app.use(Swipe);
 | 参数 | 说明 | 类型 | 默认值 |
 | --- | --- | --- | --- |
 | lock`v4.1.1` | 控制内部 Swipe 互斥，即滑动打开某一个 Swipe 时，触发其余 Swipe 的 close 方法 | boolean | `false` |
+
+### 类型定义 version
+
+组件导出以下类型定义：
+
+```ts
+import type { SwipePosition, SwipeProps, SwipeInstance, SwipeGroupProps, SwipeGroupInstance } from '@nutui/nutui-taro';
+```
diff --git a/src/packages/__VUE/swipe/index.taro.ts b/src/packages/__VUE/swipe/index.taro.ts
@@ -0,0 +1,13 @@
+import Swipe from './swipe.taro.vue';
+import type { ComponentPublicInstance } from 'vue';
+import { withInstall } from '@/packages/utils';
+
+withInstall(Swipe);
+
+export type { SwipeProps } from './swipe.taro.vue';
+
+export type { SwipePosition } from './types';
+
+export type SwipeInstance = ComponentPublicInstance & InstanceType<typeof Swipe>;
+
+export { Swipe, Swipe as default };
diff --git a/src/packages/__VUE/swipe/index.taro.vue b/src/packages/__VUE/swipe/index.taro.vue
diff --git a/src/packages/__VUE/swipe/index.ts b/src/packages/__VUE/swipe/index.ts
@@ -0,0 +1,13 @@
+import Swipe from './swipe.vue';
+import type { ComponentPublicInstance } from 'vue';
+import { withInstall } from '@/packages/utils';
+
+withInstall(Swipe);
+
+export type { SwipeProps } from './swipe.vue';
+
+export type { SwipePosition } from './types';
+
+export type SwipeInstance = ComponentPublicInstance & InstanceType<typeof Swipe>;
+
+export { Swipe, Swipe as default };