@ticatec/uniface-element 5.0.0 → 5.0.2

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 (282) hide show
  1. package/README.md +29 -54
  2. package/README_CN.md +37 -57
  3. package/dist/app_layout/ClassicLayout.svelte +8 -40
  4. package/dist/app_layout/ColumnsLayout.svelte +3 -3
  5. package/dist/app_layout/HeaderLayout.svelte +4 -20
  6. package/dist/app_layout/RowsLayout.svelte +3 -3
  7. package/dist/app_layout/SidebarLayout.svelte +4 -20
  8. package/dist/base-calendar/CalendarBase.svelte +29 -6
  9. package/dist/base-calendar/CalendarBase.svelte.d.ts +4 -0
  10. package/dist/base-calendar/MonthPickupPanel.svelte +19 -6
  11. package/dist/base-calendar/MonthPickupPanel.svelte.d.ts +1 -1
  12. package/dist/base-calendar/MonthlyCalendar.svelte +18 -2
  13. package/dist/base-calendar/YearPickupPanel.svelte +24 -6
  14. package/dist/base-calendar/YearPickupPanel.svelte.d.ts +1 -1
  15. package/dist/composite/pagination_panel/PaginationPanel.svelte +2 -0
  16. package/dist/composite/transfer/Transfer.svelte +12 -6
  17. package/dist/data_display/accordion/Accordion.svelte +1 -4
  18. package/dist/data_display/card/CommonCardActionBar.svelte +31 -37
  19. package/dist/data_display/concise_data_table/Column.d.ts +6 -0
  20. package/dist/data_display/concise_data_table/ConciseListTable.svelte +4 -3
  21. package/dist/data_display/concise_data_table/DataCell.svelte +3 -3
  22. package/dist/data_display/list_box/ListBox.svelte +96 -23
  23. package/dist/data_display/list_box/ListBox.svelte.d.ts +4 -0
  24. package/dist/data_display/tree_view/TreeNodeView.svelte +25 -4
  25. package/dist/data_table/DataTable.svelte +5 -5
  26. package/dist/data_table/DataTable.svelte.d.ts +36 -16
  27. package/dist/data_table/lib/ActionsColumn.d.ts +2 -2
  28. package/dist/data_table/lib/DataColumn.d.ts +7 -1
  29. package/dist/data_table/lib/RowAction.d.ts +5 -5
  30. package/dist/data_table/lib/clickOutSide.js +6 -5
  31. package/dist/data_table/parts/FixedHeaderPanel.svelte +18 -3
  32. package/dist/data_table/parts/FixedRow.svelte +10 -1
  33. package/dist/data_table/parts/HrefCell.svelte +1 -1
  34. package/dist/data_table/parts/TableHeaderPanel.svelte +18 -2
  35. package/dist/data_table/parts/TextCell.svelte +2 -2
  36. package/dist/form/attachment_files/AttachmentEditor.svelte +20 -15
  37. package/dist/form/attachment_files/FileRender.svelte +1 -1
  38. package/dist/form/attachment_files/FileUploadBar.svelte +5 -2
  39. package/dist/form/attachment_files/FileUploadPanel.svelte +11 -73
  40. package/dist/form/cascade_options_select/CascadeOptionSelect.svelte +10 -2
  41. package/dist/form/cascade_options_select/OptionsBox.svelte +48 -2
  42. package/dist/form/checkbox/CheckBox.svelte +2 -7
  43. package/dist/form/color_picker/ColorPicker.svelte +150 -35
  44. package/dist/form/color_picker/ColorPicker.svelte.d.ts +7 -25
  45. package/dist/form/color_picker/ColorPickerPanel.svelte +23 -20
  46. package/dist/form/color_picker/ColorPickerPanel.svelte.d.ts +5 -18
  47. package/dist/form/color_picker/README.md +14 -7
  48. package/dist/form/color_picker/README_CN.md +14 -7
  49. package/dist/form/common_editor/CommonEditor.svelte +18 -4
  50. package/dist/form/common_editor/CommonPicker.svelte +14 -10
  51. package/dist/form/common_editor/CommonPopupEditor.svelte +8 -1
  52. package/dist/form/common_range_editor/CommonRangeEditor.svelte +11 -2
  53. package/dist/form/date_picker/DatePicker.svelte +1 -1
  54. package/dist/form/date_picker/DateTimePicker.svelte +1 -1
  55. package/dist/form/date_picker/ScrollBar.svelte +20 -12
  56. package/dist/form/date_picker/ScrollBar.svelte.d.ts +4 -18
  57. package/dist/form/date_range/DateRangeEditor.svelte +11 -3
  58. package/dist/form/group_box/group-check-box/GroupCheckBox.svelte +6 -1
  59. package/dist/form/group_box/group-radio-box/GroupRadioBox.svelte +6 -1
  60. package/dist/form/image-files/ImageFilesField.svelte +51 -7
  61. package/dist/form/image-files/ImagePreview.svelte +23 -9
  62. package/dist/form/image-files/ImageRender.svelte +69 -11
  63. package/dist/form/input_options_select/InputOptionsSelect.svelte +10 -2
  64. package/dist/form/lookup_editor/LookupEditor.svelte +9 -2
  65. package/dist/form/memo_editor/MemoEditor.svelte +2 -2
  66. package/dist/form/number_editor/NumberEditor.svelte +2 -2
  67. package/dist/form/options_multi_select/OptionsMultiSelect.svelte +20 -12
  68. package/dist/form/options_select/OptionsSelect.svelte +15 -6
  69. package/dist/form/options_select/OptionsSelect.svelte.d.ts +39 -17
  70. package/dist/form/prompts_text_editor/PromptsTextEditor.svelte +10 -2
  71. package/dist/form/radio_button/RadioButton.svelte +2 -8
  72. package/dist/form/switch/Switch.svelte +4 -4
  73. package/dist/form/text_editor/TextEditor.svelte +2 -2
  74. package/dist/form/unit-number-editor/UnitNumberEditor.svelte +10 -2
  75. package/dist/general/button/Button.svelte +5 -0
  76. package/dist/general/button/Button.svelte.d.ts +1 -0
  77. package/dist/general/button/IconButton.svelte +3 -1
  78. package/dist/general/button/IconButton.svelte.d.ts +1 -0
  79. package/dist/general/button/TextButton.svelte +3 -0
  80. package/dist/general/button/TextButton.svelte.d.ts +1 -0
  81. package/dist/general/icon/Icon.svelte +18 -1
  82. package/dist/general/split/Split.svelte +24 -4
  83. package/dist/general/tag/Tag.svelte +9 -1
  84. package/dist/navigation/nav_menu/MenuItem.d.ts +4 -2
  85. package/dist/navigation/nav_menu/NavigatorMenu.svelte +157 -34
  86. package/dist/navigation/nav_menu/NavigatorMenu.svelte.d.ts +2 -3
  87. package/dist/navigation/nav_menu/NavigatorMenuItem.svelte +25 -13
  88. package/dist/navigation/nav_menu/NavigatorMenuItem.svelte.d.ts +3 -3
  89. package/dist/navigation/navigator/Navigator.svelte +17 -17
  90. package/dist/navigation/page-stack/PageStack.svelte +160 -0
  91. package/dist/navigation/page-stack/PageStack.svelte.d.ts +24 -0
  92. package/dist/navigation/page-stack/PageStackContext.d.ts +25 -0
  93. package/dist/navigation/page-stack/PageStackContext.js +12 -0
  94. package/dist/navigation/page-stack/PageStackFrame.svelte +24 -0
  95. package/dist/navigation/page-stack/PageStackFrame.svelte.d.ts +11 -0
  96. package/dist/navigation/page-stack/README.md +154 -0
  97. package/dist/navigation/page-stack/README_CN.md +154 -0
  98. package/dist/navigation/page-stack/index.d.ts +6 -0
  99. package/dist/navigation/page-stack/index.js +4 -0
  100. package/dist/navigation/pagination/Pagination.svelte +114 -14
  101. package/dist/navigation/progress_step_bar/ProgressStepBlock.svelte +1 -5
  102. package/dist/navigation/tabs/Tabs.svelte +42 -10
  103. package/dist/navigation/tabs/Tabs.svelte.d.ts +2 -2
  104. package/dist/overlay/common/FloatingPanel.svelte +3 -17
  105. package/dist/overlay/common/FullscreenOverlay.svelte +27 -3
  106. package/dist/overlay/common/FullscreenOverlay.svelte.d.ts +6 -27
  107. package/dist/overlay/common/ModalPopover.svelte +18 -2
  108. package/dist/overlay/common/Popover.svelte +61 -57
  109. package/dist/overlay/common/Popover.svelte.d.ts +1 -5
  110. package/dist/overlay/common/escapeClose.d.ts +28 -0
  111. package/dist/overlay/common/escapeClose.js +47 -0
  112. package/dist/overlay/common/focusTrap.d.ts +8 -0
  113. package/dist/overlay/common/focusTrap.js +83 -0
  114. package/dist/overlay/common/mountSingleton.d.ts +27 -0
  115. package/dist/overlay/common/mountSingleton.js +45 -0
  116. package/dist/overlay/common/outsideClick.d.ts +28 -0
  117. package/dist/overlay/common/outsideClick.js +20 -0
  118. package/dist/overlay/common/scrollLock.d.ts +8 -0
  119. package/dist/overlay/common/scrollLock.js +49 -0
  120. package/dist/overlay/common/uniface-utils.js +0 -1
  121. package/dist/overlay/context-menu/ContextMenu.svelte.js +2 -15
  122. package/dist/overlay/context-menu/ContextMenuPanel.svelte +27 -3
  123. package/dist/overlay/dialog/Dialog.svelte +48 -32
  124. package/dist/overlay/dialog/DialogManager.svelte.js +7 -9
  125. package/dist/overlay/dialog/DialogWrapper.svelte +5 -2
  126. package/dist/overlay/drawer/Drawer.svelte +30 -3
  127. package/dist/overlay/indicator/Indicator.svelte.js +2 -15
  128. package/dist/overlay/indicator/IndicatorPanel.svelte +4 -1
  129. package/dist/overlay/message-box/MessageBox.svelte.js +2 -15
  130. package/dist/overlay/message-box/MessageBoxPanel.svelte +19 -3
  131. package/dist/overlay/toast/Toast.svelte.js +2 -15
  132. package/dist/overlay/toast/ToastPanel.svelte +1 -1
  133. package/dist/overlay/tooltip/Tooltip.svelte +1 -1
  134. package/dist/ticatec-uniface-web.css +128 -13
  135. package/dist/types.d.ts +4 -3
  136. package/dist/utils/prefixFilter.d.ts +3 -3
  137. package/dist/utils/prefixFilter.js +3 -5
  138. package/docs/components/README.md +133 -0
  139. package/docs/components/accordion/README.md +60 -0
  140. package/docs/components/accordion/example.svelte +7 -0
  141. package/docs/components/action-bar/README.md +114 -0
  142. package/docs/components/action-bar/example.svelte +7 -0
  143. package/docs/components/app-top-bar/README.md +60 -0
  144. package/docs/components/app-top-bar/example.svelte +9 -0
  145. package/docs/components/attachment-files/README.md +332 -0
  146. package/docs/components/attachment-files/example.svelte +16 -0
  147. package/docs/components/box/README.md +63 -0
  148. package/docs/components/box/example.svelte +10 -0
  149. package/docs/components/breadcrumbs/README.md +86 -0
  150. package/docs/components/breadcrumbs/example.svelte +11 -0
  151. package/docs/components/button/README.md +103 -0
  152. package/docs/components/button/example.svelte +10 -0
  153. package/docs/components/card/README.md +113 -0
  154. package/docs/components/card/example.svelte +10 -0
  155. package/docs/components/cascade-options-select/README.md +162 -0
  156. package/docs/components/cascade-options-select/example.svelte +18 -0
  157. package/docs/components/checkbox/README.md +103 -0
  158. package/docs/components/checkbox/example.svelte +15 -0
  159. package/docs/components/classic-layout/README.md +76 -0
  160. package/docs/components/classic-layout/example.svelte +16 -0
  161. package/docs/components/color-picker/README.md +132 -0
  162. package/docs/components/color-picker/example.svelte +16 -0
  163. package/docs/components/columns-layout/README.md +70 -0
  164. package/docs/components/columns-layout/example.svelte +12 -0
  165. package/docs/components/common-dialog/README.md +109 -0
  166. package/docs/components/common-dialog/example.svelte +12 -0
  167. package/docs/components/concise-data-table/README.md +307 -0
  168. package/docs/components/concise-data-table/example.svelte +16 -0
  169. package/docs/components/context-menu/README.md +99 -0
  170. package/docs/components/context-menu/example.svelte +10 -0
  171. package/docs/components/criteria-field/README.md +69 -0
  172. package/docs/components/criteria-field/example.svelte +9 -0
  173. package/docs/components/data-table/README.md +365 -0
  174. package/docs/components/data-table/example.svelte +23 -0
  175. package/docs/components/date-picker/README.md +136 -0
  176. package/docs/components/date-picker/example.svelte +16 -0
  177. package/docs/components/date-range/README.md +122 -0
  178. package/docs/components/date-range/example.svelte +15 -0
  179. package/docs/components/date-time-picker/README.md +142 -0
  180. package/docs/components/date-time-picker/example.svelte +16 -0
  181. package/docs/components/dialog/README.md +174 -0
  182. package/docs/components/dialog/example.svelte +13 -0
  183. package/docs/components/dialog-board/README.md +41 -0
  184. package/docs/components/dialog-board/example.svelte +5 -0
  185. package/docs/components/drawer/README.md +70 -0
  186. package/docs/components/drawer/example.svelte +12 -0
  187. package/docs/components/flex-form/README.md +55 -0
  188. package/docs/components/flex-form/example.svelte +7 -0
  189. package/docs/components/flex-row-form/README.md +56 -0
  190. package/docs/components/flex-row-form/example.svelte +7 -0
  191. package/docs/components/form-field/README.md +84 -0
  192. package/docs/components/form-field/example.svelte +10 -0
  193. package/docs/components/full-screen-overlay/README.md +66 -0
  194. package/docs/components/full-screen-overlay/example.svelte +11 -0
  195. package/docs/components/grid-form/README.md +75 -0
  196. package/docs/components/grid-form/example.svelte +9 -0
  197. package/docs/components/group-check-box/README.md +147 -0
  198. package/docs/components/group-check-box/example.svelte +21 -0
  199. package/docs/components/group-radio-box/README.md +144 -0
  200. package/docs/components/group-radio-box/example.svelte +21 -0
  201. package/docs/components/header-layout/README.md +65 -0
  202. package/docs/components/header-layout/example.svelte +12 -0
  203. package/docs/components/icon/README.md +87 -0
  204. package/docs/components/icon/example.svelte +9 -0
  205. package/docs/components/icon-button/README.md +91 -0
  206. package/docs/components/icon-button/example.svelte +10 -0
  207. package/docs/components/image-files/README.md +174 -0
  208. package/docs/components/image-files/example.svelte +19 -0
  209. package/docs/components/indicator/README.md +53 -0
  210. package/docs/components/indicator/example.svelte +14 -0
  211. package/docs/components/input-options-select/README.md +163 -0
  212. package/docs/components/input-options-select/example.svelte +16 -0
  213. package/docs/components/list-box/ListItem.svelte +14 -0
  214. package/docs/components/list-box/README.md +221 -0
  215. package/docs/components/list-box/example.svelte +61 -0
  216. package/docs/components/lookup-editor/README.md +137 -0
  217. package/docs/components/lookup-editor/example.svelte +16 -0
  218. package/docs/components/memo-editor/README.md +143 -0
  219. package/docs/components/memo-editor/example.svelte +16 -0
  220. package/docs/components/message-box/README.md +68 -0
  221. package/docs/components/message-box/example.svelte +10 -0
  222. package/docs/components/navigator/README.md +75 -0
  223. package/docs/components/navigator/example.svelte +13 -0
  224. package/docs/components/navigator-menu/README.md +113 -0
  225. package/docs/components/navigator-menu/example.svelte +10 -0
  226. package/docs/components/number-editor/README.md +144 -0
  227. package/docs/components/number-editor/example.svelte +16 -0
  228. package/docs/components/number-range/README.md +116 -0
  229. package/docs/components/number-range/example.svelte +15 -0
  230. package/docs/components/options-multi-select/README.md +161 -0
  231. package/docs/components/options-multi-select/example.svelte +20 -0
  232. package/docs/components/options-select/README.md +160 -0
  233. package/docs/components/options-select/example.svelte +21 -0
  234. package/docs/components/page/README.md +77 -0
  235. package/docs/components/page/example.svelte +10 -0
  236. package/docs/components/pagination/README.md +88 -0
  237. package/docs/components/pagination/example.svelte +10 -0
  238. package/docs/components/pagination-panel/README.md +120 -0
  239. package/docs/components/pagination-panel/example.svelte +16 -0
  240. package/docs/components/popup-hint/README.md +44 -0
  241. package/docs/components/popup-hint/example.svelte +5 -0
  242. package/docs/components/progress-bar/README.md +64 -0
  243. package/docs/components/progress-bar/example.svelte +8 -0
  244. package/docs/components/progress-step-bar/README.md +93 -0
  245. package/docs/components/progress-step-bar/example.svelte +7 -0
  246. package/docs/components/prompts-text-editor/README.md +146 -0
  247. package/docs/components/prompts-text-editor/example.svelte +17 -0
  248. package/docs/components/radio-button/README.md +121 -0
  249. package/docs/components/radio-button/example.svelte +18 -0
  250. package/docs/components/rows-layout/README.md +70 -0
  251. package/docs/components/rows-layout/example.svelte +12 -0
  252. package/docs/components/search-box/README.md +136 -0
  253. package/docs/components/search-box/example.svelte +16 -0
  254. package/docs/components/separator/README.md +44 -0
  255. package/docs/components/separator/example.svelte +7 -0
  256. package/docs/components/sidebar-layout/README.md +65 -0
  257. package/docs/components/sidebar-layout/example.svelte +12 -0
  258. package/docs/components/split/README.md +48 -0
  259. package/docs/components/split/example.svelte +8 -0
  260. package/docs/components/switch/README.md +77 -0
  261. package/docs/components/switch/example.svelte +11 -0
  262. package/docs/components/tabs/README.md +127 -0
  263. package/docs/components/tabs/example.svelte +22 -0
  264. package/docs/components/tag/README.md +63 -0
  265. package/docs/components/tag/example.svelte +8 -0
  266. package/docs/components/text-button/README.md +90 -0
  267. package/docs/components/text-button/example.svelte +9 -0
  268. package/docs/components/text-editor/README.md +147 -0
  269. package/docs/components/text-editor/example.svelte +16 -0
  270. package/docs/components/time-editor/README.md +130 -0
  271. package/docs/components/time-editor/example.svelte +16 -0
  272. package/docs/components/toast/README.md +52 -0
  273. package/docs/components/toast/example.svelte +9 -0
  274. package/docs/components/tooltip/README.md +44 -0
  275. package/docs/components/tooltip/example.svelte +5 -0
  276. package/docs/components/transfer/README.md +109 -0
  277. package/docs/components/transfer/example.svelte +13 -0
  278. package/docs/components/tree-view/README.md +163 -0
  279. package/docs/components/tree-view/example.svelte +26 -0
  280. package/docs/components/unit-number-editor/README.md +192 -0
  281. package/docs/components/unit-number-editor/example.svelte +18 -0
  282. package/package.json +15 -7
