niuma-ui 1.0.1 → 1.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/CHANGELOG.md +65 -1
- package/package.json +10 -2
- package/src/__tests__/RsButton.spec.ts +47 -0
- package/src/__tests__/RsCard.spec.ts +160 -1
- package/src/__tests__/RsConfirmDialog.spec.ts +127 -0
- package/src/__tests__/RsContextMenu.spec.ts +12 -0
- package/src/__tests__/RsDatePicker.spec.ts +21 -0
- package/src/__tests__/RsDateTimePicker.spec.ts +11 -0
- package/src/__tests__/RsDescriptions.spec.ts +50 -0
- package/src/__tests__/RsDialog.spec.ts +178 -0
- package/src/__tests__/RsDrawer.spec.ts +96 -3
- package/src/__tests__/RsDynamicTags.spec.ts +52 -0
- package/src/__tests__/RsForm.spec.ts +250 -6
- package/src/__tests__/RsFormItem.spec.ts +478 -0
- package/src/__tests__/RsFormList.spec.ts +109 -0
- package/src/__tests__/RsInput.spec.ts +108 -1
- package/src/__tests__/RsInputNumber.spec.ts +33 -0
- package/src/__tests__/RsMenu.spec.ts +406 -14
- package/src/__tests__/RsPagination.spec.ts +67 -2
- package/src/__tests__/RsSelect.spec.ts +465 -2
- package/src/__tests__/RsSwitch.spec.ts +74 -0
- package/src/__tests__/RsTable.a11y.spec.ts +83 -0
- package/src/__tests__/RsTable.dom-baseline.spec.ts +87 -0
- package/src/__tests__/RsTable.perf.spec.ts +23 -4
- package/src/__tests__/RsTable.spec.ts +63 -8
- package/src/__tests__/RsTable.ssr.spec.ts +71 -0
- package/src/__tests__/RsTable.summary.spec.ts +45 -0
- package/src/__tests__/RsTabs.spec.ts +102 -4
- package/src/__tests__/RsTimePicker.spec.ts +20 -0
- package/src/__tests__/RsTooltip.spec.ts +43 -0
- package/src/__tests__/RsUpload.spec.ts +62 -6
- package/src/__tests__/createRsDialog.spec.ts +145 -0
- package/src/__tests__/css-token.spec.ts +51 -0
- package/src/__tests__/date-picker-utils.spec.ts +49 -0
- package/src/__tests__/dialog-utils.spec.ts +43 -0
- package/src/__tests__/form-path.spec.ts +46 -0
- package/src/__tests__/form-rules.spec.ts +139 -0
- package/src/__tests__/perf-budgets.ts +32 -0
- package/src/__tests__/rs-table-api.spec.ts +206 -0
- package/src/__tests__/rs-table-compat-matrix.spec.ts +108 -0
- package/src/__tests__/rs-table-echarts-adapter.spec.ts +43 -0
- package/src/__tests__/rs-table-grid-nav.spec.ts +63 -0
- package/src/__tests__/rs-table-isolation.spec.ts +158 -0
- package/src/__tests__/split-pane-utils.spec.ts +21 -0
- package/src/__tests__/table-chart-utils.spec.ts +88 -0
- package/src/__tests__/table-summary-utils.spec.ts +62 -0
- package/src/__tests__/table-utils.spec.ts +124 -0
- package/src/__tests__/theme.spec.ts +27 -0
- package/src/__tests__/useRsTableColumnResize.spec.ts +25 -0
- package/src/__tests__/useRsTableCore.perf.spec.ts +170 -0
- package/src/components/RsAlert.vue +212 -0
- package/src/components/RsAvatar.vue +1 -1
- package/src/components/RsBadge.vue +1 -1
- package/src/components/RsBreadcrumb.vue +1 -1
- package/src/components/RsButton.vue +147 -23
- package/src/components/RsCalendarGrid.vue +3 -3
- package/src/components/RsCard.vue +204 -20
- package/src/components/RsCodeBlock.vue +4 -4
- package/src/components/RsCodeEditor.vue +8 -8
- package/src/components/RsConfirmDialog.vue +217 -30
- package/src/components/RsContextMenu.vue +57 -17
- package/src/components/RsDatePicker.vue +316 -39
- package/src/components/RsDateTimePicker.vue +27 -2
- package/src/components/RsDescriptions.vue +186 -0
- package/src/components/RsDescriptionsItem.vue +32 -0
- package/src/components/RsDialog.vue +374 -52
- package/src/components/RsDivider.vue +89 -0
- package/src/components/RsDrawer.vue +559 -34
- package/src/components/RsDropdown.vue +34 -3
- package/src/components/RsDynamicTags.vue +531 -0
- package/src/components/RsEmpty.vue +1 -1
- package/src/components/RsForm.vue +164 -8
- package/src/components/RsFormItem.vue +423 -0
- package/src/components/RsFormItemControl.vue +21 -0
- package/src/components/RsFormList.vue +117 -0
- package/src/components/RsInput.vue +491 -100
- package/src/components/RsInputNumber.vue +77 -27
- package/src/components/RsLabel.vue +20 -5
- package/src/components/RsLink.vue +1 -1
- package/src/components/RsLoadingBar.vue +151 -0
- package/src/components/RsMarkdown.vue +5 -5
- package/src/components/RsMenu.vue +74 -16
- package/src/components/RsMenuItems.vue +147 -9
- package/src/components/RsMonacoEditor.vue +9 -3
- package/src/components/RsPagination.vue +93 -14
- package/src/components/RsProseEditor.vue +3 -3
- package/src/components/RsRadio.vue +81 -0
- package/src/components/RsRadioItem.vue +156 -0
- package/src/components/RsSelect.vue +372 -642
- package/src/components/RsSidebarGroup.vue +1 -1
- package/src/components/RsSplitPane.vue +90 -1
- package/src/components/RsStatCard.vue +2 -2
- package/src/components/RsSteps.vue +2 -2
- package/src/components/RsSwitch.vue +192 -0
- package/src/components/RsTable.vue +653 -2555
- package/src/components/RsTabs.vue +422 -90
- package/src/components/RsTag.vue +191 -0
- package/src/components/RsTerminal.vue +58 -19
- package/src/components/RsTimePicker.vue +72 -9
- package/src/components/RsTimePickerColumns.vue +137 -78
- package/src/components/RsToaster.vue +64 -24
- package/src/components/RsTooltip.vue +10 -1
- package/src/components/RsTooltipProvider.vue +11 -1
- package/src/components/RsTree.vue +45 -27
- package/src/components/RsUpload.vue +147 -14
- package/src/components/RsVNodeHost.vue +20 -0
- package/src/components/button-utils.ts +39 -0
- package/src/components/context-menu-utils.ts +6 -0
- package/src/components/date-picker-utils.ts +195 -4
- package/src/components/descriptions-utils.ts +24 -0
- package/src/components/dialog-utils.ts +182 -0
- package/src/components/dialog-window.ts +74 -9
- package/src/components/drawer-utils.ts +73 -0
- package/src/components/form-item-control.ts +55 -0
- package/src/components/form-path.ts +92 -0
- package/src/components/form-rules.ts +311 -0
- package/src/components/form-utils.ts +145 -3
- package/src/components/menu-utils.ts +11 -0
- package/src/components/overlay-utils.ts +3 -0
- package/src/components/radio-utils.ts +12 -0
- package/src/components/reka.ts +5 -0
- package/src/components/select-utils.ts +285 -6
- package/src/components/split-pane-utils.ts +65 -12
- package/src/components/table/RsTableBody.vue +217 -0
- package/src/components/table/RsTableBodyRow.vue +90 -1
- package/src/components/table/RsTableColGroup.vue +41 -0
- package/src/components/table/RsTableHeader.vue +158 -0
- package/src/components/table/RsTableHeaderFilter.vue +1 -1
- package/src/components/table/RsTableSummaryRow.vue +52 -0
- package/src/components/table/rs-table-api.ts +99 -0
- package/src/components/table/rs-table-compat-matrix.ts +71 -0
- package/src/components/table/rs-table-echarts-adapter.ts +81 -0
- package/src/components/table/rs-table-feature-host.ts +178 -0
- package/src/components/table/rs-table-grid-nav.ts +122 -0
- package/src/components/table/rs-table-header-types.ts +47 -0
- package/src/components/table/rs-table-module-registry.ts +72 -0
- package/src/components/table/rs-table-props.ts +274 -0
- package/src/components/table/rs-table-view-context.ts +258 -0
- package/src/components/table/rs-table.css +85 -7
- package/src/components/table/table-chart-utils.ts +165 -0
- package/src/components/table/table-features.ts +284 -0
- package/src/components/table/table-summary-utils.ts +194 -0
- package/src/components/table-utils.ts +452 -2
- package/src/components/tabs-utils.ts +142 -2
- package/src/components/time-picker-utils.ts +76 -3
- package/src/components/upload-utils.ts +122 -0
- package/src/components/use-rs-select.ts +436 -0
- package/src/components/virtual-list-utils.ts +15 -2
- package/src/composables/assembleRsTableApi.ts +79 -0
- package/src/composables/bindRsTableViewContext.ts +269 -0
- package/src/composables/createRsDialog.ts +357 -0
- package/src/composables/createRsTableEditEmitBridge.ts +38 -0
- package/src/composables/useRsConfig.ts +10 -3
- package/src/composables/useRsI18n.ts +16 -5
- package/src/composables/useRsLoadingBar.ts +36 -0
- package/src/composables/useRsTable.ts +134 -0
- package/src/composables/useRsTableA11y.ts +52 -0
- package/src/composables/useRsTableChartBridge.ts +79 -0
- package/src/composables/useRsTableColumnLayout.ts +320 -0
- package/src/composables/useRsTableColumnResize.ts +244 -0
- package/src/composables/useRsTableColumnVirtual.ts +180 -0
- package/src/composables/useRsTableColumns.ts +200 -0
- package/src/composables/useRsTableContextMenu.ts +257 -0
- package/src/composables/useRsTableCore.ts +256 -0
- package/src/composables/useRsTableEditActions.ts +606 -0
- package/src/composables/useRsTableEditLayer.ts +251 -0
- package/src/composables/useRsTableEngine.ts +357 -0
- package/src/composables/useRsTableGridKeyboard.ts +123 -0
- package/src/composables/useRsTableHeadless.ts +137 -0
- package/src/composables/useRsTableInteraction.ts +433 -0
- package/src/composables/useRsTableScrollHost.ts +75 -0
- package/src/composables/useRsTableScrollLayout.ts +255 -0
- package/src/composables/useRsTableSelectionSource.ts +89 -0
- package/src/composables/useRsTableShell.ts +416 -0
- package/src/composables/useRsTableShellChrome.ts +170 -0
- package/src/composables/useRsTableSummary.ts +113 -0
- package/src/composables/useRsTableViewProvide.ts +263 -0
- package/src/composables/useRsTableVirtual.ts +154 -0
- package/src/composables/useRsTabsNav.ts +4 -0
- package/src/composables/useTableEdit.ts +1 -1
- package/src/index.ts +378 -10
- package/src/locale/interpolate.ts +32 -0
- package/src/locale/messages.ts +40 -0
- package/src/styles.css +365 -56
- package/src/theme/brand.example.css +24 -2
- package/src/theme/css-token.ts +107 -0
- package/src/theme/presets.ts +4 -0
- package/src/theme/types.ts +68 -0
- package/src/components/RsTableColgroup.vue +0 -17
- package/src/components/RsTableHeaderRow.vue +0 -30
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
<script setup lang="ts">
|
|
2
|
-
import { computed, ref } from 'vue'
|
|
2
|
+
import { computed, ref, toRef, useSlots } from 'vue'
|
|
3
3
|
import type {
|
|
4
|
+
RsFormErrorRender,
|
|
5
|
+
RsFormErrorRenderContext,
|
|
4
6
|
RsFormFieldExpose,
|
|
7
|
+
RsFormFieldValidationResult,
|
|
5
8
|
RsFormGap,
|
|
6
9
|
RsFormLabelAlign,
|
|
7
10
|
RsFormLabelPosition,
|
|
@@ -9,7 +12,14 @@ import type {
|
|
|
9
12
|
RsFormSize,
|
|
10
13
|
RsFormValidationResult,
|
|
11
14
|
} from './form-utils'
|
|
12
|
-
import { cloneFormFieldValue, provideRsFormContext } from './form-utils'
|
|
15
|
+
import { cloneFormFieldValue, provideRsFormContext, resolveFieldRules } from './form-utils'
|
|
16
|
+
import type { RsFormRuleTrigger, RsFormRules, RsFormValidateMessages } from './form-rules'
|
|
17
|
+
import {
|
|
18
|
+
getByNamePath,
|
|
19
|
+
namePathKey,
|
|
20
|
+
setByNamePath,
|
|
21
|
+
type RsFormNamePath,
|
|
22
|
+
} from './form-path'
|
|
13
23
|
|
|
14
24
|
const props = withDefaults(
|
|
15
25
|
defineProps<{
|
|
@@ -20,6 +30,25 @@ const props = withDefaults(
|
|
|
20
30
|
size?: RsFormSize
|
|
21
31
|
gap?: RsFormGap
|
|
22
32
|
maxWidth?: RsFormMaxWidth
|
|
33
|
+
/**
|
|
34
|
+
* 集中声明校验规则(按字段 name 匹配)。
|
|
35
|
+
* 与字段自身 required/rule/validator 合并执行。
|
|
36
|
+
*/
|
|
37
|
+
rules?: RsFormRules
|
|
38
|
+
/**
|
|
39
|
+
* 表单数据中枢(对齐 Ant Design Form.model)。
|
|
40
|
+
* Form.Item 声明 name 后读写此对象;也可继续在控件上 v-model。
|
|
41
|
+
*/
|
|
42
|
+
model?: Record<string, unknown>
|
|
43
|
+
/** 覆盖默认校验文案模板,支持 `{label}` */
|
|
44
|
+
validateMessages?: RsFormValidateMessages
|
|
45
|
+
/** 原生 form 提交时自动跑一遍校验(默认 true) */
|
|
46
|
+
validateOnSubmit?: boolean
|
|
47
|
+
/**
|
|
48
|
+
* 自定义错误渲染(函数式)。
|
|
49
|
+
* 也可用 `#error="{ name, message, value }"` 插槽,插槽优先。
|
|
50
|
+
*/
|
|
51
|
+
errorRender?: RsFormErrorRender
|
|
23
52
|
}>(),
|
|
24
53
|
{
|
|
25
54
|
disabled: false,
|
|
@@ -29,15 +58,25 @@ const props = withDefaults(
|
|
|
29
58
|
size: 'md',
|
|
30
59
|
gap: 'md',
|
|
31
60
|
maxWidth: 'full',
|
|
61
|
+
validateOnSubmit: true,
|
|
32
62
|
},
|
|
33
63
|
)
|
|
34
64
|
|
|
65
|
+
const emit = defineEmits<{
|
|
66
|
+
submit: [event: Event]
|
|
67
|
+
validate: [result: RsFormValidationResult]
|
|
68
|
+
}>()
|
|
69
|
+
|
|
70
|
+
const slots = useSlots()
|
|
35
71
|
const fields = new Map<symbol, RsFormFieldExpose>()
|
|
36
72
|
const disabledRef = computed(() => props.disabled)
|
|
37
73
|
const labelPositionRef = computed(() => props.labelPosition)
|
|
38
74
|
const labelWidthRef = computed(() => props.labelWidth)
|
|
39
75
|
const labelAlignRef = computed(() => props.labelAlign)
|
|
40
76
|
const sizeRef = computed(() => props.size)
|
|
77
|
+
const rulesRef = toRef(props, 'rules')
|
|
78
|
+
const modelRef = toRef(props, 'model')
|
|
79
|
+
const validateMessagesRef = computed(() => props.validateMessages)
|
|
41
80
|
const initialValues = ref(new Map<symbol, unknown>())
|
|
42
81
|
|
|
43
82
|
function registerField(id: symbol, field: RsFormFieldExpose): void {
|
|
@@ -50,38 +89,153 @@ function unregisterField(id: symbol): void {
|
|
|
50
89
|
initialValues.value.delete(id)
|
|
51
90
|
}
|
|
52
91
|
|
|
92
|
+
function getFieldRules(name?: string) {
|
|
93
|
+
return resolveFieldRules(props.rules, name)
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
function getFieldValue(name: RsFormNamePath): unknown {
|
|
97
|
+
if (modelRef.value) return getByNamePath(modelRef.value, name)
|
|
98
|
+
const key = namePathKey(name)
|
|
99
|
+
const field = Array.from(fields.values()).find((item) => item.name === key)
|
|
100
|
+
return field?.getValue()
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
function setFieldValue(name: RsFormNamePath, value: unknown): void {
|
|
104
|
+
if (modelRef.value) {
|
|
105
|
+
setByNamePath(modelRef.value, name, value)
|
|
106
|
+
return
|
|
107
|
+
}
|
|
108
|
+
const key = namePathKey(name)
|
|
109
|
+
const field = Array.from(fields.values()).find((item) => item.name === key)
|
|
110
|
+
field?.setValue(value)
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
function getFieldsValue(): Record<string, unknown> {
|
|
114
|
+
if (modelRef.value) return { ...modelRef.value }
|
|
115
|
+
const values: Record<string, unknown> = {}
|
|
116
|
+
fields.forEach((field) => {
|
|
117
|
+
if (!field.name) return
|
|
118
|
+
values[field.name] = field.getValue()
|
|
119
|
+
})
|
|
120
|
+
return values
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
function setFieldsValue(values: Record<string, unknown>): void {
|
|
124
|
+
Object.entries(values).forEach(([name, value]) => {
|
|
125
|
+
setFieldValue(name, value)
|
|
126
|
+
})
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
function scrollToField(name: RsFormNamePath): void {
|
|
130
|
+
if (typeof document === 'undefined') return
|
|
131
|
+
const key = namePathKey(name)
|
|
132
|
+
const el = document.querySelector(`[data-rs-form-item="${CSS.escape(key)}"]`)
|
|
133
|
+
if (el instanceof HTMLElement) {
|
|
134
|
+
el.scrollIntoView({ block: 'nearest', behavior: 'smooth' })
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
function renderError(ctx: RsFormErrorRenderContext) {
|
|
139
|
+
if (slots.error) return slots.error(ctx)
|
|
140
|
+
return props.errorRender?.(ctx)
|
|
141
|
+
}
|
|
142
|
+
|
|
53
143
|
provideRsFormContext({
|
|
54
144
|
disabled: disabledRef,
|
|
55
145
|
labelPosition: labelPositionRef,
|
|
56
146
|
labelWidth: labelWidthRef,
|
|
57
147
|
labelAlign: labelAlignRef,
|
|
58
148
|
size: sizeRef,
|
|
149
|
+
rules: rulesRef,
|
|
150
|
+
getFieldRules,
|
|
151
|
+
renderError,
|
|
59
152
|
registerField,
|
|
60
153
|
unregisterField,
|
|
154
|
+
model: modelRef,
|
|
155
|
+
validateMessages: validateMessagesRef,
|
|
156
|
+
getFieldValue,
|
|
157
|
+
setFieldValue,
|
|
158
|
+
getFieldsValue,
|
|
61
159
|
})
|
|
62
160
|
|
|
63
|
-
|
|
161
|
+
function collectResult(
|
|
162
|
+
results: RsFormFieldValidationResult[],
|
|
163
|
+
): RsFormValidationResult {
|
|
164
|
+
const errors: Record<string, string> = {}
|
|
165
|
+
for (const result of results) {
|
|
166
|
+
if (!result.valid && result.name && result.message && !errors[result.name]) {
|
|
167
|
+
errors[result.name] = result.message
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
return {
|
|
171
|
+
valid: results.every((result) => result.valid),
|
|
172
|
+
errors,
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
/** 校验全部字段;可传 trigger 过滤规则 */
|
|
177
|
+
async function validate(trigger: RsFormRuleTrigger = 'submit'): Promise<RsFormValidationResult> {
|
|
64
178
|
const results = await Promise.all(
|
|
65
|
-
Array.from(fields.values()).map(
|
|
179
|
+
Array.from(fields.values()).map(
|
|
180
|
+
(field) => field.validate?.(trigger) ?? { valid: true, name: field.name },
|
|
181
|
+
),
|
|
66
182
|
)
|
|
67
|
-
|
|
183
|
+
const aggregated = collectResult(results)
|
|
184
|
+
emit('validate', aggregated)
|
|
185
|
+
return aggregated
|
|
68
186
|
}
|
|
69
187
|
|
|
70
|
-
|
|
71
|
-
|
|
188
|
+
/** 按 name 校验单个字段 */
|
|
189
|
+
async function validateField(
|
|
190
|
+
name: string,
|
|
191
|
+
trigger: RsFormRuleTrigger = 'submit',
|
|
192
|
+
): Promise<RsFormFieldValidationResult> {
|
|
193
|
+
const field = Array.from(fields.values()).find((item) => item.name === name)
|
|
194
|
+
if (!field) return { valid: true, name }
|
|
195
|
+
const result = (await field.validate?.(trigger)) ?? { valid: true, name }
|
|
196
|
+
return { ...result, name }
|
|
72
197
|
}
|
|
73
198
|
|
|
74
|
-
function
|
|
199
|
+
function clearValidation(names?: string | string[]): void {
|
|
200
|
+
const nameSet = names
|
|
201
|
+
? new Set(Array.isArray(names) ? names : [names])
|
|
202
|
+
: null
|
|
203
|
+
fields.forEach((field) => {
|
|
204
|
+
if (nameSet && (!field.name || !nameSet.has(field.name))) return
|
|
205
|
+
field.clearValidation?.()
|
|
206
|
+
})
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
function resetFields(names?: string | string[]): void {
|
|
210
|
+
const nameSet = names
|
|
211
|
+
? new Set(Array.isArray(names) ? names : [names])
|
|
212
|
+
: null
|
|
75
213
|
fields.forEach((field, id) => {
|
|
214
|
+
if (nameSet && (!field.name || !nameSet.has(field.name))) return
|
|
76
215
|
field.setValue(cloneFormFieldValue(initialValues.value.get(id)))
|
|
77
216
|
field.clearValidation?.()
|
|
78
217
|
})
|
|
79
218
|
}
|
|
80
219
|
|
|
220
|
+
async function onSubmit(event: Event): Promise<void> {
|
|
221
|
+
if (props.validateOnSubmit) {
|
|
222
|
+
event.preventDefault()
|
|
223
|
+
const result = await validate('submit')
|
|
224
|
+
if (!result.valid) return
|
|
225
|
+
}
|
|
226
|
+
emit('submit', event)
|
|
227
|
+
}
|
|
228
|
+
|
|
81
229
|
defineExpose({
|
|
82
230
|
validate,
|
|
231
|
+
validateField,
|
|
83
232
|
clearValidation,
|
|
84
233
|
resetFields,
|
|
234
|
+
getFieldsValue,
|
|
235
|
+
setFieldsValue,
|
|
236
|
+
getFieldValue,
|
|
237
|
+
setFieldValue,
|
|
238
|
+
scrollToField,
|
|
85
239
|
})
|
|
86
240
|
</script>
|
|
87
241
|
|
|
@@ -93,7 +247,9 @@ defineExpose({
|
|
|
93
247
|
`rs-form--max-${maxWidth}`,
|
|
94
248
|
`rs-form--label-${labelPosition}`,
|
|
95
249
|
]"
|
|
250
|
+
@submit="onSubmit"
|
|
96
251
|
>
|
|
252
|
+
<!-- 默认插槽:表单字段;#error 不在此渲染,经 Context 注入到字段错误区 -->
|
|
97
253
|
<slot />
|
|
98
254
|
</form>
|
|
99
255
|
</template>
|
|
@@ -0,0 +1,423 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import { computed, ref, useId, useSlots, watch } from 'vue'
|
|
3
|
+
import { useRsI18n } from '../composables/useRsI18n'
|
|
4
|
+
import RsVNodeHost from './RsVNodeHost.vue'
|
|
5
|
+
import RsFormItemControl from './RsFormItemControl.vue'
|
|
6
|
+
import {
|
|
7
|
+
provideRsFormItemContext,
|
|
8
|
+
useRsFormContext,
|
|
9
|
+
useRsFormField,
|
|
10
|
+
useRsFormListContext,
|
|
11
|
+
type RsFormLabelAlign,
|
|
12
|
+
type RsFormLabelPosition,
|
|
13
|
+
type RsFormValidateStatus,
|
|
14
|
+
} from './form-utils'
|
|
15
|
+
import {
|
|
16
|
+
buildLocalInputRules,
|
|
17
|
+
normalizeFormRules,
|
|
18
|
+
runFormFieldRules,
|
|
19
|
+
type RsFormRuleItem,
|
|
20
|
+
type RsFormRuleTrigger,
|
|
21
|
+
} from './form-rules'
|
|
22
|
+
import {
|
|
23
|
+
concatNamePath,
|
|
24
|
+
isIndexSegment,
|
|
25
|
+
namePathKey,
|
|
26
|
+
type RsFormNamePath,
|
|
27
|
+
} from './form-path'
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* 表单项容器:包住任意自定义控件,负责 name / rules / 错误文案。
|
|
31
|
+
* 对标 Ant Design Form.Item、Element Plus ElFormItem。
|
|
32
|
+
* 内置 RsInput / RsSelect 已自行注册;放在已声明 name 的 Item 内时不再重复注册。
|
|
33
|
+
*/
|
|
34
|
+
defineOptions({ name: 'RsFormItem' })
|
|
35
|
+
|
|
36
|
+
const model = defineModel<unknown>()
|
|
37
|
+
|
|
38
|
+
const props = withDefaults(
|
|
39
|
+
defineProps<{
|
|
40
|
+
name?: RsFormNamePath
|
|
41
|
+
label?: string
|
|
42
|
+
required?: boolean
|
|
43
|
+
rules?: RsFormRuleItem | RsFormRuleItem[]
|
|
44
|
+
invalid?: boolean
|
|
45
|
+
errorMessage?: string
|
|
46
|
+
showMessage?: boolean
|
|
47
|
+
hint?: string
|
|
48
|
+
/** 始终展示的辅助说明(错误出现时仍保留) */
|
|
49
|
+
extra?: string
|
|
50
|
+
/** 无错误时的说明;出错时被错误文案替换 */
|
|
51
|
+
help?: string
|
|
52
|
+
validateStatus?: RsFormValidateStatus
|
|
53
|
+
/** 不渲染标签与外壳,只保留控件与错误(schema 表单外置 label) */
|
|
54
|
+
noStyle?: boolean
|
|
55
|
+
/** 依赖字段变化时重新校验本字段(对齐 Ant Design dependencies) */
|
|
56
|
+
dependencies?: RsFormNamePath[]
|
|
57
|
+
labelPosition?: RsFormLabelPosition
|
|
58
|
+
}>(),
|
|
59
|
+
{
|
|
60
|
+
showMessage: true,
|
|
61
|
+
noStyle: false,
|
|
62
|
+
},
|
|
63
|
+
)
|
|
64
|
+
|
|
65
|
+
const emit = defineEmits<{
|
|
66
|
+
validate: [result: { valid: boolean; message?: string }]
|
|
67
|
+
}>()
|
|
68
|
+
|
|
69
|
+
const { t } = useRsI18n()
|
|
70
|
+
const slots = useSlots()
|
|
71
|
+
const formContext = useRsFormContext()
|
|
72
|
+
const listContext = useRsFormListContext()
|
|
73
|
+
const fieldId = useId()
|
|
74
|
+
const errorId = computed(() => `${fieldId}-error`)
|
|
75
|
+
const extraId = computed(() => `${fieldId}-extra`)
|
|
76
|
+
|
|
77
|
+
const touched = ref(false)
|
|
78
|
+
const autoInvalid = ref(false)
|
|
79
|
+
const autoMessage = ref('')
|
|
80
|
+
|
|
81
|
+
const resolvedNamePath = computed(() => {
|
|
82
|
+
if (props.name == null) return undefined
|
|
83
|
+
const own = concatNamePath(props.name)
|
|
84
|
+
if (!listContext) return own
|
|
85
|
+
return concatNamePath(listContext.prefix.value, own)
|
|
86
|
+
})
|
|
87
|
+
const nameKey = computed(() =>
|
|
88
|
+
resolvedNamePath.value?.length ? namePathKey(resolvedNamePath.value) : undefined,
|
|
89
|
+
)
|
|
90
|
+
const ownsField = computed(() => Boolean(nameKey.value))
|
|
91
|
+
|
|
92
|
+
const resolvedLabelPosition = computed(
|
|
93
|
+
() => props.labelPosition ?? formContext?.labelPosition.value ?? 'top',
|
|
94
|
+
)
|
|
95
|
+
const resolvedLabelAlign = computed<RsFormLabelAlign>(
|
|
96
|
+
() => formContext?.labelAlign.value ?? 'start',
|
|
97
|
+
)
|
|
98
|
+
const resolvedSize = computed(() => formContext?.size.value ?? 'md')
|
|
99
|
+
|
|
100
|
+
function readValue(): unknown {
|
|
101
|
+
const path = resolvedNamePath.value
|
|
102
|
+
if (formContext && path?.length && formContext.model.value) {
|
|
103
|
+
return formContext.getFieldValue(path)
|
|
104
|
+
}
|
|
105
|
+
return model.value
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
function writeValue(value: unknown): void {
|
|
109
|
+
model.value = value
|
|
110
|
+
const path = resolvedNamePath.value
|
|
111
|
+
if (formContext?.model.value && path?.length) {
|
|
112
|
+
formContext.setFieldValue(path, value)
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* 解析 dependencies / getFieldValue 路径。
|
|
118
|
+
* List 内以数字下标开头的视为相对路径([0, 'password'] → users.0.password);
|
|
119
|
+
* 其它视为表单根路径,便于 List 内依赖根字段。
|
|
120
|
+
*/
|
|
121
|
+
function resolveWatchName(name: RsFormNamePath): Array<string | number> {
|
|
122
|
+
const segs = concatNamePath(name)
|
|
123
|
+
const prefix = listContext?.prefix.value
|
|
124
|
+
if (!prefix?.length || !segs.length) return segs
|
|
125
|
+
const first = segs[0]
|
|
126
|
+
if (first !== undefined && isIndexSegment(first)) {
|
|
127
|
+
return concatNamePath(prefix, segs)
|
|
128
|
+
}
|
|
129
|
+
return segs
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
const showRequiredMark = computed(() => {
|
|
133
|
+
if (props.required) return true
|
|
134
|
+
const formRules = formContext?.getFieldRules(nameKey.value) ?? []
|
|
135
|
+
const localRules = [
|
|
136
|
+
...buildLocalInputRules({ required: props.required }),
|
|
137
|
+
...normalizeFormRules(props.rules),
|
|
138
|
+
]
|
|
139
|
+
return [...formRules, ...localRules].some((rule) => rule.required)
|
|
140
|
+
})
|
|
141
|
+
|
|
142
|
+
const displayMessage = computed(() => {
|
|
143
|
+
if (props.errorMessage) return props.errorMessage
|
|
144
|
+
if (props.showMessage && autoInvalid.value) return autoMessage.value
|
|
145
|
+
return ''
|
|
146
|
+
})
|
|
147
|
+
|
|
148
|
+
const isInvalid = computed(() => {
|
|
149
|
+
if (props.validateStatus === 'error') return true
|
|
150
|
+
if (props.validateStatus) return false
|
|
151
|
+
return props.invalid || autoInvalid.value
|
|
152
|
+
})
|
|
153
|
+
|
|
154
|
+
const mergedStatus = computed<RsFormValidateStatus>(() => {
|
|
155
|
+
if (props.validateStatus) return props.validateStatus
|
|
156
|
+
if (isInvalid.value) return 'error'
|
|
157
|
+
return ''
|
|
158
|
+
})
|
|
159
|
+
|
|
160
|
+
const describedBy = computed(() => {
|
|
161
|
+
const ids: string[] = []
|
|
162
|
+
if (displayMessage.value || props.help) ids.push(errorId.value)
|
|
163
|
+
if (props.extra) ids.push(extraId.value)
|
|
164
|
+
return ids.length ? ids.join(' ') : undefined
|
|
165
|
+
})
|
|
166
|
+
|
|
167
|
+
const errorSlotProps = computed(() => ({
|
|
168
|
+
name: nameKey.value,
|
|
169
|
+
message: displayMessage.value,
|
|
170
|
+
value: readValue(),
|
|
171
|
+
}))
|
|
172
|
+
|
|
173
|
+
const formErrorContent = computed(() => {
|
|
174
|
+
if (!displayMessage.value || !formContext?.renderError) return null
|
|
175
|
+
return formContext.renderError(errorSlotProps.value)
|
|
176
|
+
})
|
|
177
|
+
|
|
178
|
+
const fieldStyle = computed(() => {
|
|
179
|
+
if (props.noStyle || resolvedLabelPosition.value !== 'left') return undefined
|
|
180
|
+
const labelWidth = formContext?.labelWidth.value
|
|
181
|
+
if (!labelWidth) return undefined
|
|
182
|
+
return { '--rs-field-label-width': labelWidth } as Record<string, string>
|
|
183
|
+
})
|
|
184
|
+
|
|
185
|
+
const showLabel = computed(() => Boolean(props.label || slots.label) && !props.noStyle)
|
|
186
|
+
|
|
187
|
+
const controlInject = computed(() => ({
|
|
188
|
+
id: fieldId,
|
|
189
|
+
invalid: isInvalid.value,
|
|
190
|
+
showValidateMessage: false,
|
|
191
|
+
'aria-invalid': isInvalid.value || undefined,
|
|
192
|
+
'aria-describedby': describedBy.value,
|
|
193
|
+
modelValue: readValue(),
|
|
194
|
+
'onUpdate:modelValue': writeValue,
|
|
195
|
+
}))
|
|
196
|
+
|
|
197
|
+
async function runValidate(trigger: RsFormRuleTrigger = 'submit'): Promise<boolean> {
|
|
198
|
+
touched.value = true
|
|
199
|
+
const formRules = formContext?.getFieldRules(nameKey.value) ?? []
|
|
200
|
+
const localRules = [
|
|
201
|
+
...buildLocalInputRules({ required: props.required }),
|
|
202
|
+
...normalizeFormRules(props.rules),
|
|
203
|
+
]
|
|
204
|
+
const rules = [...formRules, ...localRules]
|
|
205
|
+
|
|
206
|
+
if (!rules.length) {
|
|
207
|
+
autoInvalid.value = false
|
|
208
|
+
autoMessage.value = ''
|
|
209
|
+
emit('validate', { valid: true })
|
|
210
|
+
return true
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
const result = await runFormFieldRules(readValue(), rules, {
|
|
214
|
+
trigger,
|
|
215
|
+
t,
|
|
216
|
+
name: nameKey.value,
|
|
217
|
+
label: typeof props.label === 'string' ? props.label : undefined,
|
|
218
|
+
validateMessages: formContext?.validateMessages.value,
|
|
219
|
+
getFieldValue: (name) => formContext?.getFieldValue(resolveWatchName(name)),
|
|
220
|
+
getFieldsValue: () => formContext?.getFieldsValue() ?? {},
|
|
221
|
+
})
|
|
222
|
+
autoInvalid.value = !result.valid
|
|
223
|
+
autoMessage.value = result.message ?? ''
|
|
224
|
+
emit('validate', result)
|
|
225
|
+
return result.valid
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
function setError(message: string): void {
|
|
229
|
+
autoInvalid.value = true
|
|
230
|
+
autoMessage.value = message
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
function setValue(value: unknown): void {
|
|
234
|
+
writeValue(value)
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
function clearValidation(): void {
|
|
238
|
+
touched.value = false
|
|
239
|
+
autoInvalid.value = false
|
|
240
|
+
autoMessage.value = ''
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
useRsFormField(() => {
|
|
244
|
+
if (!nameKey.value) return undefined
|
|
245
|
+
return {
|
|
246
|
+
name: nameKey.value,
|
|
247
|
+
getValue: () => readValue(),
|
|
248
|
+
setValue,
|
|
249
|
+
validate: async (trigger) => {
|
|
250
|
+
const valid = await runValidate(trigger ?? 'submit')
|
|
251
|
+
return { valid, message: autoMessage.value || undefined, name: nameKey.value }
|
|
252
|
+
},
|
|
253
|
+
clearValidation,
|
|
254
|
+
setError,
|
|
255
|
+
}
|
|
256
|
+
})
|
|
257
|
+
|
|
258
|
+
provideRsFormItemContext({
|
|
259
|
+
name: nameKey,
|
|
260
|
+
ownsField,
|
|
261
|
+
invalid: isInvalid,
|
|
262
|
+
message: displayMessage,
|
|
263
|
+
status: mergedStatus,
|
|
264
|
+
fieldId: computed(() => fieldId),
|
|
265
|
+
errorId,
|
|
266
|
+
describedBy,
|
|
267
|
+
})
|
|
268
|
+
|
|
269
|
+
watch(
|
|
270
|
+
() => readValue(),
|
|
271
|
+
() => {
|
|
272
|
+
if (touched.value) void runValidate('change')
|
|
273
|
+
},
|
|
274
|
+
)
|
|
275
|
+
|
|
276
|
+
watch(
|
|
277
|
+
() =>
|
|
278
|
+
JSON.stringify(
|
|
279
|
+
(props.dependencies ?? []).map((name) =>
|
|
280
|
+
formContext?.getFieldValue(resolveWatchName(name)),
|
|
281
|
+
),
|
|
282
|
+
),
|
|
283
|
+
(_next, prev) => {
|
|
284
|
+
if (prev === undefined) return
|
|
285
|
+
const current = readValue()
|
|
286
|
+
const hasValue =
|
|
287
|
+
current != null && !(typeof current === 'string' && current.trim() === '')
|
|
288
|
+
if (touched.value || autoInvalid.value || hasValue) {
|
|
289
|
+
void runValidate('change')
|
|
290
|
+
}
|
|
291
|
+
},
|
|
292
|
+
)
|
|
293
|
+
|
|
294
|
+
defineExpose({
|
|
295
|
+
validate: runValidate,
|
|
296
|
+
clearValidation,
|
|
297
|
+
setValue,
|
|
298
|
+
setError,
|
|
299
|
+
})
|
|
300
|
+
</script>
|
|
301
|
+
|
|
302
|
+
<template>
|
|
303
|
+
<div
|
|
304
|
+
class="rs-form-item"
|
|
305
|
+
:class="[
|
|
306
|
+
!noStyle ? 'rs-field' : undefined,
|
|
307
|
+
!noStyle ? `rs-field--label-${resolvedLabelPosition}` : undefined,
|
|
308
|
+
!noStyle && resolvedLabelPosition === 'left' && resolvedLabelAlign === 'end'
|
|
309
|
+
? 'rs-field--label-align-end'
|
|
310
|
+
: undefined,
|
|
311
|
+
mergedStatus ? `rs-form-item--${mergedStatus}` : undefined,
|
|
312
|
+
`rs-form-item--${resolvedSize}`,
|
|
313
|
+
]"
|
|
314
|
+
:style="fieldStyle"
|
|
315
|
+
:data-rs-form-item="nameKey"
|
|
316
|
+
>
|
|
317
|
+
<span v-if="showLabel" class="rs-field__label">
|
|
318
|
+
<slot name="label">
|
|
319
|
+
<label :for="fieldId">{{ label }}</label>
|
|
320
|
+
</slot>
|
|
321
|
+
<span v-if="showRequiredMark" class="rs-field__required" aria-hidden="true">*</span>
|
|
322
|
+
</span>
|
|
323
|
+
|
|
324
|
+
<div class="rs-form-item__control">
|
|
325
|
+
<RsFormItemControl :inject="controlInject">
|
|
326
|
+
<slot
|
|
327
|
+
:id="fieldId"
|
|
328
|
+
:invalid="isInvalid"
|
|
329
|
+
:message="displayMessage"
|
|
330
|
+
:field="nameKey"
|
|
331
|
+
:status="mergedStatus"
|
|
332
|
+
/>
|
|
333
|
+
</RsFormItemControl>
|
|
334
|
+
</div>
|
|
335
|
+
|
|
336
|
+
<p
|
|
337
|
+
v-if="displayMessage"
|
|
338
|
+
:id="errorId"
|
|
339
|
+
class="rs-form-item__error"
|
|
340
|
+
role="alert"
|
|
341
|
+
>
|
|
342
|
+
<slot name="error" v-bind="errorSlotProps">
|
|
343
|
+
<RsVNodeHost
|
|
344
|
+
v-if="formErrorContent !== null && formErrorContent !== undefined"
|
|
345
|
+
:content="formErrorContent"
|
|
346
|
+
/>
|
|
347
|
+
<template v-else>{{ displayMessage }}</template>
|
|
348
|
+
</slot>
|
|
349
|
+
</p>
|
|
350
|
+
<p
|
|
351
|
+
v-else-if="help"
|
|
352
|
+
:id="errorId"
|
|
353
|
+
class="rs-form-item__help"
|
|
354
|
+
>
|
|
355
|
+
{{ help }}
|
|
356
|
+
</p>
|
|
357
|
+
|
|
358
|
+
<span v-if="hint && !noStyle" class="rs-field__hint">{{ hint }}</span>
|
|
359
|
+
<span v-if="extra" :id="extraId" class="rs-form-item__extra">{{ extra }}</span>
|
|
360
|
+
</div>
|
|
361
|
+
</template>
|
|
362
|
+
|
|
363
|
+
<style scoped>
|
|
364
|
+
.rs-form-item__control {
|
|
365
|
+
width: 100%;
|
|
366
|
+
min-height: var(--rs-control-height-md);
|
|
367
|
+
min-width: 0;
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
/*
|
|
371
|
+
* 左侧标签与控件行等高、文字垂直居中。
|
|
372
|
+
* 网格仍是 align-items:start,错误文案在第 2 列,不会把 label 顶歪。
|
|
373
|
+
*/
|
|
374
|
+
.rs-field--label-left > .rs-field__label {
|
|
375
|
+
display: flex;
|
|
376
|
+
align-items: center;
|
|
377
|
+
box-sizing: border-box;
|
|
378
|
+
min-height: var(--rs-control-height-md);
|
|
379
|
+
}
|
|
380
|
+
|
|
381
|
+
.rs-form-item--ssm.rs-field--label-left > .rs-field__label,
|
|
382
|
+
.rs-form-item--ssm .rs-form-item__control {
|
|
383
|
+
min-height: var(--rs-control-height-ssm);
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
.rs-form-item--sm.rs-field--label-left > .rs-field__label,
|
|
387
|
+
.rs-form-item--sm .rs-form-item__control {
|
|
388
|
+
min-height: var(--rs-control-height-sm);
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
.rs-form-item--lg.rs-field--label-left > .rs-field__label,
|
|
392
|
+
.rs-form-item--lg .rs-form-item__control {
|
|
393
|
+
min-height: var(--rs-control-height-lg);
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
.rs-field--label-left .rs-form-item__control,
|
|
397
|
+
.rs-field--label-left .rs-form-item__error,
|
|
398
|
+
.rs-field--label-left .rs-form-item__help,
|
|
399
|
+
.rs-field--label-left .rs-form-item__extra {
|
|
400
|
+
grid-column: 2;
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
.rs-form-item__error,
|
|
404
|
+
.rs-form-item__help,
|
|
405
|
+
.rs-form-item__extra {
|
|
406
|
+
margin: 0.25rem 0 0;
|
|
407
|
+
font-size: var(--rs-font-size-xs);
|
|
408
|
+
line-height: var(--rs-line-height-tight);
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
.rs-form-item__error {
|
|
412
|
+
color: var(--rs-danger);
|
|
413
|
+
}
|
|
414
|
+
|
|
415
|
+
.rs-form-item__help,
|
|
416
|
+
.rs-form-item__extra {
|
|
417
|
+
color: var(--rs-muted);
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
.rs-form-item--warning .rs-form-item__error {
|
|
421
|
+
color: var(--rs-warning, #d48806);
|
|
422
|
+
}
|
|
423
|
+
</style>
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<script lang="ts">
|
|
2
|
+
import { defineComponent, type PropType, type VNode } from 'vue'
|
|
3
|
+
import { bindFormItemControl } from './form-item-control'
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* 将 inject 合并到默认插槽第一个子节点,供 Form.Item 注入控件 props。
|
|
7
|
+
*/
|
|
8
|
+
export default defineComponent({
|
|
9
|
+
name: 'RsFormItemControl',
|
|
10
|
+
inheritAttrs: false,
|
|
11
|
+
props: {
|
|
12
|
+
inject: {
|
|
13
|
+
type: Object as PropType<Record<string, unknown>>,
|
|
14
|
+
default: () => ({}),
|
|
15
|
+
},
|
|
16
|
+
},
|
|
17
|
+
setup(props, { slots }) {
|
|
18
|
+
return () => bindFormItemControl(slots.default?.() as VNode[] | undefined, props.inject)
|
|
19
|
+
},
|
|
20
|
+
})
|
|
21
|
+
</script>
|