@fast-form-designer/vue 0.1.1 → 0.1.2

package/README.md

@@ -239,6 +239,68 @@ interface DesignerActionContext {
 | `validate`    | `() => Promise<boolean>` | 触发表单校验 |
 | `resetFields` | `() => void`             | 重置表单字段 |
 
+### 省市区数据工具函数
+
+省市区（PCA）数据采用动态导入，仅在使用省市区组件时按需加载，减少主包体积。
+
+```typescript
+import { loadPcaData, setPcaData, getPcaOptions, type PcaNode } from '@fast-form-designer/vue'
+```
+
+#### loadPcaData
+
+动态加载内置省市区数据，返回原始数据结构。
+
+```typescript
+const loadPcaData: () => Promise<PcaNode[]>
+
+// 示例
+const pcaData = await loadPcaData()
+console.log(pcaData) // [{ code: '11', name: '北京市', children: [...] }, ...]
+```
+
+#### setPcaData
+
+注入自定义省市区数据，用于替换内置数据或在 SSR 场景下预加载。
+
+```typescript
+const setPcaData: (data: PcaNode[]) => void
+
+// 示例：使用自定义数据
+const customData: PcaNode[] = [
+  { code: '11', name: '北京市', children: [{ code: '1101', name: '市辖区', children: [...] }] }
+]
+setPcaData(customData)
+```
+
+#### getPcaOptions
+
+获取指定深度的省市区选项数据，返回格式化后的 `OptionItem[]`。
+
+```typescript
+const getPcaOptions: (depth: 1 | 2 | 3) => Promise<OptionItem[]>
+
+// depth 参数说明：
+// 1 = 仅省份
+// 2 = 省份 + 城市
+// 3 = 省份 + 城市 + 区县
+
+// 示例
+const provinceOptions = await getPcaOptions(1)    // 省份列表
+const cityOptions = await getPcaOptions(2)        // 省市两级
+const districtOptions = await getPcaOptions(3)   // 省市区三级
+```
+
+#### PcaNode 类型
+
+```typescript
+interface PcaNode {
+  code: string        // 行政区划代码
+  name: string        // 名称
+  children?: PcaNode[] // 下级区划
+}
+```
+
 ## 类型定义
 
 ### FormSchema

package/dist/index.d.ts

@@ -3,4 +3,5 @@ import FastFormDesigner from './FastFormDesigner.vue';
 import FormRenderer from './components/FormRenderer.vue';
 export { FastFormDesigner, FormRenderer };
 export * from './types';
+export { loadPcaData, setPcaData, getPcaOptions, type PcaNode } from './utils/pca';
 export default FastFormDesigner;