@chengkejie/form-page 1.0.2 → 1.2.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 (55) hide show
  1. package/README.md +57 -2
  2. package/dist/cjs/FormPage.d.ts +30 -30
  3. package/dist/cjs/FormPage.d.ts.map +1 -1
  4. package/dist/cjs/FormPage.js +792 -716
  5. package/dist/cjs/components/CompanySelect/index.d.ts +6 -6
  6. package/dist/cjs/components/CompanySelect/index.js +80 -80
  7. package/dist/cjs/components/CustomNode/index.d.ts +6 -6
  8. package/dist/cjs/components/CustomNode/index.js +12 -12
  9. package/dist/cjs/components/ExtraDatePicker/index.d.ts +7 -7
  10. package/dist/cjs/components/ExtraDatePicker/index.js +139 -139
  11. package/dist/cjs/components/Section/index.d.ts +6 -6
  12. package/dist/cjs/components/Section/index.js +32 -32
  13. package/dist/cjs/components/SelectSearch/index.d.ts +6 -6
  14. package/dist/cjs/components/SelectSearch/index.d.ts.map +1 -1
  15. package/dist/cjs/components/SelectSearch/index.js +66 -39
  16. package/dist/cjs/components/SettingDialog/index.d.ts +11 -11
  17. package/dist/cjs/components/SettingDialog/index.js +130 -130
  18. package/dist/cjs/context.d.ts +33 -33
  19. package/dist/cjs/context.js +22 -22
  20. package/dist/cjs/index.d.ts +11 -11
  21. package/dist/cjs/index.d.ts.map +1 -1
  22. package/dist/cjs/index.js +76 -76
  23. package/dist/cjs/styles/index.module.scss +21 -28
  24. package/dist/cjs/tableKeyMap.d.ts +2 -2
  25. package/dist/cjs/tableKeyMap.js +12 -12
  26. package/dist/cjs/types.d.ts +236 -207
  27. package/dist/cjs/types.d.ts.map +1 -1
  28. package/dist/cjs/types.js +4 -4
  29. package/dist/esm/FormPage.d.ts +30 -30
  30. package/dist/esm/FormPage.d.ts.map +1 -1
  31. package/dist/esm/FormPage.js +790 -714
  32. package/dist/esm/components/CompanySelect/index.d.ts +6 -6
  33. package/dist/esm/components/CompanySelect/index.js +74 -74
  34. package/dist/esm/components/CustomNode/index.d.ts +6 -6
  35. package/dist/esm/components/CustomNode/index.js +6 -6
  36. package/dist/esm/components/ExtraDatePicker/index.d.ts +7 -7
  37. package/dist/esm/components/ExtraDatePicker/index.js +132 -132
  38. package/dist/esm/components/Section/index.d.ts +6 -6
  39. package/dist/esm/components/Section/index.js +27 -27
  40. package/dist/esm/components/SelectSearch/index.d.ts +6 -6
  41. package/dist/esm/components/SelectSearch/index.d.ts.map +1 -1
  42. package/dist/esm/components/SelectSearch/index.js +60 -33
  43. package/dist/esm/components/SettingDialog/index.d.ts +11 -11
  44. package/dist/esm/components/SettingDialog/index.js +122 -122
  45. package/dist/esm/context.d.ts +33 -33
  46. package/dist/esm/context.js +13 -13
  47. package/dist/esm/index.d.ts +11 -11
  48. package/dist/esm/index.d.ts.map +1 -1
  49. package/dist/esm/index.js +8 -8
  50. package/dist/esm/styles/index.module.scss +21 -28
  51. package/dist/esm/tableKeyMap.d.ts +2 -2
  52. package/dist/esm/tableKeyMap.js +6 -6
  53. package/dist/esm/types.d.ts +236 -207
  54. package/dist/esm/types.d.ts.map +1 -1
  55. package/package.json +1 -1
