@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.
- package/README.md +30 -0
- package/foxui/SKILL.md +442 -0
- package/foxui/references/fox-action-sheet/doc.md +74 -0
- package/foxui/references/fox-actionsheet-item/doc.md +499 -0
- package/foxui/references/fox-animate/doc.md +66 -0
- package/foxui/references/fox-audio/doc.md +76 -0
- package/foxui/references/fox-avatar/doc.md +70 -0
- package/foxui/references/fox-back-top/doc.md +69 -0
- package/foxui/references/fox-badge/doc.md +72 -0
- package/foxui/references/fox-barrage/doc.md +116 -0
- package/foxui/references/fox-button/doc.md +203 -0
- package/foxui/references/fox-calendar/doc.md +346 -0
- package/foxui/references/fox-calendar-item/doc.md +331 -0
- package/foxui/references/fox-cascader/doc.md +78 -0
- package/foxui/references/fox-cascader-item/doc.md +710 -0
- package/foxui/references/fox-cell/doc.md +74 -0
- package/foxui/references/fox-checkbox-item/doc.md +387 -0
- package/foxui/references/fox-circle-progress/doc.md +65 -0
- package/foxui/references/fox-collapse/doc.md +71 -0
- package/foxui/references/fox-count-down/doc.md +78 -0
- package/foxui/references/fox-count-up/doc.md +178 -0
- package/foxui/references/fox-date-item/doc.md +437 -0
- package/foxui/references/fox-date-picker/doc.md +438 -0
- package/foxui/references/fox-dialog/doc.md +242 -0
- package/foxui/references/fox-divider/doc.md +149 -0
- package/foxui/references/fox-domain-provider/doc.md +93 -0
- package/foxui/references/fox-drag/doc.md +64 -0
- package/foxui/references/fox-dropdown/doc.md +138 -0
- package/foxui/references/fox-elevator/doc.md +66 -0
- package/foxui/references/fox-ellipsis/doc.md +69 -0
- package/foxui/references/fox-empty/doc.md +67 -0
- package/foxui/references/fox-fixed-nav/doc.md +72 -0
- package/foxui/references/fox-floating-button/doc.md +142 -0
- package/foxui/references/fox-grid/doc.md +69 -0
- package/foxui/references/fox-group/doc.md +295 -0
- package/foxui/references/fox-icon/doc.md +65 -0
- package/foxui/references/fox-image/doc.md +75 -0
- package/foxui/references/fox-image-preview/doc.md +79 -0
- package/foxui/references/fox-indicator/doc.md +70 -0
- package/foxui/references/fox-infinite-loading/doc.md +74 -0
- package/foxui/references/fox-input-item/doc.md +210 -0
- package/foxui/references/fox-input-number/doc.md +199 -0
- package/foxui/references/fox-input-number-item/doc.md +213 -0
- package/foxui/references/fox-item/doc.md +207 -0
- package/foxui/references/fox-layout/doc.md +273 -0
- package/foxui/references/fox-link-item/doc.md +158 -0
- package/foxui/references/fox-list/doc.md +71 -0
- package/foxui/references/fox-mapping/doc.md +251 -0
- package/foxui/references/fox-menu/doc.md +425 -0
- package/foxui/references/fox-message-box/doc.md +200 -0
- package/foxui/references/fox-money-item/doc.md +174 -0
- package/foxui/references/fox-more-button/doc.md +208 -0
- package/foxui/references/fox-navbar/doc.md +75 -0
- package/foxui/references/fox-notice-bar/doc.md +71 -0
- package/foxui/references/fox-notify/doc.md +72 -0
- package/foxui/references/fox-number-keyboard/doc.md +77 -0
- package/foxui/references/fox-over-lay/doc.md +70 -0
- package/foxui/references/fox-page/doc.md +76 -0
- package/foxui/references/fox-pagination/doc.md +73 -0
- package/foxui/references/fox-picker/doc.md +668 -0
- package/foxui/references/fox-picker-item/doc.md +389 -0
- package/foxui/references/fox-popover/doc.md +70 -0
- package/foxui/references/fox-popover-dialog/doc.md +113 -0
- package/foxui/references/fox-popup/doc.md +88 -0
- package/foxui/references/fox-price/doc.md +67 -0
- package/foxui/references/fox-progress/doc.md +74 -0
- package/foxui/references/fox-pull-refresh/doc.md +77 -0
- package/foxui/references/fox-radio-item/doc.md +384 -0
- package/foxui/references/fox-range/doc.md +65 -0
- package/foxui/references/fox-rate/doc.md +141 -0
- package/foxui/references/fox-rate-item/doc.md +137 -0
- package/foxui/references/fox-rolling-provider/doc.md +87 -0
- package/foxui/references/fox-search-bar/doc.md +91 -0
- package/foxui/references/fox-short-password/doc.md +78 -0
- package/foxui/references/fox-side-nav-bar/doc.md +68 -0
- package/foxui/references/fox-signature/doc.md +202 -0
- package/foxui/references/fox-skeleton/doc.md +73 -0
- package/foxui/references/fox-steps/doc.md +162 -0
- package/foxui/references/fox-steps-bar/doc.md +610 -0
- package/foxui/references/fox-sticky/doc.md +68 -0
- package/foxui/references/fox-swipe/doc.md +176 -0
- package/foxui/references/fox-swiper/doc.md +254 -0
- package/foxui/references/fox-switch/doc.md +162 -0
- package/foxui/references/fox-switch-item/doc.md +190 -0
- package/foxui/references/fox-tabbar/doc.md +63 -0
- package/foxui/references/fox-table/doc.md +640 -0
- package/foxui/references/fox-tabs/doc.md +67 -0
- package/foxui/references/fox-tabs-bar/doc.md +533 -0
- package/foxui/references/fox-tag/doc.md +213 -0
- package/foxui/references/fox-text/doc.md +84 -0
- package/foxui/references/fox-textarea-item/doc.md +106 -0
- package/foxui/references/fox-toast/doc.md +149 -0
- package/foxui/references/fox-tour/doc.md +89 -0
- package/foxui/references/fox-trend-arrow/doc.md +72 -0
- package/foxui/references/fox-uploader/doc.md +96 -0
- package/foxui/references/fox-video/doc.md +245 -0
- package/foxui/references/fox-water-mark/doc.md +81 -0
- package/package.json +21 -0
|
@@ -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: FixedNav 组件使用规范
|
|
9
|
+
impact: HIGH
|
|
10
|
+
type: capability
|
|
11
|
+
description: 可拖拽的悬浮导航
|
|
12
|
+
tags: [foxui, fox-fixed-nav, FoxFixedNav]
|
|
13
|
+
version: "4.0.0"
|
|
14
|
+
author: jiangcheng
|
|
15
|
+
related: ["fox-js","fox-fixednav","fox-drag","fox-icon"]
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
# FixedNav 组件使用规范
|
|
19
|
+
|
|
20
|
+
## 1. 核心职责 (Core Responsibility)
|
|
21
|
+
FixedNav 是 foxui 中用于 **可拖拽的悬浮导航** 的标准组件。
|
|
22
|
+
- **基于**: NutUI `nut-fixed-nav` 进行了二次封装 (若为纯自研组件则填 "自定义开发")
|
|
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
|
+
| `visible` | 是否打开 | Boolean | false |
|
|
37
|
+
| `nav-list` | 悬浮列表内容数据 | Array | |
|
|
38
|
+
| `active-text` | 收起列表按钮文案 | String | 收起导航 |
|
|
39
|
+
| `un-active-text` | 展开列表按钮文案 | String | 快速导航 |
|
|
40
|
+
| `type` | 导航方向,可选值 left right | String | right |
|
|
41
|
+
| `overlay` | 展开时是否显示遮罩 | Boolean | true |
|
|
42
|
+
| `position` | fixed 垂直位置 | Object | top: 'auto',bottom: 'auto' |
|
|
43
|
+
|
|
44
|
+
### 2.2 Events 事件
|
|
45
|
+
|
|
46
|
+
| 事件名 | 类型 | 说明 |
|
|
47
|
+
| :--- | :--- | :--- |
|
|
48
|
+
| `selected` | 选择之后触发 | item:item,event:Event |
|
|
49
|
+
|
|
50
|
+
### 2.3 Methods 方法
|
|
51
|
+
|
|
52
|
+
| 方法名 | 参数 | 说明 |
|
|
53
|
+
| :--- | :--- | :--- |
|
|
54
|
+
无
|
|
55
|
+
|
|
56
|
+
### 2.4 Slots 插槽
|
|
57
|
+
|
|
58
|
+
| 插槽名 | 说明 |
|
|
59
|
+
| :--- | :--- |
|
|
60
|
+
| `btn` | 自定义按钮 |
|
|
61
|
+
| `list` | 自定义展开列表内容 |
|
|
62
|
+
|
|
63
|
+
## 3. 例子 (Examples)
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
## 4. 相关组件 (Related Components)
|
|
68
|
+
- **fox-js**: 与 FixedNav 配合使用的相关组件
|
|
69
|
+
- **fox-fixednav**: 与 FixedNav 配合使用的相关组件
|
|
70
|
+
- **fox-drag**: 与 FixedNav 配合使用的相关组件
|
|
71
|
+
- **fox-icon**: 与 FixedNav 配合使用的相关组件
|
|
72
|
+
|
|
@@ -0,0 +1,142 @@
|
|
|
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: FloatingButton 组件使用规范
|
|
9
|
+
impact: HIGH
|
|
10
|
+
type: capability
|
|
11
|
+
description: 浮动按钮
|
|
12
|
+
tags: [foxui, fox-floating-button, FoxFloatingButton]
|
|
13
|
+
version: "4.0.0"
|
|
14
|
+
author: jiangcheng
|
|
15
|
+
related: ["fox-js"]
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
# FloatingButton 组件使用规范
|
|
19
|
+
|
|
20
|
+
## 1. 核心职责 (Core Responsibility)
|
|
21
|
+
FloatingButton 是 foxui 中用于 **浮动按钮** 的标准组件。
|
|
22
|
+
- **基于**: NutUI `nut-floating-button` 进行了二次封装 (若为纯自研组件则填 "自定义开发")
|
|
23
|
+
- **核心增强**: 基于 NutUI 组件二次封装、适配 H5 与小程序多端、支持插槽扩展自定义内容、支持主题定制
|
|
24
|
+
- **适用场景**: 浮动按钮
|
|
25
|
+
|
|
26
|
+
> 💡 **关键原则**: 在所有 浮动按钮 中,**必须**优先使用此组件,禁止直接使用原生 NutUI 组件。
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 2. 关键 API 说明 (Key API)
|
|
31
|
+
|
|
32
|
+
### 2.1 Props 属性
|
|
33
|
+
|
|
34
|
+
| 属性名 | 类型 | 必填 | 默认值 | 说明 |
|
|
35
|
+
| :--- | :--- | :---: | :---: | :--- |
|
|
36
|
+
| `top` | top坐标 | string | - |
|
|
37
|
+
| `right` | right坐标 | string | - |
|
|
38
|
+
| `bottom` | bottom坐标 | string | - |
|
|
39
|
+
| `left` | left坐标 | string | - |
|
|
40
|
+
| `width` | 宽度 | string | - |
|
|
41
|
+
| `height` | 高度 | string | - |
|
|
42
|
+
| `color` | 前景色 | string | - |
|
|
43
|
+
| `background` | 背景色 | string | - |
|
|
44
|
+
| `border-radius` | 边框圆角 | string | - |
|
|
45
|
+
| `draggable` | 启用可拖拽功能 | boolean | false |
|
|
46
|
+
| `custom-class` | 自定义class | stirng | - |
|
|
47
|
+
|
|
48
|
+
### 2.2 Events 事件
|
|
49
|
+
|
|
50
|
+
| 事件名 | 类型 | 说明 |
|
|
51
|
+
| :--- | :--- | :--- |
|
|
52
|
+
| `click` | 点击按钮触发 | - |
|
|
53
|
+
|
|
54
|
+
### 2.3 Methods 方法
|
|
55
|
+
|
|
56
|
+
| 方法名 | 参数 | 说明 |
|
|
57
|
+
| :--- | :--- | :--- |
|
|
58
|
+
无
|
|
59
|
+
|
|
60
|
+
### 2.4 Slots 插槽
|
|
61
|
+
|
|
62
|
+
| 插槽名 | 说明 |
|
|
63
|
+
| :--- | :--- |
|
|
64
|
+
| `defualt` | 自定义标签 |
|
|
65
|
+
|
|
66
|
+
## 3. 例子 (Examples)
|
|
67
|
+
|
|
68
|
+
## 代码演示
|
|
69
|
+
### 基础用法
|
|
70
|
+
```html
|
|
71
|
+
<template>
|
|
72
|
+
<h2>基础用法</h2>
|
|
73
|
+
<fox-floating-button @click="onClickForBasic" right="50px" bottom="100px"></fox-floating-button>
|
|
74
|
+
</template>
|
|
75
|
+
<script lang="ts" setup>
|
|
76
|
+
import { Toast } from '@fox-js/foxui'
|
|
77
|
+
// 点击事件
|
|
78
|
+
const onClickForBasic = () => {
|
|
79
|
+
Toast.success('基础用法')
|
|
80
|
+
}
|
|
81
|
+
</script>
|
|
82
|
+
```
|
|
83
|
+
### 自定义样式
|
|
84
|
+
通过属性`color`和`background`设置按钮的样式
|
|
85
|
+
```html
|
|
86
|
+
<template>
|
|
87
|
+
<h2>自定义样式</h2>
|
|
88
|
+
<fox-floating-button
|
|
89
|
+
@click="onClickForCustom"
|
|
90
|
+
right="50px"
|
|
91
|
+
bottom="250px"
|
|
92
|
+
background="linear-gradient(136.56deg, rgba(251, 139, 45, 1) 0%, rgba(255, 82, 23, 1) 100%)"
|
|
93
|
+
><span>自</span></fox-floating-button
|
|
94
|
+
>
|
|
95
|
+
</template>
|
|
96
|
+
<script lang="ts" setup>
|
|
97
|
+
import { Toast } from '@fox-js/foxui'
|
|
98
|
+
// 点击事件
|
|
99
|
+
const onClickForCustom = () => {
|
|
100
|
+
Toast.success('自定义')
|
|
101
|
+
}
|
|
102
|
+
</script>
|
|
103
|
+
```
|
|
104
|
+
### 可拖拽
|
|
105
|
+
通过属性`draggable`设置按钮可拖拽
|
|
106
|
+
```html
|
|
107
|
+
<template>
|
|
108
|
+
<h2>可拖拽</h2>
|
|
109
|
+
<fox-floating-button @click="onClickForDraggable" right="250px" bottom="100px" :draggable="true">
|
|
110
|
+
<span>拖拽</span>
|
|
111
|
+
</fox-floating-button>
|
|
112
|
+
</template>
|
|
113
|
+
<script lang="ts" setup>
|
|
114
|
+
import { Toast } from '@fox-js/foxui'
|
|
115
|
+
// 点击事件
|
|
116
|
+
const onClickForDraggable = () => {
|
|
117
|
+
Toast.success('可拖拽')
|
|
118
|
+
}
|
|
119
|
+
</script>
|
|
120
|
+
```
|
|
121
|
+
### 修改图标
|
|
122
|
+
使用插槽修改图片或者内容
|
|
123
|
+
```html
|
|
124
|
+
<template>
|
|
125
|
+
<h2>更新图标</h2>
|
|
126
|
+
<fox-floating-button @click="onClickForIcon" right="250px" bottom="250px">
|
|
127
|
+
<Star width="20px" height="20px"></Star>
|
|
128
|
+
</fox-floating-button>
|
|
129
|
+
</template>
|
|
130
|
+
<script lang="ts" setup>
|
|
131
|
+
import { Toast } from '@fox-js/foxui'
|
|
132
|
+
import { Star } from '@fox-js/icons-vue'
|
|
133
|
+
// 点击事件
|
|
134
|
+
const onClickForIcon = () => {
|
|
135
|
+
Toast.success('修改图标')
|
|
136
|
+
}
|
|
137
|
+
</script>
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## 4. 相关组件 (Related Components)
|
|
141
|
+
- **fox-js**: 与 FloatingButton 配合使用的相关组件
|
|
142
|
+
|
|
@@ -0,0 +1,69 @@
|
|
|
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: Grid 组件使用规范
|
|
9
|
+
impact: HIGH
|
|
10
|
+
type: capability
|
|
11
|
+
description: 用于分隔成等宽区块进行页面导航
|
|
12
|
+
tags: [foxui, fox-grid, FoxGrid]
|
|
13
|
+
version: "4.0.0"
|
|
14
|
+
author: jiangcheng
|
|
15
|
+
related: ["fox-js","fox-grid-item","fox-avatar","fox-avator"]
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
# Grid 组件使用规范
|
|
19
|
+
|
|
20
|
+
## 1. 核心职责 (Core Responsibility)
|
|
21
|
+
Grid 是 foxui 中用于 **用于分隔成等宽区块进行页面导航** 的标准组件。
|
|
22
|
+
- **基于**: NutUI `nut-grid` 进行了二次封装 (若为纯自研组件则填 "自定义开发")
|
|
23
|
+
- **核心增强**: 基于 NutUI 组件二次封装、适配 H5 与小程序多端、支持插槽扩展自定义内容、支持主题定制
|
|
24
|
+
- **适用场景**: 用于分隔成等宽区块进行页面导航
|
|
25
|
+
|
|
26
|
+
> 💡 **关键原则**: 在所有 用于分隔成等宽区块进行页面导航 中,**必须**优先使用此组件,禁止直接使用原生 NutUI 组件。
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 2. 关键 API 说明 (Key API)
|
|
31
|
+
|
|
32
|
+
### 2.1 Props 属性
|
|
33
|
+
|
|
34
|
+
| 属性名 | 类型 | 必填 | 默认值 | 说明 |
|
|
35
|
+
| :--- | :--- | :---: | :---: | :--- |
|
|
36
|
+
| `text` | 文字 | string | - |
|
|
37
|
+
| `url` | 点击后跳转的链接地址 | string | '' |
|
|
38
|
+
| `to` | 点击后跳转的目标路由对象,同 vue-router 的 to 属性https://router.vuejs.org/zh/api/to 属性 | string \ | object |
|
|
39
|
+
| `replace` | 是否在跳转时替换当前页面历史 | boolean | false |
|
|
40
|
+
|
|
41
|
+
### 2.2 Events 事件
|
|
42
|
+
|
|
43
|
+
| 事件名 | 类型 | 说明 |
|
|
44
|
+
| :--- | :--- | :--- |
|
|
45
|
+
| `click` | 点击格子时触发 | event: Event |
|
|
46
|
+
|
|
47
|
+
### 2.3 Methods 方法
|
|
48
|
+
|
|
49
|
+
| 方法名 | 参数 | 说明 |
|
|
50
|
+
| :--- | :--- | :--- |
|
|
51
|
+
无
|
|
52
|
+
|
|
53
|
+
### 2.4 Slots 插槽
|
|
54
|
+
|
|
55
|
+
| 插槽名 | 说明 |
|
|
56
|
+
| :--- | :--- |
|
|
57
|
+
| `default` | 自定义所有内容 |
|
|
58
|
+
| `text` | 自定义文字 |
|
|
59
|
+
|
|
60
|
+
## 3. 例子 (Examples)
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
## 4. 相关组件 (Related Components)
|
|
65
|
+
- **fox-js**: 与 Grid 配合使用的相关组件
|
|
66
|
+
- **fox-grid-item**: 与 Grid 配合使用的相关组件
|
|
67
|
+
- **fox-avatar**: 与 Grid 配合使用的相关组件
|
|
68
|
+
- **fox-avator**: 与 Grid 配合使用的相关组件
|
|
69
|
+
|
|
@@ -0,0 +1,295 @@
|
|
|
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: Group 组件使用规范
|
|
9
|
+
impact: HIGH
|
|
10
|
+
type: capability
|
|
11
|
+
description: 页面group
|
|
12
|
+
tags: [foxui, fox-group, FoxGroup]
|
|
13
|
+
version: "4.0.0"
|
|
14
|
+
author: jiangcheng
|
|
15
|
+
related: ["fox-js","fox-item","fox-page","fox-content","fox-input-item","fox-money-item","fox-date-item"]
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
# Group 组件使用规范
|
|
19
|
+
|
|
20
|
+
## 1. 核心职责 (Core Responsibility)
|
|
21
|
+
Group 是 foxui 中用于 **页面group** 的标准组件。
|
|
22
|
+
- **基于**: NutUI `nut-group` 进行了二次封装 (若为纯自研组件则填 "自定义开发")
|
|
23
|
+
- **核心增强**: 基于 NutUI 组件二次封装、支持 v-model 双向绑定、支持标签位置自定义、适配 H5 与小程序多端、支持插槽扩展自定义内容、内置表单校验能力、支持主题定制
|
|
24
|
+
- **适用场景**: 页面group
|
|
25
|
+
|
|
26
|
+
> 💡 **关键原则**: 在所有 页面group 中,**必须**优先使用此组件,禁止直接使用原生 NutUI 组件。
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 2. 关键 API 说明 (Key API)
|
|
31
|
+
|
|
32
|
+
### 2.1 Props 属性
|
|
33
|
+
|
|
34
|
+
| 属性名 | 类型 | 必填 | 默认值 | 说明 |
|
|
35
|
+
| :--- | :--- | :---: | :---: | :--- |
|
|
36
|
+
| `prop` | 名称 | String | - |
|
|
37
|
+
| `title` | 标题 | String | - |
|
|
38
|
+
| `title-color` | 标题颜色 | String | - |
|
|
39
|
+
| `type` | 布局类型 | grid,form,flow | - |
|
|
40
|
+
| `span` | 跨列(用于子group) | String,Number | - |
|
|
41
|
+
| `offset` | 偏移(用于子group) | String,Number | - |
|
|
42
|
+
| `is-wrap` | 是否包裹容器 | Boolean | false |
|
|
43
|
+
| `rules` | group范围校验规则 | Object | - |
|
|
44
|
+
| `modelValue` | v-model or model-value 用于重置group范围表单数据 | Object | - |
|
|
45
|
+
| `auto-layout` | 是否允许自动调整布局 | boolean | true |
|
|
46
|
+
| `show-mark` | 是否显示mark标志 | boolean | true |
|
|
47
|
+
| `mark-color` | mark的颜色 | string | - |
|
|
48
|
+
| `column` | group列数 | string | number |
|
|
49
|
+
| `columnWidth` | group列宽与列数column为互斥关系,仅在type=grid情况下生效 | string | - |
|
|
50
|
+
| `gutter` | item的间隔 | string | number |
|
|
51
|
+
| `justify` | grid 布局下的水平排列方式 | string | start |
|
|
52
|
+
| `align` | grid 布局下的垂直排列方式 | string | start |
|
|
53
|
+
| `min-item-width` | grou内item最小宽度,自动布局能通过调整列数来适配 | string | number |
|
|
54
|
+
| `max-item-width` | grou内item最大宽度,自动布局能通过调整列数来适配 | string | number |
|
|
55
|
+
| `collapse` | 是否支持内容区折叠 | boolean | - |
|
|
56
|
+
| `show-collapse` | 是否显示内容区折叠按钮 | boolean | - |
|
|
57
|
+
| `collapse-position` | 折叠区域位置 | left,right | - |
|
|
58
|
+
| `collapse-text` | 折叠提示文本 | string | - |
|
|
59
|
+
| `collapse-icon` | 折叠提示图标 | Component | - |
|
|
60
|
+
| `expand-text` | 展开提示文本 | string | - |
|
|
61
|
+
| `expand-icon` | 展开提示图标 | Compnent | - |
|
|
62
|
+
| `rolling-display` | 是否支持滚动显示 | boolean | true |
|
|
63
|
+
| `browse` | 浏览模式 | on | off |
|
|
64
|
+
|
|
65
|
+
### 2.2 Events 事件
|
|
66
|
+
|
|
67
|
+
| 事件名 | 类型 | 说明 |
|
|
68
|
+
| :--- | :--- | :--- |
|
|
69
|
+
| `header-click` | 头部点击事件 | — |
|
|
70
|
+
|
|
71
|
+
### 2.3 Methods 方法
|
|
72
|
+
|
|
73
|
+
| 方法名 | 参数 | 说明 |
|
|
74
|
+
| :--- | :--- | :--- |
|
|
75
|
+
| `validate` | 校验页面范围内的组件 | — |
|
|
76
|
+
| `clearValidate` | 清空校验信息 | — |
|
|
77
|
+
| `setNameValidateRules` | 设置校验规则 | — |
|
|
78
|
+
| `resetFields` | 重置数据并清空校验信息 | — |
|
|
79
|
+
|
|
80
|
+
### 2.4 Slots 插槽
|
|
81
|
+
|
|
82
|
+
| 插槽名 | 说明 |
|
|
83
|
+
| :--- | :--- |
|
|
84
|
+
| `default` | 内容 |
|
|
85
|
+
| `header` | 头部栏插槽 |
|
|
86
|
+
| `toolbar` | 工具栏插槽 |
|
|
87
|
+
| `toolbar` | 工具栏插槽 |
|
|
88
|
+
|
|
89
|
+
## 3. 例子 (Examples)
|
|
90
|
+
|
|
91
|
+
## 代码演示
|
|
92
|
+
|
|
93
|
+
### 基础用法
|
|
94
|
+
|
|
95
|
+
通过`fox-group`的`column`属性设置`group`的容器的列,放置在容器内容`fox-item`按列进行布局
|
|
96
|
+
|
|
97
|
+
```html
|
|
98
|
+
<fox-group label-position="left" title="基础用法" column="4">
|
|
99
|
+
<fox-item>
|
|
100
|
+
<template v-slot:default>
|
|
101
|
+
<div class="demo-item red">1</div>
|
|
102
|
+
</template>
|
|
103
|
+
</fox-item>
|
|
104
|
+
<fox-item>
|
|
105
|
+
<template v-slot:default>
|
|
106
|
+
<div class="demo-item blue">2</div>
|
|
107
|
+
</template>
|
|
108
|
+
</fox-item>
|
|
109
|
+
<fox-item>
|
|
110
|
+
<template v-slot:default>
|
|
111
|
+
<div class="demo-item green">3</div>
|
|
112
|
+
</template>
|
|
113
|
+
</fox-item>
|
|
114
|
+
<fox-item>
|
|
115
|
+
<template v-slot:default>
|
|
116
|
+
<div class="demo-item gray">4</div>
|
|
117
|
+
</template>
|
|
118
|
+
</fox-item>
|
|
119
|
+
</fox-group>
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### 跨列
|
|
123
|
+
|
|
124
|
+
通过`fox-group`的`column`和`span`属性的组合实现更加灵活的布局
|
|
125
|
+
|
|
126
|
+
```html
|
|
127
|
+
<fox-group label-position="left" title="3列+跨列" column="3">
|
|
128
|
+
<fox-item>
|
|
129
|
+
<template v-slot:default>
|
|
130
|
+
<div class="demo-item red">1</div>
|
|
131
|
+
</template>
|
|
132
|
+
</fox-item>
|
|
133
|
+
<fox-item span="2">
|
|
134
|
+
<template v-slot:default>
|
|
135
|
+
<div class="demo-item blue">2</div>
|
|
136
|
+
</template>
|
|
137
|
+
</fox-item>
|
|
138
|
+
<fox-item>
|
|
139
|
+
<template v-slot:default>
|
|
140
|
+
<div class="demo-item green">3</div>
|
|
141
|
+
</template>
|
|
142
|
+
</fox-item>
|
|
143
|
+
<fox-item>
|
|
144
|
+
<template v-slot:default>
|
|
145
|
+
<div class="demo-item gray">4</div>
|
|
146
|
+
</template>
|
|
147
|
+
</fox-item>
|
|
148
|
+
</fox-group>
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### 偏移
|
|
152
|
+
|
|
153
|
+
* 通过`fox-group`的`offset`属性,对`item`类组件进行偏移
|
|
154
|
+
|
|
155
|
+
```html
|
|
156
|
+
<fox-page :height="150">
|
|
157
|
+
<fox-content>
|
|
158
|
+
<fox-group title="4列+偏移" column="4">
|
|
159
|
+
<fox-item>
|
|
160
|
+
<template v-slot:default>
|
|
161
|
+
<div class="demo-item red">1</div>
|
|
162
|
+
</template>
|
|
163
|
+
</fox-item>
|
|
164
|
+
<fox-item :offset="2">
|
|
165
|
+
<template v-slot:default>
|
|
166
|
+
<div class="demo-item blue">2(offset2)</div>
|
|
167
|
+
</template>
|
|
168
|
+
</fox-item>
|
|
169
|
+
<fox-item>
|
|
170
|
+
<template v-slot:default>
|
|
171
|
+
<div class="demo-item green">3</div>
|
|
172
|
+
</template>
|
|
173
|
+
</fox-item>
|
|
174
|
+
<fox-item span="2" offset="1">
|
|
175
|
+
<template v-slot:default>
|
|
176
|
+
<div class="demo-item gray">4(span:2,offset:1)</div>
|
|
177
|
+
</template>
|
|
178
|
+
</fox-item>
|
|
179
|
+
</fox-group>
|
|
180
|
+
</fox-content>
|
|
181
|
+
</fox-page>
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### Group组合
|
|
185
|
+
|
|
186
|
+
```html
|
|
187
|
+
<fox-group v-if="true" title="Group组合" column="2">
|
|
188
|
+
<fox-group>
|
|
189
|
+
<fox-item>
|
|
190
|
+
<template v-slot:default>
|
|
191
|
+
<div class="demo-item red">1</div>
|
|
192
|
+
</template>
|
|
193
|
+
</fox-item>
|
|
194
|
+
<fox-item>
|
|
195
|
+
<template v-slot:default>
|
|
196
|
+
<div class="demo-item green">2</div>
|
|
197
|
+
</template>
|
|
198
|
+
</fox-item>
|
|
199
|
+
</fox-group>
|
|
200
|
+
<fox-group column="2">
|
|
201
|
+
<fox-item>
|
|
202
|
+
<template v-slot:default>
|
|
203
|
+
<div class="demo-item red">1</div>
|
|
204
|
+
</template>
|
|
205
|
+
</fox-item>
|
|
206
|
+
<fox-item>
|
|
207
|
+
<template v-slot:default>
|
|
208
|
+
<div class="demo-item blue">2</div>
|
|
209
|
+
</template>
|
|
210
|
+
</fox-item>
|
|
211
|
+
<fox-item>
|
|
212
|
+
<template v-slot:default>
|
|
213
|
+
<div class="demo-item green">3</div>
|
|
214
|
+
</template>
|
|
215
|
+
</fox-item>
|
|
216
|
+
<fox-item>
|
|
217
|
+
<template v-slot:default>
|
|
218
|
+
<div class="demo-item gray">4</div>
|
|
219
|
+
</template>
|
|
220
|
+
</fox-item>
|
|
221
|
+
<fox-item>
|
|
222
|
+
<template v-slot:default>
|
|
223
|
+
<div class="demo-item red">5</div>
|
|
224
|
+
</template>
|
|
225
|
+
</fox-item>
|
|
226
|
+
<fox-item>
|
|
227
|
+
<template v-slot:default>
|
|
228
|
+
<div class="demo-item blue">6</div>
|
|
229
|
+
</template>
|
|
230
|
+
</fox-item>
|
|
231
|
+
<fox-item>
|
|
232
|
+
<template v-slot:default>
|
|
233
|
+
<div class="demo-item green">7</div>
|
|
234
|
+
</template>
|
|
235
|
+
</fox-item>
|
|
236
|
+
<fox-item>
|
|
237
|
+
<template v-slot:default>
|
|
238
|
+
<div class="demo-item gray">8</div>
|
|
239
|
+
</template>
|
|
240
|
+
</fox-item>
|
|
241
|
+
</fox-group>
|
|
242
|
+
</fox-group>
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
### 无标题
|
|
247
|
+
|
|
248
|
+
```html
|
|
249
|
+
<fox-group>
|
|
250
|
+
<fox-input-item>文本</fox-input-item>
|
|
251
|
+
<fox-money-item unit="元">金额</fox-money-item>
|
|
252
|
+
<fox-date-item>日期</fox-date-item>
|
|
253
|
+
</fox-group>
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
## 4. 相关组件 (Related Components)
|
|
257
|
+
- **fox-js**: 与 Group 配合使用的相关组件
|
|
258
|
+
- **fox-item**: 与 Group 配合使用的相关组件
|
|
259
|
+
- **fox-page**: 与 Group 配合使用的相关组件
|
|
260
|
+
- **fox-content**: 与 Group 配合使用的相关组件
|
|
261
|
+
- **fox-input-item**: 与 Group 配合使用的相关组件
|
|
262
|
+
- **fox-money-item**: 与 Group 配合使用的相关组件
|
|
263
|
+
- **fox-date-item**: 与 Group 配合使用的相关组件
|
|
264
|
+
|
|
265
|
+
## 5. 子组件 API (Sub-components)
|
|
266
|
+
|
|
267
|
+
### FoxItem Attributes
|
|
268
|
+
|
|
269
|
+
| 属性名 | 类型 | 必填 | 默认值 | 说明 |
|
|
270
|
+
| :--- | :--- | :---: | :---: | :--- |
|
|
271
|
+
| `span` | 跨列 | String,Number | - |
|
|
272
|
+
| `offset` | 偏移 | String,Number | - |
|
|
273
|
+
| `width` | 宽度 | String,Number | - |
|
|
274
|
+
|
|
275
|
+
### FoxItem Methods
|
|
276
|
+
|
|
277
|
+
| 方法名 | 参数 | 说明 |
|
|
278
|
+
| :--- | :--- | :--- |
|
|
279
|
+
| `validate` | 执行校验 | — |
|
|
280
|
+
| `clearValidate` | 清空校验信息 | — |
|
|
281
|
+
| `setValidateRule` | 设置校验规则 | — |
|
|
282
|
+
|
|
283
|
+
### FoxRowItem Attributes
|
|
284
|
+
|
|
285
|
+
| 属性名 | 类型 | 必填 | 默认值 | 说明 |
|
|
286
|
+
| :--- | :--- | :---: | :---: | :--- |
|
|
287
|
+
| `align` | 对齐方式 | Stringleft,center,right | center |
|
|
288
|
+
| `divide` | 启用分隔符 | String | false |
|
|
289
|
+
|
|
290
|
+
### FoxRowItem Slots
|
|
291
|
+
|
|
292
|
+
| 插槽名 | 说明 |
|
|
293
|
+
| :--- | :--- |
|
|
294
|
+
| `default` | 内容 |
|
|
295
|
+
|
|
@@ -0,0 +1,65 @@
|
|
|
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: Icon 组件使用规范
|
|
9
|
+
impact: HIGH
|
|
10
|
+
type: capability
|
|
11
|
+
description: 图标
|
|
12
|
+
tags: [foxui, fox-icon, FoxIcon]
|
|
13
|
+
version: "4.0.0"
|
|
14
|
+
author: jiangcheng
|
|
15
|
+
related: ["fox-js"]
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
# Icon 组件使用规范
|
|
19
|
+
|
|
20
|
+
## 1. 核心职责 (Core Responsibility)
|
|
21
|
+
Icon 是 foxui 中用于 **图标** 的标准组件。
|
|
22
|
+
- **基于**: NutUI `nut-icon` 进行了二次封装 (若为纯自研组件则填 "自定义开发")
|
|
23
|
+
- **核心增强**: 基于 NutUI 组件二次封装
|
|
24
|
+
- **适用场景**: 图标
|
|
25
|
+
|
|
26
|
+
> 💡 **关键原则**: 在所有 图标 中,**必须**优先使用此组件,禁止直接使用原生 NutUI 组件。
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 2. 关键 API 说明 (Key API)
|
|
31
|
+
|
|
32
|
+
### 2.1 Props 属性
|
|
33
|
+
|
|
34
|
+
| 属性名 | 类型 | 必填 | 默认值 | 说明 |
|
|
35
|
+
| :--- | :--- | :---: | :---: | :--- |
|
|
36
|
+
| `name` | 图标名称或图片链接 | string | - |
|
|
37
|
+
| `color` | 图标颜色 | string | - |
|
|
38
|
+
| `width` | 图标大小,如 20px 2em 2rem | string \ | object |
|
|
39
|
+
| `height` | 图标大小,如 20px 2em 2rem | string \ | object |
|
|
40
|
+
|
|
41
|
+
### 2.2 Events 事件
|
|
42
|
+
|
|
43
|
+
| 事件名 | 类型 | 说明 |
|
|
44
|
+
| :--- | :--- | :--- |
|
|
45
|
+
| `click` | 点击图标时触发 | event: Event |
|
|
46
|
+
|
|
47
|
+
### 2.3 Methods 方法
|
|
48
|
+
|
|
49
|
+
| 方法名 | 参数 | 说明 |
|
|
50
|
+
| :--- | :--- | :--- |
|
|
51
|
+
无
|
|
52
|
+
|
|
53
|
+
### 2.4 Slots 插槽
|
|
54
|
+
|
|
55
|
+
| 插槽名 | 说明 |
|
|
56
|
+
| :--- | :--- |
|
|
57
|
+
无
|
|
58
|
+
|
|
59
|
+
## 3. 例子 (Examples)
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
## 4. 相关组件 (Related Components)
|
|
64
|
+
- **fox-js**: 与 Icon 配合使用的相关组件
|
|
65
|
+
|