@fox-js/phone-skills 4.0.1-0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/README.md +30 -0
  2. package/foxui/SKILL.md +442 -0
  3. package/foxui/references/fox-action-sheet/doc.md +74 -0
  4. package/foxui/references/fox-actionsheet-item/doc.md +499 -0
  5. package/foxui/references/fox-animate/doc.md +66 -0
  6. package/foxui/references/fox-audio/doc.md +76 -0
  7. package/foxui/references/fox-avatar/doc.md +70 -0
  8. package/foxui/references/fox-back-top/doc.md +69 -0
  9. package/foxui/references/fox-badge/doc.md +72 -0
  10. package/foxui/references/fox-barrage/doc.md +116 -0
  11. package/foxui/references/fox-button/doc.md +203 -0
  12. package/foxui/references/fox-calendar/doc.md +346 -0
  13. package/foxui/references/fox-calendar-item/doc.md +331 -0
  14. package/foxui/references/fox-cascader/doc.md +78 -0
  15. package/foxui/references/fox-cascader-item/doc.md +710 -0
  16. package/foxui/references/fox-cell/doc.md +74 -0
  17. package/foxui/references/fox-checkbox-item/doc.md +387 -0
  18. package/foxui/references/fox-circle-progress/doc.md +65 -0
  19. package/foxui/references/fox-collapse/doc.md +71 -0
  20. package/foxui/references/fox-count-down/doc.md +78 -0
  21. package/foxui/references/fox-count-up/doc.md +178 -0
  22. package/foxui/references/fox-date-item/doc.md +437 -0
  23. package/foxui/references/fox-date-picker/doc.md +438 -0
  24. package/foxui/references/fox-dialog/doc.md +242 -0
  25. package/foxui/references/fox-divider/doc.md +149 -0
  26. package/foxui/references/fox-domain-provider/doc.md +93 -0
  27. package/foxui/references/fox-drag/doc.md +64 -0
  28. package/foxui/references/fox-dropdown/doc.md +138 -0
  29. package/foxui/references/fox-elevator/doc.md +66 -0
  30. package/foxui/references/fox-ellipsis/doc.md +69 -0
  31. package/foxui/references/fox-empty/doc.md +67 -0
  32. package/foxui/references/fox-fixed-nav/doc.md +72 -0
  33. package/foxui/references/fox-floating-button/doc.md +142 -0
  34. package/foxui/references/fox-grid/doc.md +69 -0
  35. package/foxui/references/fox-group/doc.md +295 -0
  36. package/foxui/references/fox-icon/doc.md +65 -0
  37. package/foxui/references/fox-image/doc.md +75 -0
  38. package/foxui/references/fox-image-preview/doc.md +79 -0
  39. package/foxui/references/fox-indicator/doc.md +70 -0
  40. package/foxui/references/fox-infinite-loading/doc.md +74 -0
  41. package/foxui/references/fox-input-item/doc.md +210 -0
  42. package/foxui/references/fox-input-number/doc.md +199 -0
  43. package/foxui/references/fox-input-number-item/doc.md +213 -0
  44. package/foxui/references/fox-item/doc.md +207 -0
  45. package/foxui/references/fox-layout/doc.md +273 -0
  46. package/foxui/references/fox-link-item/doc.md +158 -0
  47. package/foxui/references/fox-list/doc.md +71 -0
  48. package/foxui/references/fox-mapping/doc.md +251 -0
  49. package/foxui/references/fox-menu/doc.md +425 -0
  50. package/foxui/references/fox-message-box/doc.md +200 -0
  51. package/foxui/references/fox-money-item/doc.md +174 -0
  52. package/foxui/references/fox-more-button/doc.md +208 -0
  53. package/foxui/references/fox-navbar/doc.md +75 -0
  54. package/foxui/references/fox-notice-bar/doc.md +71 -0
  55. package/foxui/references/fox-notify/doc.md +72 -0
  56. package/foxui/references/fox-number-keyboard/doc.md +77 -0
  57. package/foxui/references/fox-over-lay/doc.md +70 -0
  58. package/foxui/references/fox-page/doc.md +76 -0
  59. package/foxui/references/fox-pagination/doc.md +73 -0
  60. package/foxui/references/fox-picker/doc.md +668 -0
  61. package/foxui/references/fox-picker-item/doc.md +389 -0
  62. package/foxui/references/fox-popover/doc.md +70 -0
  63. package/foxui/references/fox-popover-dialog/doc.md +113 -0
  64. package/foxui/references/fox-popup/doc.md +88 -0
  65. package/foxui/references/fox-price/doc.md +67 -0
  66. package/foxui/references/fox-progress/doc.md +74 -0
  67. package/foxui/references/fox-pull-refresh/doc.md +77 -0
  68. package/foxui/references/fox-radio-item/doc.md +384 -0
  69. package/foxui/references/fox-range/doc.md +65 -0
  70. package/foxui/references/fox-rate/doc.md +141 -0
  71. package/foxui/references/fox-rate-item/doc.md +137 -0
  72. package/foxui/references/fox-rolling-provider/doc.md +87 -0
  73. package/foxui/references/fox-search-bar/doc.md +91 -0
  74. package/foxui/references/fox-short-password/doc.md +78 -0
  75. package/foxui/references/fox-side-nav-bar/doc.md +68 -0
  76. package/foxui/references/fox-signature/doc.md +202 -0
  77. package/foxui/references/fox-skeleton/doc.md +73 -0
  78. package/foxui/references/fox-steps/doc.md +162 -0
  79. package/foxui/references/fox-steps-bar/doc.md +610 -0
  80. package/foxui/references/fox-sticky/doc.md +68 -0
  81. package/foxui/references/fox-swipe/doc.md +176 -0
  82. package/foxui/references/fox-swiper/doc.md +254 -0
  83. package/foxui/references/fox-switch/doc.md +162 -0
  84. package/foxui/references/fox-switch-item/doc.md +190 -0
  85. package/foxui/references/fox-tabbar/doc.md +63 -0
  86. package/foxui/references/fox-table/doc.md +640 -0
  87. package/foxui/references/fox-tabs/doc.md +67 -0
  88. package/foxui/references/fox-tabs-bar/doc.md +533 -0
  89. package/foxui/references/fox-tag/doc.md +213 -0
  90. package/foxui/references/fox-text/doc.md +84 -0
  91. package/foxui/references/fox-textarea-item/doc.md +106 -0
  92. package/foxui/references/fox-toast/doc.md +149 -0
  93. package/foxui/references/fox-tour/doc.md +89 -0
  94. package/foxui/references/fox-trend-arrow/doc.md +72 -0
  95. package/foxui/references/fox-uploader/doc.md +96 -0
  96. package/foxui/references/fox-video/doc.md +245 -0
  97. package/foxui/references/fox-water-mark/doc.md +81 -0
  98. package/package.json +21 -0