package/README.md CHANGED
@@ -102,6 +102,7 @@ function App() {
102
102
  | `onReset` | `() => void` | `() => {}` | 重置按钮触发的回调(在内部清空逻辑之外额外执行) |
103
103
  | `onFieldChange` | `(name: string, value: any) => void` | `() => {}` | 任意表单字段值变化回调 |
104
104
  | `pageSizeList` | `number[]` | `[10, 20, 50, 100]` | 分页条数可选项 |
105
+ | `alignLabelWidth` | `boolean` | `true` | 标签宽度自动对齐:同一竖列(24 栅格列起点相同)的标签统一取组内最长字数宽度并右对齐。详见 [标签宽度对齐](#标签宽度对齐alignlabelwidth)。传 `false` 退回默认 `75px` 最小宽度 |
105
106
 
106
107
  > `searchFn` 返回值需符合 `ahooks` `useFusionTable` 约定:`{ data: 表格数据数组, total: 总条数 }`。
107
108
 
@@ -194,10 +195,32 @@ columns={[
194
195
  |------|------|------|------|
195
196
  | `col` | `number` | 是 | 占据的栅格列数(24 栅格制,如 `6`、`8`、`12`) |
196
197
  | `label` | `string` | 否 | 表单项标签文本 |
198
+ | `labelWidth` | `number` | 否 | 标签宽度,按「字数」计:传几渲染成几 em(`1em ≈ 1` 个全角字宽)。仅 `label` 为字符串时生效,可突破默认 `75px` 最小宽度;配置后该项不参与自动对齐分组 |
197
199
  | `textAlign` | `'left' \| 'center' \| 'right'` | 否 | 对齐方式,不传则按行内位置自动计算(行首 left / 中间 center / 行尾 right) |
198
200
  | `wrapperCol` | `object` | 否 | `Form.Item` 的 `wrapperCol` |
199
201
  | `labelCol` | `object` | 否 | `Form.Item` 的 `labelCol` |
200
202
 
203
+ ### 标签宽度对齐(alignLabelWidth)
204
+
205
+ `<FormPage alignLabelWidth>`(默认 `true`)开启自动对齐。规则:
206
+
207
+ 1. 组件模拟 24 栅格逐项摆放(放不下整项换行),得到每个条件项的**列起点偏移**(0/6/12/18…);
208
+ 2. **列起点相同的项归为同一竖列**(注意不是按 `col` 值分组——`col: 12` 的项从行首开始,起点为 0,与 `col: 6` 的行首项同组);
209
+ 3. 组内取「未单独配 `labelWidth` 的字符串标签」的最长字数(`stringWidth`:全角=1、半角两字=1,`+0.5` 缓冲,向上取整)作为该竖列统一宽度;
210
+ 4. 标签在统一宽度内**右对齐**——短标签左侧留白、右缘与组内最长标签对齐,使同一竖列的输入框起点连成一条竖线。
211
+
212
+ ```tsx
213
+ // col 6 ×4 + col 12 + col 6 + col 12 + col 6 的竖列分组:
214
+ // 起点 0 → 名称、日期、创建时间(col12)、增强日期(col12) 同组右缘对齐
215
+ // 起点 6 → 状态、月份
216
+ // 起点 12 → 类型(树)、公司、金额区间、自定义
217
+ // 起点 18 → 地区(级联)、远程搜索
218
+ <FormPage alignLabelWidth {...} /> // 传 false 退回默认 75px 最小宽度
219
+ ```
220
+
221
+ > 单独配置 `labelWidth` 的项优先用自己的宽度,且不计入组内最长值统计。
222
+ > 字数估算函数 `stringWidth(s)` 已从包内导出,可用于业务侧自行推导展示。
223
+
201
224
  ### 各类型(`type`)
202
225
 
203
226
  | `type` | 渲染控件 | 特有字段 | `customProps` 类型 |
@@ -290,7 +313,11 @@ conditionProps={[
290
313
  interface ButtonConfigProps {
291
314
  /** @deprecated 不再生效;按钮列自动占据本行剩余宽度以紧贴最右侧 */
292
315
  col?: number;
293
- buttons: Array<'submit' | 'reset' | 'export' | 'setting' | ReactNode>;
316
+ buttons: Array<string | ReactNode | { name: string; style?: 'primary' | 'ghost' }>;
317
+ /** 按钮整体风格,默认 'primary';可被单按钮配置覆盖 */
318
+ buttonStyle?: 'primary' | 'ghost';
319
+ /** 按钮级覆盖:key 为内置按钮名,优先级最高 */
320
+ buttonStyles?: Partial<Record<'submit' | 'reset' | 'export' | 'setting', { style?: 'primary' | 'ghost' }>>;
294
321
  }
295
322
  ```
296
323
 
@@ -303,12 +330,39 @@ interface ButtonConfigProps {
303
330
  | `'export'` | 导出 | 调用 `exportFn` |
304
331
  | `'setting'` | 设置 | 打开列显示/隐藏设置弹窗(依赖 `tableId`) |
305
332
 
333
+ ### 按钮风格(三级粒度)
334
+
335
+ 风格优先级:**`buttonStyles[name]` > `buttons` 内联对象 > `buttonStyle` > 默认 `primary`**
336
+
337
+ | 风格 | 视觉 | 说明 |
338
+ |------|------|------|
339
+ | `'primary'`(默认) | 搜索/导出 = 主题色实心主按钮;重置 = 白底主题橙描边幽灵按钮 | 两个主操作实心 + 重置描边 |
340
+ | `'ghost'` | 全部 = 白底 + 主题橙(`#ff7e07`)描边幽灵按钮 | 权重一致,见下图风格 |
341
+
342
+ > 默认 `'primary'` 下,「重置」按钮即白底主题橙描边样式(同 `ghost` 的 `ghostBtn` 视觉),因此示例 ② 的 `{ name: 'reset', style: 'ghost' }` 在默认风格下为冗余写法,主要用于「整体 `ghost`」时强调仍按需覆盖。
343
+
306
344
  ```tsx
345
+ // ① 整体风格:全部幽灵描边
346
+ buttonProps={{ buttons: ['submit', 'reset', 'export'], buttonStyle: 'ghost' }}
347
+
348
+ // ② 内联覆盖:整体默认,仅重置单独指定为幽灵
349
+ buttonProps={{ buttons: ['submit', { name: 'reset', style: 'ghost' }, 'export'] }}
350
+
351
+ // ③ 按钮级覆盖:整体幽灵,但搜索保持实心主按钮
352
+ buttonProps={{
353
+ buttons: ['submit', 'reset', 'export'],
354
+ buttonStyle: 'ghost',
355
+ buttonStyles: { submit: { style: 'primary' } },
356
+ }}
357
+
358
+ // ④ 混排自定义 JSX(自定义按钮不受风格控制)
307
359
  buttonProps={{
308
360
  buttons: ['submit', 'reset', <Button key="custom" onClick={...}>自定义</Button>, 'setting'],
309
361
  }}
310
362
  ```
311
363
 
364
+ > 内联对象 `{ name, style }` 的 `name` 必须是内置按钮名(`'submit' | 'reset' | 'export' | 'setting'`),否则按未知按钮渲染兜底。
365
+
312
366
  ---
313
367
 
314
368
  ## Ref 方法(FormPageRef)
@@ -498,8 +552,9 @@ export default function Page() {
498
552
  - **分页器样式**:固定 `pageSizeSelector="dropdown"`、`useFloatLayout`、显示「共 X 条」。可由 `pageSizeList` 改选项、`showPagination={false}` 关闭。
499
553
  - **列宽拖拽**:所有列自动设为 `asyncResizable`(可拖拽调宽),拖拽宽度保留在组件 state(300ms 防抖);`ref.resetWidth()` 重置为初始值。
500
554
  - **列显示/隐藏**:`tableId` 对应的列中,`dataIndex` 命中 `tbKeys`(隐藏列表)即不渲染;持久化依赖 Provider 的 `fetchTableKeys`(读取)/`onSaveTableKeys`(保存)。
501
- - **按钮列宽度**:操作按钮列自动占据本行剩余栅格宽度以紧贴最右侧;条件正好填满整行(24 栅格)时按钮独占一行。
555
+ - **按钮列宽度**:操作按钮列自动占据本行剩余栅格宽度以紧贴最右侧;剩余空间按「模拟逐项摆放后的末行实际占用」计算(非总和取模,避免 flex 提前换行导致按钮列错位);条件正好填满整行(24 栅格)时按钮独占一行。
502
556
  - **条件对齐**:条件项 `textAlign` 未显式设置时,按行内位置自动取 行首 `left` / 中间 `center` / 行尾 `right`。
557
+ - **条件间距**:条件行使用 24 栅格 + `gutter=16`(列内 padding,不影响百分比宽度与换行)。
503
558
 
504
559
  ---
505
560
 
@@ -1,31 +1,31 @@
1
- import React from 'react';
2
- import type { ConditionItem, SelectCondition, InputCondition, TreeSelectCondition, CascaderSelectCondition, DatePickerCondition, MonthPickerCondition, RangePickerCondition, SectionCondition, CompanySelectCondition, ExtraDatePickerCondition, SelectSearchCondition, CustomNodeCondition, CustomCondition, TableConfigProps, ButtonConfigProps, FormPageProps, FormPageRef } from './types';
3
- export type { FormPageProps, FormPageRef, ConditionItem, TableConfigProps, ButtonConfigProps, SelectCondition, InputCondition, TreeSelectCondition, CascaderSelectCondition, DatePickerCondition, MonthPickerCondition, RangePickerCondition, SectionCondition, CompanySelectCondition, ExtraDatePickerCondition, SelectSearchCondition, CustomNodeCondition, CustomCondition, };
4
- /**
5
- * 估算字符串在「字数」意义上的宽度(用于 alignLabelWidth 按字数对齐)。
6
- * 全角字符(中日韩、全角标点)计 1,半角字符两个计 1(最少 1)。
7
- */
8
- export declare const stringWidth: (s: string) => number;
9
- declare const _default: React.ForwardRefExoticComponent<FormPageProps & React.RefAttributes<FormPageRef>>;
10
- export default _default;
11
- /**
12
- * 条件类型的枚举常量,供外部使用时避免硬编码字符串
13
- * 与 condition 映射表中的 key 一一对应
14
- */
15
- export declare const FormPageData: {
16
- Type: {
17
- Select: string;
18
- Input: string;
19
- TreeSelect: string;
20
- DatePicker: string;
21
- MonthPicker: string;
22
- Section: string;
23
- RangePicker: string;
24
- CompanySelect: string;
25
- ExtraDatePicker: string;
26
- SelectSearch: string;
27
- CustomNode: string;
28
- cascaderSelect: string;
29
- };
30
- };
1
+ import React from 'react';
2
+ import type { ConditionItem, SelectCondition, InputCondition, TreeSelectCondition, CascaderSelectCondition, DatePickerCondition, MonthPickerCondition, RangePickerCondition, SectionCondition, CompanySelectCondition, ExtraDatePickerCondition, SelectSearchCondition, CustomNodeCondition, CustomCondition, TableConfigProps, ButtonConfigProps, ButtonItemConfig, FormPageProps, FormPageRef } from './types';
3
+ export type { FormPageProps, FormPageRef, ConditionItem, TableConfigProps, ButtonConfigProps, ButtonItemConfig, SelectCondition, InputCondition, TreeSelectCondition, CascaderSelectCondition, DatePickerCondition, MonthPickerCondition, RangePickerCondition, SectionCondition, CompanySelectCondition, ExtraDatePickerCondition, SelectSearchCondition, CustomNodeCondition, CustomCondition, };
4
+ /**
5
+ * 估算字符串在「字数」意义上的宽度(用于 alignLabelWidth 按字数对齐)。
6
+ * 全角字符(中日韩、全角标点)计 1,半角字符两个计 1(最少 1)。
7
+ */
8
+ export declare const stringWidth: (s: string) => number;
9
+ declare const _default: React.ForwardRefExoticComponent<FormPageProps & React.RefAttributes<FormPageRef>>;
10
+ export default _default;
11
+ /**
12
+ * 条件类型的枚举常量,供外部使用时避免硬编码字符串
13
+ * 与 condition 映射表中的 key 一一对应
14
+ */
15
+ export declare const FormPageData: {
16
+ Type: {
17
+ Select: string;
18
+ Input: string;
19
+ TreeSelect: string;
20
+ DatePicker: string;
21
+ MonthPicker: string;
22
+ Section: string;
23
+ RangePicker: string;
24
+ CompanySelect: string;
25
+ ExtraDatePicker: string;
26
+ SelectSearch: string;
27
+ CustomNode: string;
28
+ cascaderSelect: string;
29
+ };
30
+ };
31
31
  //# sourceMappingURL=FormPage.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"FormPage.d.ts","sourceRoot":"","sources":["../src/FormPage.tsx"],"names":[],"mappings":"AAMA,OAAO,KAA2F,MAAM,OAAO,CAAC;AAWhH,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,WAAW,EACZ,MAAM,SAAS,CAAC;AAEjB,YAAY,EACV,aAAa,EAAE,WAAW,EAAE,aAAa,EAAE,gBAAgB,EAAE,iBAAiB,EAC9E,eAAe,EAAE,cAAc,EAAE,mBAAmB,EAAE,uBAAuB,EAC7E,mBAAmB,EAAE,oBAAoB,EACzC,oBAAoB,EAAE,gBAAgB,EACtC,sBAAsB,EAAE,wBAAwB,EAAE,qBAAqB,EACvE,mBAAmB,EAAE,eAAe,GACrC,CAAC;AAIF;;;GAGG;AACH,eAAO,MAAM,WAAW,MAAO,MAAM,KAAG,MAavC,CAAC;;AAuhBF,wBAAoC;AAEpC;;;GAGG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;CAexB,CAAC"}
1
+ {"version":3,"file":"FormPage.d.ts","sourceRoot":"","sources":["../src/FormPage.tsx"],"names":[],"mappings":"AAoBA,OAAO,KAQN,MAAM,OAAO,CAAC;AAWf,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,WAAW,EACZ,MAAM,SAAS,CAAC;AAEjB,YAAY,EACV,aAAa,EACb,WAAW,EACX,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,GAChB,CAAC;AAIF;;;GAGG;AACH,eAAO,MAAM,WAAW,MAAO,MAAM,KAAG,MAavC,CAAC;;AAirBF,wBAAoC;AAEpC;;;GAGG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;CAexB,CAAC"}