@@ -0,0 +1,56 @@
1
+ # FlexRowForm
2
+
3
+ 布局组件。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 按行组织字段并支持弹性宽度的表单布局。
8
+
9
+ ## 适用场景
10
+
11
+ - 查询条件行和紧凑编辑行
12
+ - 需要一行多个字段并自适应剩余空间
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import FlexRowForm from '@ticatec/uniface-element/FlexRowForm';
18
+ ```
19
+
20
+ ## 属性
21
+
22
+ | 属性 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
23
+ | --- | --- | --- | --- | --- | --- | --- |
24
+ | `class` | 否 | `string` | 否 | `undefined` | 否 | 附加到组件根元素的 CSS class。 |
25
+ | `style` | 否 | `string` | 否 | `''` | 否 | 附加到组件根元素的内联样式。 |
26
+ | `theme` | 否 | `string` | 否 | `undefined` | 否 | 组件主题标识,通常通过 `data-theme` 选择对应 CSS 变量。 |
27
+ | `children` | 是 | `Snippet` | 否 | `undefined` | 否 | Svelte Snippet 子内容,用于自定义组件主体。 |
28
+
29
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
30
+
31
+ ## 重要属性说明
32
+
33
+ ### `children`
34
+
35
+ Svelte Snippet 子内容,用于自定义组件主体。
36
+
37
+ - 类型:`Snippet`
38
+ - 默认值:`undefined`
39
+ - 示例写法:`children={children}`
40
+
41
+ ## 示例
42
+
43
+ 完整示例见 [example.svelte](./example.svelte)。
44
+ ```svelte
45
+ <script lang="ts">
46
+ import FlexRowForm from '@ticatec/uniface-element/FlexRowForm';
47
+ </script>
48
+
49
+ <FlexRowForm>
50
+ <div>在这里放置子内容</div>
51
+ </FlexRowForm>
52
+ ```
53
+
54
+ ## 源码
55
+
56
+ - `src/lib/layouts/form_panel/flex_row_form/FormContainer.svelte`
@@ -0,0 +1,7 @@
1
+ <script lang="ts">
2
+ import FlexRowForm from '@ticatec/uniface-element/FlexRowForm';
3
+ </script>
4
+
5
+ <FlexRowForm>
6
+ <div>在这里放置子内容</div>
7
+ </FlexRowForm>
@@ -0,0 +1,84 @@
1
+ # FormField
2
+
3
+ 布局组件。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 为输入控件提供标签、提示和错误区域的标准字段容器。
8
+
9
+ ## 适用场景
10
+
11
+ - 编辑表单中的单个字段
12
+ - 统一标签宽度、必填标记和校验信息
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import FormField from '@ticatec/uniface-element/FormField';
18
+ ```
19
+
20
+ ## 属性
21
+
22
+ | 属性 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
23
+ | --- | --- | --- | --- | --- | --- | --- |
24
+ | `style` | 否 | `string` | 否 | `undefined` | 否 | 附加到组件根元素的内联样式。 |
25
+ | `theme` | 否 | `string` | 否 | `undefined` | 否 | 组件主题标识,通常通过 `data-theme` 选择对应 CSS 变量。 |
26
+ | `label` | 是 | `string` | 是 | `—` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
27
+ | `label$style` | 否 | `string` | 否 | `undefined` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
28
+ | `labelSuffix` | 否 | `string` | 否 | `':'` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
29
+ | `label$alignment` | 否 | `'center' \| 'top'` | 否 | `'center'` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
30
+ | `autoHeight` | 否 | `boolean` | 否 | `undefined` | 否 | 高度配置;字符串可以使用 px、rem、% 等 CSS 单位。 |
31
+ | `required` | 否 | `boolean` | 否 | `false` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
32
+ | `layout` | 否 | `FieldLayout` | 否 | `getLayoutMode()` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
33
+ | `class` | 否 | `string` | 否 | `undefined` | 否 | 附加到组件根元素的 CSS class。 |
34
+ | `children` | 是 | `Snippet` | 是 | `—` | 否 | Svelte Snippet 子内容,用于自定义组件主体。 |
35
+
36
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
37
+
38
+ ## 重要属性说明
39
+
40
+ ### `label`
41
+
42
+ 可选配置,具体取值范围和数据结构见类型列。
43
+
44
+ - 类型:`string`
45
+ - 默认值:`—`
46
+ - 示例写法:`label="示例标签"`
47
+
48
+ ### `children`
49
+
50
+ Svelte Snippet 子内容,用于自定义组件主体。
51
+
52
+ - 类型:`Snippet`
53
+ - 默认值:`—`
54
+ - 示例写法:`children={children}`
55
+
56
+ ## 相关类型定义
57
+
58
+ 以下定义帮助理解复杂属性的数据结构;其中部分辅助类型属于内部实现,不一定是独立导出入口。
59
+
60
+ ### `FieldLayout`
61
+
62
+ ```ts
63
+ export type FieldLayout = 'vertical' | 'horizontal';
64
+ ```
65
+
66
+ ## 示例
67
+
68
+ 完整示例见 [example.svelte](./example.svelte)。
69
+ ```svelte
70
+ <script lang="ts">
71
+ import FormField from '@ticatec/uniface-element/FormField';
72
+ </script>
73
+
74
+ <FormField
75
+ label="示例标签"
76
+ autoHeight={true}
77
+ >
78
+ <div>在这里放置子内容</div>
79
+ </FormField>
80
+ ```
81
+
82
+ ## 源码
83
+
84
+ - `src/lib/layouts/form_field/FormField.svelte`
@@ -0,0 +1,10 @@
1
+ <script lang="ts">
2
+ import FormField from '@ticatec/uniface-element/FormField';
3
+ </script>
4
+
5
+ <FormField
6
+ label="示例标签"
7
+ autoHeight={true}
8
+ >
9
+ <div>在这里放置子内容</div>
10
+ </FormField>
@@ -0,0 +1,66 @@
1
+ # FullScreenOverlay
2
+
3
+ 浮层与弹窗组件。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 覆盖整个视口的全屏浮层容器。
8
+
9
+ ## 适用场景
10
+
11
+ - 全屏加载、预览和阻断式操作
12
+ - 需要暂时隔离底层页面交互
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import FullScreenOverlay from '@ticatec/uniface-element/FullScreenOverlay';
18
+ ```
19
+
20
+ ## 属性
21
+
22
+ | 属性 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
23
+ | --- | --- | --- | --- | --- | --- | --- |
24
+ | `visible` | 是 | `boolean` | 否 | `$bindable(false)` | 是 | 控制组件是否显示,通常使用 `bind:visible` 管理打开和关闭。 |
25
+ | `children` | 是 | `Snippet` | 否 | `undefined` | 否 | Svelte Snippet 子内容,用于自定义组件主体。 |
26
+
27
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
28
+
29
+ ## 重要属性说明
30
+
31
+ ### `visible`
32
+
33
+ 控制组件是否显示,通常使用 `bind:visible` 管理打开和关闭。
34
+
35
+ - 类型:`boolean`
36
+ - 默认值:`$bindable(false)`
37
+ - 推荐写法:`bind:visible`
38
+
39
+ ### `children`
40
+
41
+ Svelte Snippet 子内容,用于自定义组件主体。
42
+
43
+ - 类型:`Snippet`
44
+ - 默认值:`undefined`
45
+ - 示例写法:`children={children}`
46
+
47
+ ## 示例
48
+
49
+ 完整示例见 [example.svelte](./example.svelte)。
50
+ ```svelte
51
+ <script lang="ts">
52
+ import FullScreenOverlay from '@ticatec/uniface-element/FullScreenOverlay';
53
+ let visible = $state<any>(false);
54
+ </script>
55
+
56
+ <FullScreenOverlay
57
+ bind:visible
58
+ >
59
+ <div>在这里放置子内容</div>
60
+ </FullScreenOverlay>
61
+ <p>当前状态:{JSON.stringify({visible})}</p>
62
+ ```
63
+
64
+ ## 源码
65
+
66
+ - `src/lib/overlay/common/FullscreenOverlay.svelte`
@@ -0,0 +1,11 @@
1
+ <script lang="ts">
2
+ import FullScreenOverlay from '@ticatec/uniface-element/FullScreenOverlay';
3
+ let visible = $state<any>(false);
4
+ </script>
5
+
6
+ <FullScreenOverlay
7
+ bind:visible
8
+ >
9
+ <div>在这里放置子内容</div>
10
+ </FullScreenOverlay>
11
+ <p>当前状态:{JSON.stringify({visible})}</p>
@@ -0,0 +1,75 @@
1
+ # GridForm
2
+
3
+ 布局组件。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 使用 CSS Grid 精确排列字段的表单容器。
8
+
9
+ ## 适用场景
10
+
11
+ - 列数固定的复杂编辑表单
12
+ - 需要字段跨列、对齐和稳定网格结构
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import GridForm from '@ticatec/uniface-element/GridForm';
18
+ ```
19
+
20
+ ## 属性
21
+
22
+ | 属性 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
23
+ | --- | --- | --- | --- | --- | --- | --- |
24
+ | `style` | 否 | `string` | 否 | `''` | 否 | 附加到组件根元素的内联样式。 |
25
+ | `columns` | 是 | `number` | 否 | `6` | 否 | 表格列定义,控制字段、标题、宽度、格式化、链接和自定义渲染。 |
26
+ | `variant` | 是 | `string` | 否 | `undefined` | 否 | 视觉样式变体,可选值见类型列。 |
27
+ | `theme` | 否 | `string` | 否 | `undefined` | 否 | 组件主题标识,通常通过 `data-theme` 选择对应 CSS 变量。 |
28
+ | `children` | 是 | `Snippet<[string \| undefined, string \| undefined]>` | 否 | `undefined` | 否 | Svelte Snippet 子内容,用于自定义组件主体。 |
29
+
30
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
31
+
32
+ ## 重要属性说明
33
+
34
+ ### `columns`
35
+
36
+ 表格列定义,控制字段、标题、宽度、格式化、链接和自定义渲染。
37
+
38
+ - 类型:`number`
39
+ - 默认值:`6`
40
+ - 示例写法:`columns={1}`
41
+
42
+ ### `variant`
43
+
44
+ 视觉样式变体,可选值见类型列。
45
+
46
+ - 类型:`string`
47
+ - 默认值:`undefined`
48
+ - 示例写法:`variant="示例"`
49
+
50
+ ### `children`
51
+
52
+ Svelte Snippet 子内容,用于自定义组件主体。
53
+
54
+ - 类型:`Snippet<[string | undefined, string | undefined]>`
55
+ - 默认值:`undefined`
56
+ - 示例写法:`children={children}`
57
+
58
+ ## 示例
59
+
60
+ 完整示例见 [example.svelte](./example.svelte)。
61
+ ```svelte
62
+ <script lang="ts">
63
+ import GridForm from '@ticatec/uniface-element/GridForm';
64
+ </script>
65
+
66
+ <GridForm
67
+ variant="示例"
68
+ >
69
+ <div>在这里放置子内容</div>
70
+ </GridForm>
71
+ ```
72
+
73
+ ## 源码
74
+
75
+ - `src/lib/layouts/form_panel/grid_form/GridForm.svelte`
@@ -0,0 +1,9 @@
1
+ <script lang="ts">
2
+ import GridForm from '@ticatec/uniface-element/GridForm';
3
+ </script>
4
+
5
+ <GridForm
6
+ variant="示例"
7
+ >
8
+ <div>在这里放置子内容</div>
9
+ </GridForm>
@@ -0,0 +1,147 @@
1
+ # GroupCheckBox
2
+
3
+ 表单组件。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 以成组方式展示多个可同时选择的复选项。
8
+
9
+ ## 适用场景
10
+
11
+ - 权限、标签和兴趣多选
12
+ - 选项较少且需要直接平铺展示
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import GroupCheckBox from '@ticatec/uniface-element/GroupCheckBox';
18
+ ```
19
+
20
+ ## 属性
21
+
22
+ | 属性 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
23
+ | --- | --- | --- | --- | --- | --- | --- |
24
+ | `disabled` | 是 | `boolean` | 否 | `false` | 否 | 禁用交互。禁用后通常不可聚焦、不可修改,也不会触发变更操作。 |
25
+ | `readonly` | 是 | `boolean` | 否 | `false` | 否 | 只读状态。保留内容展示,但阻止用户修改。 |
26
+ | `style` | 否 | `string` | 否 | `""` | 否 | 附加到组件根元素的内联样式。 |
27
+ | `error` | 否 | `string` | 否 | `undefined` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
28
+ | `tooltip` | 否 | `string` | 否 | `undefined` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
29
+ | `value` | 是 | `string \| number` | 是 | `$bindable()` | 是 | 组件的核心值。支持绑定时建议使用 `bind:value`,外部修改会同步到组件。 |
30
+ | `bitBase` | 否 | `boolean` | 否 | `false` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
31
+ | `options` | 是 | `Array<OptionItem>` | 是 | `—` | 否 | 可选项数据源;通常配合 `keyField` 与 `textField` 指定值字段和显示字段。 |
32
+ | `keyField` | 否 | `string` | 否 | `"code"` | 否 | 数据项中作为唯一值或选中值的字段名。 |
33
+ | `textField` | 否 | `string` | 否 | `"text"` | 否 | 数据项中用于界面显示的文本字段名。 |
34
+ | `delimiter` | 否 | `string` | 否 | `';'` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
35
+ | `itemStyle` | 否 | `string` | 否 | `''` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
36
+ | `disabledOptions` | 否 | `Array<string>` | 否 | `[]` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
37
+ | `hideOptions` | 否 | `Array<string>` | 否 | `[]` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
38
+ | `variant` | 是 | `EditorVariant` | 否 | `undefined` | 否 | 视觉样式变体,可选值:`""`(默认)、`plain`、`outlined`、`filled`;具体含义见组件说明。 |
39
+ | `compact` | 否 | `boolean` | 否 | `false` | 否 | 启用紧凑尺寸,减少组件高度和内边距。 |
40
+ | `class` | 否 | `string` | 否 | `''` | 否 | 附加到组件根元素的 CSS class。 |
41
+ | `onchange` | 是 | `(value: any) => void` | 否 | `undefined` | 否 | 用户完成值变更时调用;编程式赋值是否触发请以组件行为说明为准。 |
42
+ | `onblur` | 否 | `(e: FocusEvent) => void` | 否 | `undefined` | 否 | 组件失去焦点时调用。 |
43
+ | `onfocus` | 否 | `(e: FocusEvent) => void` | 否 | `undefined` | 否 | 组件获得焦点时调用。 |
44
+
45
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
46
+
47
+ ## 重要属性说明
48
+
49
+ ### `disabled`
50
+
51
+ 禁用交互。禁用后通常不可聚焦、不可修改,也不会触发变更操作。
52
+
53
+ - 类型:`boolean`
54
+ - 默认值:`false`
55
+ - 示例写法:`disabled={false}`
56
+
57
+ ### `readonly`
58
+
59
+ 只读状态。保留内容展示,但阻止用户修改。
60
+
61
+ - 类型:`boolean`
62
+ - 默认值:`false`
63
+ - 示例写法:`readonly={false}`
64
+
65
+ ### `value`
66
+
67
+ 组件的核心值。支持绑定时建议使用 `bind:value`,外部修改会同步到组件。
68
+
69
+ - 类型:`string | number`
70
+ - 默认值:`$bindable()`
71
+ - 推荐写法:`bind:value`
72
+
73
+ ### `options`
74
+
75
+ 可选项数据源;通常配合 `keyField` 与 `textField` 指定值字段和显示字段。
76
+
77
+ - 类型:`Array<OptionItem>`
78
+ - 默认值:`—`
79
+ - 示例写法:`options={[
80
+ {code: 'dev', text: '研发部'},
81
+ {code: 'product', text: '产品部'}
82
+ ]}`
83
+
84
+ ### `variant`
85
+
86
+ 视觉样式变体,可选值:`""`(默认)、`plain`、`outlined`、`filled`;具体含义见组件说明。
87
+
88
+ - 类型:`EditorVariant`
89
+ - 默认值:`undefined`
90
+ - 示例写法:`variant="plain"`
91
+
92
+ ### `onchange`
93
+
94
+ 用户完成值变更时调用;编程式赋值是否触发请以组件行为说明为准。
95
+
96
+ - 类型:`(value: any) => void`
97
+ - 默认值:`undefined`
98
+ - 示例写法:`onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}`
99
+
100
+ ## 组件实例方法
101
+
102
+ 通过 `bind:this` 获取组件实例后调用。
103
+
104
+ | 方法 | 类型 | 说明 |
105
+ | --- | --- | --- |
106
+ | `focus()` | `() => void` | 导出 focus 方法 |
107
+
108
+ ## 相关类型定义
109
+
110
+ 以下定义帮助理解复杂属性的数据结构;其中部分辅助类型属于内部实现,不一定是独立导出入口。
111
+
112
+ ### `EditorVariant`
113
+
114
+ ```ts
115
+ export type EditorVariant = '' | 'plain' | 'outlined' | 'filled';
116
+ ```
117
+
118
+ ## 示例
119
+
120
+ 完整示例见 [example.svelte](./example.svelte)。
121
+ ```svelte
122
+ <script lang="ts">
123
+ import GroupCheckBox from '@ticatec/uniface-element/GroupCheckBox';
124
+ let value = $state<any>("示例值");
125
+ </script>
126
+
127
+ <GroupCheckBox
128
+ bind:value
129
+ options={[
130
+ {code: 'dev', text: '研发部'},
131
+ {code: 'product', text: '产品部'}
132
+ ]}
133
+ onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}
134
+ onblur={async (...args: any[]) => { console.log('onblur', ...args); return true; }}
135
+ keyField="code"
136
+ textField="text"
137
+ variant="plain"
138
+ disabled={false}
139
+ readonly={false}
140
+ compact={true}
141
+ />
142
+ <p>当前状态:{JSON.stringify({value})}</p>
143
+ ```
144
+
145
+ ## 源码
146
+
147
+ - `src/lib/form/group_box/group-check-box/GroupCheckBox.svelte`
@@ -0,0 +1,21 @@
1
+ <script lang="ts">
2
+ import GroupCheckBox from '@ticatec/uniface-element/GroupCheckBox';
3
+ let value = $state<any>("示例值");
4
+ </script>
5
+
6
+ <GroupCheckBox
7
+ bind:value
8
+ options={[
9
+ {code: 'dev', text: '研发部'},
10
+ {code: 'product', text: '产品部'}
11
+ ]}
12
+ onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}
13
+ onblur={async (...args: any[]) => { console.log('onblur', ...args); return true; }}
14
+ keyField="code"
15
+ textField="text"
16
+ variant="plain"
17
+ disabled={false}
18
+ readonly={false}
19
+ compact={true}
20
+ />
21
+ <p>当前状态:{JSON.stringify({value})}</p>
@@ -0,0 +1,144 @@
1
+ # GroupRadioBox
2
+
3
+ 表单组件。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 以成组方式展示互斥的单选项。
8
+
9
+ ## 适用场景
10
+
11
+ - 状态、类别和策略单选
12
+ - 选项较少且希望无需展开下拉菜单
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import GroupRadioBox from '@ticatec/uniface-element/GroupRadioBox';
18
+ ```
19
+
20
+ ## 属性
21
+
22
+ | 属性 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
23
+ | --- | --- | --- | --- | --- | --- | --- |
24
+ | `disabled` | 是 | `boolean` | 否 | `false` | 否 | 禁用交互。禁用后通常不可聚焦、不可修改,也不会触发变更操作。 |
25
+ | `readonly` | 是 | `boolean` | 否 | `false` | 否 | 只读状态。保留内容展示,但阻止用户修改。 |
26
+ | `style` | 否 | `string` | 否 | `""` | 否 | 附加到组件根元素的内联样式。 |
27
+ | `tooltip` | 否 | `string` | 否 | `undefined` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
28
+ | `error` | 否 | `string` | 否 | `undefined` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
29
+ | `value` | 是 | `any` | 是 | `$bindable()` | 是 | 组件的核心值。支持绑定时建议使用 `bind:value`,外部修改会同步到组件。 |
30
+ | `options` | 是 | `Array<OptionItem>` | 是 | `—` | 否 | 可选项数据源;通常配合 `keyField` 与 `textField` 指定值字段和显示字段。 |
31
+ | `keyField` | 否 | `string` | 否 | `"code"` | 否 | 数据项中作为唯一值或选中值的字段名。 |
32
+ | `textField` | 否 | `string` | 否 | `"text"` | 否 | 数据项中用于界面显示的文本字段名。 |
33
+ | `itemStyle` | 否 | `string` | 否 | `''` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
34
+ | `disabledOptions` | 否 | `Array<string>` | 否 | `[]` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
35
+ | `variant` | 是 | `EditorVariant` | 否 | `undefined` | 否 | 视觉样式变体,可选值:`""`(默认)、`plain`、`outlined`、`filled`;具体含义见组件说明。 |
36
+ | `compact` | 否 | `boolean` | 否 | `false` | 否 | 启用紧凑尺寸,减少组件高度和内边距。 |
37
+ | `class` | 否 | `string` | 否 | `''` | 否 | 附加到组件根元素的 CSS class。 |
38
+ | `onchange` | 是 | `(value: any) => void` | 否 | `undefined` | 否 | 用户完成值变更时调用;编程式赋值是否触发请以组件行为说明为准。 |
39
+ | `onblur` | 否 | `(e: FocusEvent) => void` | 否 | `undefined` | 否 | 组件失去焦点时调用。 |
40
+ | `onfocus` | 否 | `(e: FocusEvent) => void` | 否 | `undefined` | 否 | 组件获得焦点时调用。 |
41
+
42
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
43
+
44
+ ## 重要属性说明
45
+
46
+ ### `disabled`
47
+
48
+ 禁用交互。禁用后通常不可聚焦、不可修改,也不会触发变更操作。
49
+
50
+ - 类型:`boolean`
51
+ - 默认值:`false`
52
+ - 示例写法:`disabled={false}`
53
+
54
+ ### `readonly`
55
+
56
+ 只读状态。保留内容展示,但阻止用户修改。
57
+
58
+ - 类型:`boolean`
59
+ - 默认值:`false`
60
+ - 示例写法:`readonly={false}`
61
+
62
+ ### `value`
63
+
64
+ 组件的核心值。支持绑定时建议使用 `bind:value`,外部修改会同步到组件。
65
+
66
+ - 类型:`any`
67
+ - 默认值:`$bindable()`
68
+ - 推荐写法:`bind:value`
69
+
70
+ ### `options`
71
+
72
+ 可选项数据源;通常配合 `keyField` 与 `textField` 指定值字段和显示字段。
73
+
74
+ - 类型:`Array<OptionItem>`
75
+ - 默认值:`—`
76
+ - 示例写法:`options={[
77
+ {code: 'dev', text: '研发部'},
78
+ {code: 'product', text: '产品部'}
79
+ ]}`
80
+
81
+ ### `variant`
82
+
83
+ 视觉样式变体,可选值:`""`(默认)、`plain`、`outlined`、`filled`;具体含义见组件说明。
84
+
85
+ - 类型:`EditorVariant`
86
+ - 默认值:`undefined`
87
+ - 示例写法:`variant="plain"`
88
+
89
+ ### `onchange`
90
+
91
+ 用户完成值变更时调用;编程式赋值是否触发请以组件行为说明为准。
92
+
93
+ - 类型:`(value: any) => void`
94
+ - 默认值:`undefined`
95
+ - 示例写法:`onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}`
96
+
97
+ ## 组件实例方法
98
+
99
+ 通过 `bind:this` 获取组件实例后调用。
100
+
101
+ | 方法 | 类型 | 说明 |
102
+ | --- | --- | --- |
103
+ | `focus()` | `() => void` | 导出 focus 方法 |
104
+
105
+ ## 相关类型定义
106
+
107
+ 以下定义帮助理解复杂属性的数据结构;其中部分辅助类型属于内部实现,不一定是独立导出入口。
108
+
109
+ ### `EditorVariant`
110
+
111
+ ```ts
112
+ export type EditorVariant = '' | 'plain' | 'outlined' | 'filled';
113
+ ```
114
+
115
+ ## 示例
116
+
117
+ 完整示例见 [example.svelte](./example.svelte)。
118
+ ```svelte
119
+ <script lang="ts">
120
+ import GroupRadioBox from '@ticatec/uniface-element/GroupRadioBox';
121
+ let value = $state<any>();
122
+ </script>
123
+
124
+ <GroupRadioBox
125
+ bind:value
126
+ options={[
127
+ {code: 'dev', text: '研发部'},
128
+ {code: 'product', text: '产品部'}
129
+ ]}
130
+ onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}
131
+ onblur={async (...args: any[]) => { console.log('onblur', ...args); return true; }}
132
+ keyField="code"
133
+ textField="text"
134
+ variant="plain"
135
+ disabled={false}
136
+ readonly={false}
137
+ compact={true}
138
+ />
139
+ <p>当前状态:{JSON.stringify({value})}</p>
140
+ ```
141
+
142
+ ## 源码
143
+
144
+ - `src/lib/form/group_box/group-radio-box/GroupRadioBox.svelte`
@@ -0,0 +1,21 @@
1
+ <script lang="ts">
2
+ import GroupRadioBox from '@ticatec/uniface-element/GroupRadioBox';
3
+ let value = $state<any>();
4
+ </script>
5
+
6
+ <GroupRadioBox
7
+ bind:value
8
+ options={[
9
+ {code: 'dev', text: '研发部'},
10
+ {code: 'product', text: '产品部'}
11
+ ]}
12
+ onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}
13
+ onblur={async (...args: any[]) => { console.log('onblur', ...args); return true; }}
14
+ keyField="code"
15
+ textField="text"
16
+ variant="plain"
17
+ disabled={false}
18
+ readonly={false}
19
+ compact={true}
20
+ />
21
+ <p>当前状态:{JSON.stringify({value})}</p>