@@ -0,0 +1,71 @@
1
+ <!--
2
+ * @Author: 江成
3
+ * @Date: 2026-04-27 00:37:28
4
+ * @LastEditors: 江成
5
+ * @LastEditTime: 2026-05-12 22:33:21
6
+ -->
7
+ ---
8
+ title: NoticeBar 组件使用规范
9
+ impact: HIGH
10
+ type: capability
11
+ description: 用于循环播放展示一组消息通知
12
+ tags: [foxui, fox-notice-bar, FoxNoticeBar]
13
+ version: "4.0.0"
14
+ author: jiangcheng
15
+ related: ["fox-js","fox-noticebar"]
16
+ ---
17
+
18
+ # NoticeBar 组件使用规范
19
+
20
+ ## 1. 核心职责 (Core Responsibility)
21
+ NoticeBar 是 foxui 中用于 **用于循环播放展示一组消息通知** 的标准组件。
22
+ - **基于**: NutUI `nut-notice-bar` 进行了二次封装 (若为纯自研组件则填 "自定义开发")
23
+ - **核心增强**: 基于 NutUI 组件二次封装、适配 H5 与小程序多端、支持插槽扩展自定义内容、支持主题定制
24
+ - **适用场景**: 用于循环播放展示一组消息通知
25
+
26
+ > 💡 **关键原则**: 在所有 用于循环播放展示一组消息通知 中,**必须**优先使用此组件,禁止直接使用原生 NutUI 组件。
27
+
28
+ ---
29
+
30
+ ## 2. 关键 API 说明 (Key API)
31
+
32
+ ### 2.1 Props 属性
33
+
34
+ | 属性名 | 类型 | 必填 | 默认值 | 说明 |
35
+ | :--- | :--- | :---: | :---: | :--- |
36
+ | `list` | 纵向滚动数据列表 | Array | |
37
+ | `speed` | 滚动的速度 | Number | 50 |
38
+ | `stand-time` | 停留时间毫秒 | Number | 1000 |
39
+ | `complex-am` | 稍复杂的动画,耗能会高 | Boolean | false |
40
+ | `height` | 每一个滚动列的高度px,注意:在使用 slot 插槽定义滚动单元时,按照实际高度修改此值 | Number | 40 |
41
+ | `close-mode` | 是否启用右侧关闭图标,可以通过slotname=rightIcon自定义图标 | Boolean | false |
42
+ | `wrapable` | 是否开启文本换行 | Boolean | false |
43
+
44
+ ### 2.2 Events 事件
45
+
46
+ | 事件名 | 类型 | 说明 |
47
+ | :--- | :--- | :--- |
48
+ | `click` | 外层点击事件回调 | event: Event |
49
+ | `close` | 关闭通知栏时触发 | event: Event |
50
+ | `across-end` | 横向滚动结束时触发 | event: Event |
51
+
52
+ ### 2.3 Methods 方法
53
+
54
+ | 方法名 | 参数 | 说明 |
55
+ | :--- | :--- | :--- |
56
+
57
+
58
+ ### 2.4 Slots 插槽
59
+
60
+ | 插槽名 | 说明 |
61
+ | :--- | :--- |
62
+
63
+
64
+ ## 3. 例子 (Examples)
65
+
66
+
67
+
68
+ ## 4. 相关组件 (Related Components)
69
+ - **fox-js**: 与 NoticeBar 配合使用的相关组件
70
+ - **fox-noticebar**: 与 NoticeBar 配合使用的相关组件
71
+
@@ -0,0 +1,72 @@
1
+ <!--
2
+ * @Author: 江成
3
+ * @Date: 2026-04-27 00:37:28
4
+ * @LastEditors: 江成
5
+ * @LastEditTime: 2026-05-12 22:33:21
6
+ -->
7
+ ---
8
+ title: Notify 组件使用规范
9
+ impact: HIGH
10
+ type: capability
11
+ description: 在页面顶部展示消息提示,支持函数调用和组件调用两种方式
12
+ tags: [foxui, fox-notify, FoxNotify]
13
+ version: "4.0.0"
14
+ author: jiangcheng
15
+ related: ["fox-js","fox-cell","fox-cell-group"]
16
+ ---
17
+
18
+ # Notify 组件使用规范
19
+
20
+ ## 1. 核心职责 (Core Responsibility)
21
+ Notify 是 foxui 中用于 **在页面顶部展示消息提示,支持函数调用和组件调用两种方式** 的标准组件。
22
+ - **基于**: NutUI `nut-notify` 进行了二次封装 (若为纯自研组件则填 "自定义开发")
23
+ - **核心增强**: 基于 NutUI 组件二次封装、支持 v-model 双向绑定、支持主题定制
24
+ - **适用场景**: 在页面顶部展示消息提示,支持函数调用和组件调用两种方式
25
+
26
+ > 💡 **关键原则**: 在所有 在页面顶部展示消息提示,支持函数调用和组件调用两种方式 中,**必须**优先使用此组件,禁止直接使用原生 NutUI 组件。
27
+
28
+ ---
29
+
30
+ ## 2. 关键 API 说明 (Key API)
31
+
32
+ ### 2.1 Props 属性
33
+
34
+ | 属性名 | 类型 | 必填 | 默认值 | 说明 |
35
+ | :--- | :--- | :---: | :---: | :--- |
36
+ | `type` | 提示的信息类型,可选值为primary、success、danger、warning | string | danger |
37
+ | `visible` | 显示与否 | boolean | false |
38
+ | `msg` | 展示文案,支持通过\n换行 | string | '' |
39
+ | `duration` | 展示时长ms,值为 0 时,notify 不会消失 | number | 3000 |
40
+ | `color` | 字体颜色 | string | '' |
41
+ | `background` | 背景样式 | string | '' |
42
+ | `class-name` | 自定义类名 | string \ | number |
43
+ | `position` | 自定义位置,可选值为 top bottom left right center | string | top |
44
+
45
+ ### 2.2 Events 事件
46
+
47
+ | 事件名 | 类型 | 说明 |
48
+ | :--- | :--- | :--- |
49
+ | `click` | 点击事件回调 | - |
50
+ | `closed` | 关闭事件回调 | - |
51
+
52
+ ### 2.3 Methods 方法
53
+
54
+ | 方法名 | 参数 | 说明 |
55
+ | :--- | :--- | :--- |
56
+
57
+
58
+ ### 2.4 Slots 插槽
59
+
60
+ | 插槽名 | 说明 |
61
+ | :--- | :--- |
62
+
63
+
64
+ ## 3. 例子 (Examples)
65
+
66
+
67
+
68
+ ## 4. 相关组件 (Related Components)
69
+ - **fox-js**: 与 Notify 配合使用的相关组件
70
+ - **fox-cell**: 与 Notify 配合使用的相关组件
71
+ - **fox-cell-group**: 与 Notify 配合使用的相关组件
72
+
@@ -0,0 +1,77 @@
1
+ <!--
2
+ * @Author: 江成
3
+ * @Date: 2026-04-27 00:37:28
4
+ * @LastEditors: 江成
5
+ * @LastEditTime: 2026-05-12 22:33:21
6
+ -->
7
+ ---
8
+ title: NumberKeyboard 组件使用规范
9
+ impact: HIGH
10
+ type: capability
11
+ description: 虚拟数字键盘
12
+ tags: [foxui, fox-number-keyboard, FoxNumberKeyboard]
13
+ version: "4.0.0"
14
+ author: jiangcheng
15
+ related: ["fox-js","fox-group","fox-row-item","fox-button","fox-input-item"]
16
+ ---
17
+
18
+ # NumberKeyboard 组件使用规范
19
+
20
+ ## 1. 核心职责 (Core Responsibility)
21
+ NumberKeyboard 是 foxui 中用于 **虚拟数字键盘** 的标准组件。
22
+ - **基于**: NutUI `nut-number-keyboard` 进行了二次封装 (若为纯自研组件则填 "自定义开发")
23
+ - **核心增强**: 基于 NutUI 组件二次封装、支持 v-model 双向绑定、支持主题定制
24
+ - **适用场景**: 虚拟数字键盘
25
+
26
+ > 💡 **关键原则**: 在所有 虚拟数字键盘 中,**必须**优先使用此组件,禁止直接使用原生 NutUI 组件。
27
+
28
+ ---
29
+
30
+ ## 2. 关键 API 说明 (Key API)
31
+
32
+ ### 2.1 Props 属性
33
+
34
+ | 属性名 | 类型 | 必填 | 默认值 | 说明 |
35
+ | :--- | :--- | :---: | :---: | :--- |
36
+ | `v-model:visible` | 是否显示键盘 | boolean | false |
37
+ | `v-model` | 当前输入值 | string | - |
38
+ | `title` | 键盘标题 | string | - |
39
+ | `type` | 键盘模式 | string | default:默认样式<br>rightColumn:带右侧栏 |
40
+ | `random-keys` | 随机数 | boolean | false |
41
+ | `custom-key` | 自定义键盘额外的键 | string | 数组形式最多支持添加2个,超出默认取前2项 |
42
+ | `maxlength` | 输入值最大长度,结合 v-model 使用 | number \ | string |
43
+ | `confirm-text` | 自定义完成按钮文字,如"支付","下一步","提交"等 | string | 完成 |
44
+ | `pop-class` | 自定义弹框类名 | string | - |
45
+
46
+ ### 2.2 Events 事件
47
+
48
+ | 事件名 | 类型 | 说明 |
49
+ | :--- | :--- | :--- |
50
+ | `input` | 点击按键时触发 | 按键内容 |
51
+ | `delete` | 点击删除键时触发 | - |
52
+ | `close` | 点击关闭按钮时触发 | - |
53
+ | `blur` | 点击关闭按钮或非键盘区域时触发 | - |
54
+
55
+ ### 2.3 Methods 方法
56
+
57
+ | 方法名 | 参数 | 说明 |
58
+ | :--- | :--- | :--- |
59
+
60
+
61
+ ### 2.4 Slots 插槽
62
+
63
+ | 插槽名 | 说明 |
64
+ | :--- | :--- |
65
+
66
+
67
+ ## 3. 例子 (Examples)
68
+
69
+
70
+
71
+ ## 4. 相关组件 (Related Components)
72
+ - **fox-js**: 与 NumberKeyboard 配合使用的相关组件
73
+ - **fox-group**: 与 NumberKeyboard 配合使用的相关组件
74
+ - **fox-row-item**: 与 NumberKeyboard 配合使用的相关组件
75
+ - **fox-button**: 与 NumberKeyboard 配合使用的相关组件
76
+ - **fox-input-item**: 与 NumberKeyboard 配合使用的相关组件
77
+
@@ -0,0 +1,70 @@
1
+ <!--
2
+ * @Author: 江成
3
+ * @Date: 2026-04-27 00:37:28
4
+ * @LastEditors: 江成
5
+ * @LastEditTime: 2026-05-12 22:33:21
6
+ -->
7
+ ---
8
+ title: OverLay 组件使用规范
9
+ impact: HIGH
10
+ type: capability
11
+ description: 创建一个遮罩层,通常用于阻止用户进行其他操作
12
+ tags: [foxui, fox-over-lay, FoxOverLay]
13
+ version: "4.0.0"
14
+ author: jiangcheng
15
+ related: ["fox-js","fox-button","fox-overlay"]
16
+ ---
17
+
18
+ # OverLay 组件使用规范
19
+
20
+ ## 1. 核心职责 (Core Responsibility)
21
+ OverLay 是 foxui 中用于 **创建一个遮罩层,通常用于阻止用户进行其他操作** 的标准组件。
22
+ - **基于**: NutUI `nut-over-lay` 进行了二次封装 (若为纯自研组件则填 "自定义开发")
23
+ - **核心增强**: 基于 NutUI 组件二次封装、支持 v-model 双向绑定、适配 H5 与小程序多端、支持插槽扩展自定义内容、支持主题定制
24
+ - **适用场景**: 创建一个遮罩层,通常用于阻止用户进行其他操作
25
+
26
+ > 💡 **关键原则**: 在所有 创建一个遮罩层,通常用于阻止用户进行其他操作 中,**必须**优先使用此组件,禁止直接使用原生 NutUI 组件。
27
+
28
+ ---
29
+
30
+ ## 2. 关键 API 说明 (Key API)
31
+
32
+ ### 2.1 Props 属性
33
+
34
+ | 属性名 | 类型 | 必填 | 默认值 | 说明 |
35
+ | :--- | :--- | :---: | :---: | :--- |
36
+ | `v-model:visible` | 控制遮罩的显示/隐藏 | boolean | false |
37
+ | `z-index` | 自定义遮罩层级 | string \ | number |
38
+ | `duration` | 显示/隐藏的动画时长,单位秒 | string \ | number |
39
+ | `overlay-class` | 自定义遮罩类名 | string | - |
40
+ | `overlay-style` | 自定义遮罩样式 | CSSProperties | - |
41
+ | `lock-scroll` | 遮罩显示时的背景是否锁定 | boolean | true |
42
+ | `close-on-click-overlay` | 点击遮罩时是否关闭 | boolean | true |
43
+
44
+ ### 2.2 Events 事件
45
+
46
+ | 事件名 | 类型 | 说明 |
47
+ | :--- | :--- | :--- |
48
+ | `click` | 点击时触发 | event: Event |
49
+
50
+ ### 2.3 Methods 方法
51
+
52
+ | 方法名 | 参数 | 说明 |
53
+ | :--- | :--- | :--- |
54
+
55
+
56
+ ### 2.4 Slots 插槽
57
+
58
+ | 插槽名 | 说明 |
59
+ | :--- | :--- |
60
+ | `default` | 内嵌遮罩内容自定义 |
61
+
62
+ ## 3. 例子 (Examples)
63
+
64
+
65
+
66
+ ## 4. 相关组件 (Related Components)
67
+ - **fox-js**: 与 OverLay 配合使用的相关组件
68
+ - **fox-button**: 与 OverLay 配合使用的相关组件
69
+ - **fox-overlay**: 与 OverLay 配合使用的相关组件
70
+
@@ -0,0 +1,76 @@
1
+ <!--
2
+ * @Author: 江成
3
+ * @Date: 2026-04-27 00:37:28
4
+ * @LastEditors: 江成
5
+ * @LastEditTime: 2026-05-12 22:33:21
6
+ -->
7
+ ---
8
+ title: Page 组件使用规范
9
+ impact: HIGH
10
+ type: capability
11
+ description: 页面布局
12
+ tags: [foxui, fox-page, FoxPage]
13
+ version: "4.0.0"
14
+ author: jiangcheng
15
+ related: ["fox-js","fox-header-bar","fox-footer-bar","fox-content","fox-group","fox-input-item","fox-row-item","fox-button"]
16
+ ---
17
+
18
+ # Page 组件使用规范
19
+
20
+ ## 1. 核心职责 (Core Responsibility)
21
+ Page 是 foxui 中用于 **页面布局** 的标准组件。
22
+ - **基于**: NutUI `nut-page` 进行了二次封装 (若为纯自研组件则填 "自定义开发")
23
+ - **核心增强**: 基于 NutUI 组件二次封装、内置必填校验标识、支持 v-model 双向绑定、支持禁用/只读状态、内置表单校验能力
24
+ - **适用场景**: 页面布局
25
+
26
+ > 💡 **关键原则**: 在所有 页面布局 中,**必须**优先使用此组件,禁止直接使用原生 NutUI 组件。
27
+
28
+ ---
29
+
30
+ ## 2. 关键 API 说明 (Key API)
31
+
32
+ ### 2.1 Props 属性
33
+
34
+ | 属性名 | 类型 | 必填 | 默认值 | 说明 |
35
+ | :--- | :--- | :---: | :---: | :--- |
36
+ | `browse` | 浏览模式 | on | off |
37
+ | `disabled` | 禁用设置 | String,Boolean | - |
38
+ | `readonly` | 只读设置 | String,Boolean | - |
39
+ | `labelPosition` | 标签位置left,right,top | String | left |
40
+ | `labelWidth` | 标签宽度 | String,Number | - |
41
+
42
+ ### 2.2 Events 事件
43
+
44
+ | 事件名 | 类型 | 说明 |
45
+ | :--- | :--- | :--- |
46
+
47
+
48
+ ### 2.3 Methods 方法
49
+
50
+ | 方法名 | 参数 | 说明 |
51
+ | :--- | :--- | :--- |
52
+ | `validate` | 校验页面范围内的组件 | — |
53
+ | `clearValidate` | 清空校验信息 | — |
54
+ | `setNameValidateRules` | 设置校验规则 | — |
55
+ | `resetFields` | 重置数据并清空校验信息 | — |
56
+
57
+ ### 2.4 Slots 插槽
58
+
59
+ | 插槽名 | 说明 |
60
+ | :--- | :--- |
61
+
62
+
63
+ ## 3. 例子 (Examples)
64
+
65
+
66
+
67
+ ## 4. 相关组件 (Related Components)
68
+ - **fox-js**: 与 Page 配合使用的相关组件
69
+ - **fox-header-bar**: 与 Page 配合使用的相关组件
70
+ - **fox-footer-bar**: 与 Page 配合使用的相关组件
71
+ - **fox-content**: 与 Page 配合使用的相关组件
72
+ - **fox-group**: 与 Page 配合使用的相关组件
73
+ - **fox-input-item**: 与 Page 配合使用的相关组件
74
+ - **fox-row-item**: 与 Page 配合使用的相关组件
75
+ - **fox-button**: 与 Page 配合使用的相关组件
76
+
@@ -0,0 +1,73 @@
1
+ <!--
2
+ * @Author: 江成
3
+ * @Date: 2026-04-27 00:37:28
4
+ * @LastEditors: 江成
5
+ * @LastEditTime: 2026-05-12 22:33:21
6
+ -->
7
+ ---
8
+ title: Pagination 组件使用规范
9
+ impact: HIGH
10
+ type: capability
11
+ description: 当数据量较多时,采用分页的形式分隔长列表。
12
+ tags: [foxui, fox-pagination, FoxPagination]
13
+ version: "4.0.0"
14
+ author: jiangcheng
15
+ related: ["fox-js","fox-icon"]
16
+ ---
17
+
18
+ # Pagination 组件使用规范
19
+
20
+ ## 1. 核心职责 (Core Responsibility)
21
+ Pagination 是 foxui 中用于 **当数据量较多时,采用分页的形式分隔长列表。** 的标准组件。
22
+ - **基于**: NutUI `nut-pagination` 进行了二次封装 (若为纯自研组件则填 "自定义开发")
23
+ - **核心增强**: 基于 NutUI 组件二次封装、支持 v-model 双向绑定、支持插槽扩展自定义内容、支持主题定制
24
+ - **适用场景**: 当数据量较多时,采用分页的形式分隔长列表。
25
+
26
+ > 💡 **关键原则**: 在所有 当数据量较多时,采用分页的形式分隔长列表。 中,**必须**优先使用此组件,禁止直接使用原生 NutUI 组件。
27
+
28
+ ---
29
+
30
+ ## 2. 关键 API 说明 (Key API)
31
+
32
+ ### 2.1 Props 属性
33
+
34
+ | 属性名 | 类型 | 必填 | 默认值 | 说明 |
35
+ | :--- | :--- | :---: | :---: | :--- |
36
+ | `v-model` | 当前页码 | Number | 1 |
37
+ | `mode` | 显示模式,可选值为 simple | String | multi |
38
+ | `prev-text` | 上一页按钮文字 | String | 上一页 |
39
+ | `next-text` | 下一页按钮文字 | String | 下一页 |
40
+ | `page-count` | 总页数 | String,Number | 传入/根据页数计算 |
41
+ | `total-items` | 总记录数 | String,Number | 0 |
42
+ | `items-per-page` | 每页记录数 | String,Number | 10 |
43
+ | `show-page-size` | 显示的页码个数 | String,Number | 5 |
44
+ | `force-ellipses` | 是否显示省略号 | Boolean | false |
45
+
46
+ ### 2.2 Events 事件
47
+
48
+ | 事件名 | 类型 | 说明 |
49
+ | :--- | :--- | :--- |
50
+ | `change` | 页码改变时触发 | value |
51
+
52
+ ### 2.3 Methods 方法
53
+
54
+ | 方法名 | 参数 | 说明 |
55
+ | :--- | :--- | :--- |
56
+
57
+
58
+ ### 2.4 Slots 插槽
59
+
60
+ | 插槽名 | 说明 |
61
+ | :--- | :--- |
62
+ | `prev-text` | 自定义上一页按钮内容 |
63
+ | `next-text` | 自定义下一页按钮内容 |
64
+ | `page` | 自定义页码 |
65
+
66
+ ## 3. 例子 (Examples)
67
+
68
+
69
+
70
+ ## 4. 相关组件 (Related Components)
71
+ - **fox-js**: 与 Pagination 配合使用的相关组件
72
+ - **fox-icon**: 与 Pagination 配合使用的相关组件
73
+