@ticatec/uniface-element 5.0.1 → 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 (255) hide show
  1. package/README.md +29 -54
  2. package/README_CN.md +37 -57
  3. package/dist/base-calendar/CalendarBase.svelte +29 -6
  4. package/dist/base-calendar/CalendarBase.svelte.d.ts +4 -0
  5. package/dist/base-calendar/MonthPickupPanel.svelte +19 -6
  6. package/dist/base-calendar/MonthPickupPanel.svelte.d.ts +1 -1
  7. package/dist/base-calendar/MonthlyCalendar.svelte +18 -2
  8. package/dist/base-calendar/YearPickupPanel.svelte +24 -6
  9. package/dist/base-calendar/YearPickupPanel.svelte.d.ts +1 -1
  10. package/dist/composite/pagination_panel/PaginationPanel.svelte +2 -0
  11. package/dist/data_display/card/CommonCardActionBar.svelte +34 -14
  12. package/dist/data_display/concise_data_table/Column.d.ts +6 -0
  13. package/dist/data_display/concise_data_table/ConciseListTable.svelte +4 -3
  14. package/dist/data_display/concise_data_table/DataCell.svelte +3 -3
  15. package/dist/data_display/list_box/ListBox.svelte +90 -15
  16. package/dist/data_display/list_box/ListBox.svelte.d.ts +4 -0
  17. package/dist/data_display/tree_view/TreeNodeView.svelte +25 -4
  18. package/dist/data_table/DataTable.svelte +5 -5
  19. package/dist/data_table/DataTable.svelte.d.ts +36 -16
  20. package/dist/data_table/lib/ActionsColumn.d.ts +2 -2
  21. package/dist/data_table/lib/DataColumn.d.ts +7 -1
  22. package/dist/data_table/lib/RowAction.d.ts +5 -5
  23. package/dist/data_table/parts/FixedHeaderPanel.svelte +18 -3
  24. package/dist/data_table/parts/FixedRow.svelte +10 -1
  25. package/dist/data_table/parts/HrefCell.svelte +1 -1
  26. package/dist/data_table/parts/TableHeaderPanel.svelte +18 -2
  27. package/dist/data_table/parts/TextCell.svelte +2 -2
  28. package/dist/form/attachment_files/AttachmentEditor.svelte +9 -9
  29. package/dist/form/attachment_files/FileRender.svelte +1 -1
  30. package/dist/form/attachment_files/FileUploadPanel.svelte +5 -1
  31. package/dist/form/cascade_options_select/CascadeOptionSelect.svelte +10 -2
  32. package/dist/form/cascade_options_select/OptionsBox.svelte +48 -2
  33. package/dist/form/color_picker/ColorPickerPanel.svelte +23 -20
  34. package/dist/form/color_picker/ColorPickerPanel.svelte.d.ts +5 -18
  35. package/dist/form/common_editor/CommonEditor.svelte +18 -4
  36. package/dist/form/common_editor/CommonPicker.svelte +11 -4
  37. package/dist/form/common_editor/CommonPopupEditor.svelte +8 -1
  38. package/dist/form/common_range_editor/CommonRangeEditor.svelte +11 -2
  39. package/dist/form/date_picker/DatePicker.svelte +1 -1
  40. package/dist/form/date_picker/DateTimePicker.svelte +1 -1
  41. package/dist/form/date_picker/ScrollBar.svelte +20 -12
  42. package/dist/form/date_picker/ScrollBar.svelte.d.ts +4 -18
  43. package/dist/form/date_range/DateRangeEditor.svelte +11 -3
  44. package/dist/form/group_box/group-check-box/GroupCheckBox.svelte +6 -1
  45. package/dist/form/group_box/group-radio-box/GroupRadioBox.svelte +6 -1
  46. package/dist/form/image-files/ImageFilesField.svelte +51 -7
  47. package/dist/form/image-files/ImagePreview.svelte +8 -2
  48. package/dist/form/image-files/ImageRender.svelte +69 -11
  49. package/dist/form/input_options_select/InputOptionsSelect.svelte +10 -2
  50. package/dist/form/lookup_editor/LookupEditor.svelte +9 -2
  51. package/dist/form/options_multi_select/OptionsMultiSelect.svelte +19 -3
  52. package/dist/form/options_select/OptionsSelect.svelte +15 -6
  53. package/dist/form/options_select/OptionsSelect.svelte.d.ts +39 -17
  54. package/dist/form/prompts_text_editor/PromptsTextEditor.svelte +10 -2
  55. package/dist/form/switch/Switch.svelte +4 -4
  56. package/dist/form/unit-number-editor/UnitNumberEditor.svelte +10 -2
  57. package/dist/general/button/Button.svelte +3 -0
  58. package/dist/general/button/Button.svelte.d.ts +1 -0
  59. package/dist/general/button/IconButton.svelte +3 -1
  60. package/dist/general/button/IconButton.svelte.d.ts +1 -0
  61. package/dist/general/button/TextButton.svelte +3 -0
  62. package/dist/general/button/TextButton.svelte.d.ts +1 -0
  63. package/dist/general/icon/Icon.svelte +18 -1
  64. package/dist/general/tag/Tag.svelte +9 -1
  65. package/dist/navigation/nav_menu/NavigatorMenu.svelte +2 -2
  66. package/dist/navigation/nav_menu/NavigatorMenuItem.svelte +10 -1
  67. package/dist/navigation/navigator/Navigator.svelte +17 -17
  68. package/dist/navigation/page-stack/PageStack.svelte +160 -0
  69. package/dist/navigation/page-stack/PageStack.svelte.d.ts +24 -0
  70. package/dist/navigation/page-stack/PageStackContext.d.ts +25 -0
  71. package/dist/navigation/page-stack/PageStackContext.js +12 -0
  72. package/dist/navigation/page-stack/PageStackFrame.svelte +24 -0
  73. package/dist/navigation/page-stack/PageStackFrame.svelte.d.ts +11 -0
  74. package/dist/navigation/page-stack/README.md +154 -0
  75. package/dist/navigation/page-stack/README_CN.md +154 -0
  76. package/dist/navigation/page-stack/index.d.ts +6 -0
  77. package/dist/navigation/page-stack/index.js +4 -0
  78. package/dist/navigation/pagination/Pagination.svelte +114 -14
  79. package/dist/navigation/tabs/Tabs.svelte +42 -10
  80. package/dist/navigation/tabs/Tabs.svelte.d.ts +2 -2
  81. package/dist/overlay/common/FloatingPanel.svelte +3 -11
  82. package/dist/overlay/common/FullscreenOverlay.svelte +27 -3
  83. package/dist/overlay/common/FullscreenOverlay.svelte.d.ts +6 -27
  84. package/dist/overlay/common/ModalPopover.svelte +18 -2
  85. package/dist/overlay/common/Popover.svelte +56 -57
  86. package/dist/overlay/common/Popover.svelte.d.ts +1 -5
  87. package/dist/overlay/common/escapeClose.d.ts +28 -0
  88. package/dist/overlay/common/escapeClose.js +47 -0
  89. package/dist/overlay/common/focusTrap.d.ts +8 -0
  90. package/dist/overlay/common/focusTrap.js +83 -0
  91. package/dist/overlay/common/mountSingleton.d.ts +27 -0
  92. package/dist/overlay/common/mountSingleton.js +45 -0
  93. package/dist/overlay/common/outsideClick.d.ts +28 -0
  94. package/dist/overlay/common/outsideClick.js +20 -0
  95. package/dist/overlay/common/scrollLock.d.ts +8 -0
  96. package/dist/overlay/common/scrollLock.js +49 -0
  97. package/dist/overlay/context-menu/ContextMenu.svelte.js +2 -15
  98. package/dist/overlay/context-menu/ContextMenuPanel.svelte +13 -1
  99. package/dist/overlay/dialog/Dialog.svelte +46 -29
  100. package/dist/overlay/dialog/DialogManager.svelte.js +7 -9
  101. package/dist/overlay/drawer/Drawer.svelte +30 -3
  102. package/dist/overlay/indicator/Indicator.svelte.js +2 -15
  103. package/dist/overlay/indicator/IndicatorPanel.svelte +4 -1
  104. package/dist/overlay/message-box/MessageBox.svelte.js +2 -15
  105. package/dist/overlay/message-box/MessageBoxPanel.svelte +19 -3
  106. package/dist/overlay/toast/Toast.svelte.js +2 -15
  107. package/dist/overlay/toast/ToastPanel.svelte +1 -1
  108. package/dist/overlay/tooltip/Tooltip.svelte +1 -1
  109. package/dist/ticatec-uniface-web.css +102 -7
  110. package/dist/types.d.ts +4 -3
  111. package/docs/components/README.md +133 -0
  112. package/docs/components/accordion/README.md +60 -0
  113. package/docs/components/accordion/example.svelte +7 -0
  114. package/docs/components/action-bar/README.md +114 -0
  115. package/docs/components/action-bar/example.svelte +7 -0
  116. package/docs/components/app-top-bar/README.md +60 -0
  117. package/docs/components/app-top-bar/example.svelte +9 -0
  118. package/docs/components/attachment-files/README.md +332 -0
  119. package/docs/components/attachment-files/example.svelte +16 -0
  120. package/docs/components/box/README.md +63 -0
  121. package/docs/components/box/example.svelte +10 -0
  122. package/docs/components/breadcrumbs/README.md +86 -0
  123. package/docs/components/breadcrumbs/example.svelte +11 -0
  124. package/docs/components/button/README.md +103 -0
  125. package/docs/components/button/example.svelte +10 -0
  126. package/docs/components/card/README.md +113 -0
  127. package/docs/components/card/example.svelte +10 -0
  128. package/docs/components/cascade-options-select/README.md +162 -0
  129. package/docs/components/cascade-options-select/example.svelte +18 -0
  130. package/docs/components/checkbox/README.md +103 -0
  131. package/docs/components/checkbox/example.svelte +15 -0
  132. package/docs/components/classic-layout/README.md +76 -0
  133. package/docs/components/classic-layout/example.svelte +16 -0
  134. package/docs/components/color-picker/README.md +132 -0
  135. package/docs/components/color-picker/example.svelte +16 -0
  136. package/docs/components/columns-layout/README.md +70 -0
  137. package/docs/components/columns-layout/example.svelte +12 -0
  138. package/docs/components/common-dialog/README.md +109 -0
  139. package/docs/components/common-dialog/example.svelte +12 -0
  140. package/docs/components/concise-data-table/README.md +307 -0
  141. package/docs/components/concise-data-table/example.svelte +16 -0
  142. package/docs/components/context-menu/README.md +99 -0
  143. package/docs/components/context-menu/example.svelte +10 -0
  144. package/docs/components/criteria-field/README.md +69 -0
  145. package/docs/components/criteria-field/example.svelte +9 -0
  146. package/docs/components/data-table/README.md +365 -0
  147. package/docs/components/data-table/example.svelte +23 -0
  148. package/docs/components/date-picker/README.md +136 -0
  149. package/docs/components/date-picker/example.svelte +16 -0
  150. package/docs/components/date-range/README.md +122 -0
  151. package/docs/components/date-range/example.svelte +15 -0
  152. package/docs/components/date-time-picker/README.md +142 -0
  153. package/docs/components/date-time-picker/example.svelte +16 -0
  154. package/docs/components/dialog/README.md +174 -0
  155. package/docs/components/dialog/example.svelte +13 -0
  156. package/docs/components/dialog-board/README.md +41 -0
  157. package/docs/components/dialog-board/example.svelte +5 -0
  158. package/docs/components/drawer/README.md +70 -0
  159. package/docs/components/drawer/example.svelte +12 -0
  160. package/docs/components/flex-form/README.md +55 -0
  161. package/docs/components/flex-form/example.svelte +7 -0
  162. package/docs/components/flex-row-form/README.md +56 -0
  163. package/docs/components/flex-row-form/example.svelte +7 -0
  164. package/docs/components/form-field/README.md +84 -0
  165. package/docs/components/form-field/example.svelte +10 -0
  166. package/docs/components/full-screen-overlay/README.md +66 -0
  167. package/docs/components/full-screen-overlay/example.svelte +11 -0
  168. package/docs/components/grid-form/README.md +75 -0
  169. package/docs/components/grid-form/example.svelte +9 -0
  170. package/docs/components/group-check-box/README.md +147 -0
  171. package/docs/components/group-check-box/example.svelte +21 -0
  172. package/docs/components/group-radio-box/README.md +144 -0
  173. package/docs/components/group-radio-box/example.svelte +21 -0
  174. package/docs/components/header-layout/README.md +65 -0
  175. package/docs/components/header-layout/example.svelte +12 -0
  176. package/docs/components/icon/README.md +87 -0
  177. package/docs/components/icon/example.svelte +9 -0
  178. package/docs/components/icon-button/README.md +91 -0
  179. package/docs/components/icon-button/example.svelte +10 -0
  180. package/docs/components/image-files/README.md +174 -0
  181. package/docs/components/image-files/example.svelte +19 -0
  182. package/docs/components/indicator/README.md +53 -0
  183. package/docs/components/indicator/example.svelte +14 -0
  184. package/docs/components/input-options-select/README.md +163 -0
  185. package/docs/components/input-options-select/example.svelte +16 -0
  186. package/docs/components/list-box/ListItem.svelte +14 -0
  187. package/docs/components/list-box/README.md +221 -0
  188. package/docs/components/list-box/example.svelte +61 -0
  189. package/docs/components/lookup-editor/README.md +137 -0
  190. package/docs/components/lookup-editor/example.svelte +16 -0
  191. package/docs/components/memo-editor/README.md +143 -0
  192. package/docs/components/memo-editor/example.svelte +16 -0
  193. package/docs/components/message-box/README.md +68 -0
  194. package/docs/components/message-box/example.svelte +10 -0
  195. package/docs/components/navigator/README.md +75 -0
  196. package/docs/components/navigator/example.svelte +13 -0
  197. package/docs/components/navigator-menu/README.md +113 -0
  198. package/docs/components/navigator-menu/example.svelte +10 -0
  199. package/docs/components/number-editor/README.md +144 -0
  200. package/docs/components/number-editor/example.svelte +16 -0
  201. package/docs/components/number-range/README.md +116 -0
  202. package/docs/components/number-range/example.svelte +15 -0
  203. package/docs/components/options-multi-select/README.md +161 -0
  204. package/docs/components/options-multi-select/example.svelte +20 -0
  205. package/docs/components/options-select/README.md +160 -0
  206. package/docs/components/options-select/example.svelte +21 -0
  207. package/docs/components/page/README.md +77 -0
  208. package/docs/components/page/example.svelte +10 -0
  209. package/docs/components/pagination/README.md +88 -0
  210. package/docs/components/pagination/example.svelte +10 -0
  211. package/docs/components/pagination-panel/README.md +120 -0
  212. package/docs/components/pagination-panel/example.svelte +16 -0
  213. package/docs/components/popup-hint/README.md +44 -0
  214. package/docs/components/popup-hint/example.svelte +5 -0
  215. package/docs/components/progress-bar/README.md +64 -0
  216. package/docs/components/progress-bar/example.svelte +8 -0
  217. package/docs/components/progress-step-bar/README.md +93 -0
  218. package/docs/components/progress-step-bar/example.svelte +7 -0
  219. package/docs/components/prompts-text-editor/README.md +146 -0
  220. package/docs/components/prompts-text-editor/example.svelte +17 -0
  221. package/docs/components/radio-button/README.md +121 -0
  222. package/docs/components/radio-button/example.svelte +18 -0
  223. package/docs/components/rows-layout/README.md +70 -0
  224. package/docs/components/rows-layout/example.svelte +12 -0
  225. package/docs/components/search-box/README.md +136 -0
  226. package/docs/components/search-box/example.svelte +16 -0
  227. package/docs/components/separator/README.md +44 -0
  228. package/docs/components/separator/example.svelte +7 -0
  229. package/docs/components/sidebar-layout/README.md +65 -0
  230. package/docs/components/sidebar-layout/example.svelte +12 -0
  231. package/docs/components/split/README.md +48 -0
  232. package/docs/components/split/example.svelte +8 -0
  233. package/docs/components/switch/README.md +77 -0
  234. package/docs/components/switch/example.svelte +11 -0
  235. package/docs/components/tabs/README.md +127 -0
  236. package/docs/components/tabs/example.svelte +22 -0
  237. package/docs/components/tag/README.md +63 -0
  238. package/docs/components/tag/example.svelte +8 -0
  239. package/docs/components/text-button/README.md +90 -0
  240. package/docs/components/text-button/example.svelte +9 -0
  241. package/docs/components/text-editor/README.md +147 -0
  242. package/docs/components/text-editor/example.svelte +16 -0
  243. package/docs/components/time-editor/README.md +130 -0
  244. package/docs/components/time-editor/example.svelte +16 -0
  245. package/docs/components/toast/README.md +52 -0
  246. package/docs/components/toast/example.svelte +9 -0
  247. package/docs/components/tooltip/README.md +44 -0
  248. package/docs/components/tooltip/example.svelte +5 -0
  249. package/docs/components/transfer/README.md +109 -0
  250. package/docs/components/transfer/example.svelte +13 -0
  251. package/docs/components/tree-view/README.md +163 -0
  252. package/docs/components/tree-view/example.svelte +26 -0
  253. package/docs/components/unit-number-editor/README.md +192 -0
  254. package/docs/components/unit-number-editor/example.svelte +18 -0
  255. package/package.json +15 -7
@@ -0,0 +1,63 @@
1
+ # Tag
2
+
3
+ 通用组件。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 以紧凑标签展示分类、状态或可删除项。
8
+
9
+ ## 适用场景
10
+
11
+ - 状态徽标、筛选条件和已选项
12
+ - 需要颜色区分或点击删除的小块信息
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import Tag from '@ticatec/uniface-element/Tag';
18
+ ```
19
+
20
+ ## 属性
21
+
22
+ | 属性 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
23
+ | --- | --- | --- | --- | --- | --- | --- |
24
+ | `size` | 否 | `'big' \| 'middle' \| 'small'` | 否 | `'middle'` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
25
+ | `variant` | 是 | `'borderless' \| 'border' \| 'round'` | 否 | `'border'` | 否 | 视觉样式变体,可选值:`borderless`、`border`、`round`;具体含义见组件说明。 |
26
+ | `removable` | 否 | `boolean` | 否 | `true` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
27
+ | `theme` | 否 | `string` | 否 | `undefined` | 否 | 组件主题标识,通常通过 `data-theme` 选择对应 CSS 变量。 |
28
+ | `data` | 否 | `any` | 否 | `undefined` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
29
+ | `text` | 否 | `string` | 否 | `undefined` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
30
+ | `style` | 否 | `string` | 否 | `undefined` | 否 | 附加到组件根元素的内联样式。 |
31
+ | `class` | 否 | `string` | 否 | `undefined` | 否 | 附加到组件根元素的 CSS class。 |
32
+ | `ondelete` | 否 | `(data?: any)=>void` | 否 | `undefined` | 否 | 事件或行为回调;参数与返回值以类型签名为准。 |
33
+ | `color` | 否 | `string` | 否 | `undefined` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
34
+
35
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
36
+
37
+ ## 重要属性说明
38
+
39
+ ### `variant`
40
+
41
+ 视觉样式变体,可选值:`borderless`、`border`、`round`;具体含义见组件说明。
42
+
43
+ - 类型:`'borderless' | 'border' | 'round'`
44
+ - 默认值:`'border'`
45
+ - 示例写法:`variant="borderless"`
46
+
47
+ ## 示例
48
+
49
+ 完整示例见 [example.svelte](./example.svelte)。
50
+ ```svelte
51
+ <script lang="ts">
52
+ import Tag from '@ticatec/uniface-element/Tag';
53
+ </script>
54
+
55
+ <Tag
56
+ ondelete={async (...args: any[]) => { console.log('ondelete', ...args); return true; }}
57
+ variant="borderless"
58
+ />
59
+ ```
60
+
61
+ ## 源码
62
+
63
+ - `src/lib/general/tag/Tag.svelte`
@@ -0,0 +1,8 @@
1
+ <script lang="ts">
2
+ import Tag from '@ticatec/uniface-element/Tag';
3
+ </script>
4
+
5
+ <Tag
6
+ ondelete={async (...args: any[]) => { console.log('ondelete', ...args); return true; }}
7
+ variant="borderless"
8
+ />
@@ -0,0 +1,90 @@
1
+ # TextButton
2
+
3
+ 通用组件。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 弱化边框和背景的文字操作按钮。
8
+
9
+ ## 适用场景
10
+
11
+ - 表格行操作、链接式命令和次要操作
12
+ - 不希望抢占主要按钮视觉层级
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import TextButton from '@ticatec/uniface-element/TextButton';
18
+ ```
19
+
20
+ ## 属性
21
+
22
+ | 属性 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
23
+ | --- | --- | --- | --- | --- | --- | --- |
24
+ | `disabled` | 是 | `boolean` | 否 | `false` | 否 | 禁用交互。禁用后通常不可聚焦、不可修改,也不会触发变更操作。 |
25
+ | `size` | 否 | `ButtonSize` | 否 | `'medium'` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
26
+ | `label` | 否 | `string` | 否 | `''` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
27
+ | `type` | 否 | `ButtonType` | 否 | `'default'` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
28
+ | `htmlType` | 否 | `'button' \| 'submit' \| 'reset'` | 否 | `'button'` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
29
+ | `onclick` | 是 | `(event: MouseEvent) => void` | 否 | `undefined` | 否 | 用户点击组件时调用,参数通常为 MouseEvent。 |
30
+ | `style` | 否 | `string` | 否 | `''` | 否 | 附加到组件根元素的内联样式。 |
31
+ | `theme` | 否 | `string` | 否 | `undefined` | 否 | 组件主题标识,通常通过 `data-theme` 选择对应 CSS 变量。 |
32
+ | `tooltip` | 否 | `string` | 否 | `undefined` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
33
+ | `children` | 是 | `Snippet` | 否 | `undefined` | 否 | Svelte Snippet 子内容,用于自定义组件主体。 |
34
+
35
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
36
+
37
+ ## 重要属性说明
38
+
39
+ ### `disabled`
40
+
41
+ 禁用交互。禁用后通常不可聚焦、不可修改,也不会触发变更操作。
42
+
43
+ - 类型:`boolean`
44
+ - 默认值:`false`
45
+ - 示例写法:`disabled={false}`
46
+
47
+ ### `onclick`
48
+
49
+ 用户点击组件时调用,参数通常为 MouseEvent。
50
+
51
+ - 类型:`(event: MouseEvent) => void`
52
+ - 默认值:`undefined`
53
+ - 示例写法:`onclick={async (...args: any[]) => { console.log('onclick', ...args); return true; }}`
54
+
55
+ ### `children`
56
+
57
+ Svelte Snippet 子内容,用于自定义组件主体。
58
+
59
+ - 类型:`Snippet`
60
+ - 默认值:`undefined`
61
+ - 示例写法:`children={children}`
62
+
63
+ ## 相关类型定义
64
+
65
+ 以下定义帮助理解复杂属性的数据结构;其中部分辅助类型属于内部实现,不一定是独立导出入口。
66
+
67
+ ### `ButtonType`
68
+
69
+ ```ts
70
+ export type ButtonType = 'default' | 'primary' | 'secondary' | 'third' | 'forth';
71
+ ```
72
+
73
+ ## 示例
74
+
75
+ 完整示例见 [example.svelte](./example.svelte)。
76
+ ```svelte
77
+ <script lang="ts">
78
+ import TextButton from '@ticatec/uniface-element/TextButton';
79
+ </script>
80
+
81
+ <TextButton
82
+ onclick={async (...args: any[]) => { console.log('onclick', ...args); return true; }}
83
+ label="示例标签"
84
+ disabled={false}
85
+ />
86
+ ```
87
+
88
+ ## 源码
89
+
90
+ - `src/lib/general/button/TextButton.svelte`
@@ -0,0 +1,9 @@
1
+ <script lang="ts">
2
+ import TextButton from '@ticatec/uniface-element/TextButton';
3
+ </script>
4
+
5
+ <TextButton
6
+ onclick={async (...args: any[]) => { console.log('onclick', ...args); return true; }}
7
+ label="示例标签"
8
+ disabled={false}
9
+ />
@@ -0,0 +1,147 @@
1
+ # TextEditor
2
+
3
+ 表单组件。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 标准单行文本输入编辑器。
8
+
9
+ ## 适用场景
10
+
11
+ - 姓名、编码、标题和普通文本字段
12
+ - 需要前后缀、图标、大小写或校验状态
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import TextEditor from '@ticatec/uniface-element/TextEditor';
18
+ ```
19
+
20
+ ## 属性
21
+
22
+ | 属性 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
23
+ | --- | --- | --- | --- | --- | --- | --- |
24
+ | `theme` | 否 | `string` | 否 | `undefined` | 否 | 主题样式名称,用于切换组件外观主题 |
25
+ | `tooltip` | 否 | `string` | 否 | `undefined` | 否 | 悬停提示信息,鼠标悬浮在字段上时显示 |
26
+ | `error` | 否 | `string` | 否 | `undefined` | 否 | 错误信息,用于在字段下方展示校验错误提示 |
27
+ | `disabled` | 是 | `boolean` | 否 | `false` | 否 | 是否禁用该字段,禁用后字段不可编辑且不响应交互 |
28
+ | `readonly` | 是 | `boolean` | 否 | `false` | 否 | 是否只读,只读状态下字段不可编辑但可聚焦和复制 |
29
+ | `compact` | 否 | `boolean` | 否 | `false` | 否 | 是否启用紧凑模式,紧凑模式下字段内部间距更小 |
30
+ | `variant` | 是 | `EditorVariant` | 否 | `undefined` | 否 | 编辑器外观样式变体 |
31
+ | `placeholder` | 是 | `string` | 否 | `undefined` | 否 | 占位提示文本,字段值为空时在输入区域内展示 |
32
+ | `style` | 否 | `string` | 否 | `undefined` | 否 | 自定义内联样式,会应用到字段根容器上 |
33
+ | `onfocus` | 否 | `(event: FocusEvent) => void` | 否 | `undefined` | 否 | 字段获得焦点时触发的回调 |
34
+ | `onblur` | 否 | `(event: FocusEvent) => void` | 否 | `undefined` | 否 | 字段失去焦点时触发的回调 |
35
+ | `onchange` | 是 | `(value?: any) => void` | 否 | `undefined` | 否 | 字段值发生变化时触发的回调 |
36
+ | `prefix` | 否 | `string` | 否 | `undefined` | 否 | 字段前缀文本,展示在输入区域前方 |
37
+ | `suffix` | 否 | `string` | 否 | `undefined` | 否 | 字段后缀文本,展示在输入区域后方 |
38
+ | `leadingIcon` | 否 | `Snippet` | 否 | `undefined` | 否 | 前置图标片段,渲染在输入区域前方,优先级高于 prefix |
39
+ | `trailingIcon` | 否 | `Snippet` | 否 | `undefined` | 否 | 后置图标片段,渲染在输入区域后方,优先级高于 suffix |
40
+ | `onkeydown` | 否 | `(event: KeyboardEvent) => void` | 否 | `undefined` | 否 | 事件或行为回调;参数与返回值以类型签名为准。 |
41
+ | `onkeyup` | 否 | `(event: KeyboardEvent) => void` | 否 | `undefined` | 否 | 事件或行为回调;参数与返回值以类型签名为准。 |
42
+ | `onkeypress` | 否 | `(event: KeyboardEvent) => void` | 否 | `undefined` | 否 | 事件或行为回调;参数与返回值以类型签名为准。 |
43
+ | `caseMode` | 否 | `CaseMode` | 否 | `undefined` | 否 | 大小写模式 |
44
+ | `value` | 是 | `string` | 否 | `$bindable()` | 是 | 组件的核心值。支持绑定时建议使用 `bind:value`,外部修改会同步到组件。 |
45
+ | `input\$*` | 否 | `any` | 否 | `透传` | 否 | 匹配此前缀的属性会透传给内部元素。 |
46
+
47
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
48
+
49
+ ## 重要属性说明
50
+
51
+ ### `disabled`
52
+
53
+ 是否禁用该字段,禁用后字段不可编辑且不响应交互
54
+
55
+ - 类型:`boolean`
56
+ - 默认值:`false`
57
+ - 示例写法:`disabled={false}`
58
+
59
+ ### `readonly`
60
+
61
+ 是否只读,只读状态下字段不可编辑但可聚焦和复制
62
+
63
+ - 类型:`boolean`
64
+ - 默认值:`false`
65
+ - 示例写法:`readonly={false}`
66
+
67
+ ### `variant`
68
+
69
+ 编辑器外观样式变体
70
+
71
+ - 类型:`EditorVariant`
72
+ - 默认值:`undefined`
73
+ - 示例写法:`variant="plain"`
74
+
75
+ ### `placeholder`
76
+
77
+ 占位提示文本,字段值为空时在输入区域内展示
78
+
79
+ - 类型:`string`
80
+ - 默认值:`undefined`
81
+ - 示例写法:`placeholder="请输入或选择"`
82
+
83
+ ### `onchange`
84
+
85
+ 字段值发生变化时触发的回调
86
+
87
+ - 类型:`(value?: any) => void`
88
+ - 默认值:`undefined`
89
+ - 示例写法:`onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}`
90
+
91
+ ### `value`
92
+
93
+ 组件的核心值。支持绑定时建议使用 `bind:value`,外部修改会同步到组件。
94
+
95
+ - 类型:`string`
96
+ - 默认值:`$bindable()`
97
+ - 推荐写法:`bind:value`
98
+
99
+ ## 组件实例方法
100
+
101
+ 通过 `bind:this` 获取组件实例后调用。
102
+
103
+ | 方法 | 类型 | 说明 |
104
+ | --- | --- | --- |
105
+ | `focus()` | `() => void` | 组件实例方法。 |
106
+
107
+ ## 相关类型定义
108
+
109
+ 以下定义帮助理解复杂属性的数据结构;其中部分辅助类型属于内部实现,不一定是独立导出入口。
110
+
111
+ ### `EditorVariant`
112
+
113
+ ```ts
114
+ export type EditorVariant = '' | 'plain' | 'outlined' | 'filled';
115
+ ```
116
+
117
+ ### `CaseMode`
118
+
119
+ ```ts
120
+ export type CaseMode = 'upper' | 'lower';
121
+ ```
122
+
123
+ ## 示例
124
+
125
+ 完整示例见 [example.svelte](./example.svelte)。
126
+ ```svelte
127
+ <script lang="ts">
128
+ import TextEditor from '@ticatec/uniface-element/TextEditor';
129
+ let value = $state<any>("示例值");
130
+ </script>
131
+
132
+ <TextEditor
133
+ bind:value
134
+ onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}
135
+ onfocus={async (...args: any[]) => { console.log('onfocus', ...args); return true; }}
136
+ variant="plain"
137
+ placeholder="请输入或选择"
138
+ disabled={false}
139
+ readonly={false}
140
+ compact={true}
141
+ />
142
+ <p>当前状态:{JSON.stringify({value})}</p>
143
+ ```
144
+
145
+ ## 源码
146
+
147
+ - `src/lib/form/text_editor/TextEditor.svelte`
@@ -0,0 +1,16 @@
1
+ <script lang="ts">
2
+ import TextEditor from '@ticatec/uniface-element/TextEditor';
3
+ let value = $state<any>("示例值");
4
+ </script>
5
+
6
+ <TextEditor
7
+ bind:value
8
+ onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}
9
+ onfocus={async (...args: any[]) => { console.log('onfocus', ...args); return true; }}
10
+ variant="plain"
11
+ placeholder="请输入或选择"
12
+ disabled={false}
13
+ readonly={false}
14
+ compact={true}
15
+ />
16
+ <p>当前状态:{JSON.stringify({value})}</p>
@@ -0,0 +1,130 @@
1
+ # TimeEditor
2
+
3
+ 表单组件。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 输入和选择一天内时间的编辑器。
8
+
9
+ ## 适用场景
10
+
11
+ - 营业时间、提醒时间和排班时间
12
+ - 只需要时分秒而不需要日期
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import TimeEditor from '@ticatec/uniface-element/TimeEditor';
18
+ ```
19
+
20
+ ## 属性
21
+
22
+ | 属性 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
23
+ | --- | --- | --- | --- | --- | --- | --- |
24
+ | `theme` | 否 | `string` | 否 | `undefined` | 否 | 主题样式名称,用于切换组件外观主题 |
25
+ | `tooltip` | 否 | `string` | 否 | `undefined` | 否 | 悬停提示信息,鼠标悬浮在字段上时显示 |
26
+ | `error` | 否 | `string` | 否 | `undefined` | 否 | 错误信息,用于在字段下方展示校验错误提示 |
27
+ | `disabled` | 是 | `boolean` | 否 | `false` | 否 | 是否禁用该字段,禁用后字段不可编辑且不响应交互 |
28
+ | `readonly` | 是 | `boolean` | 否 | `false` | 否 | 是否只读,只读状态下字段不可编辑但可聚焦和复制 |
29
+ | `compact` | 否 | `boolean` | 否 | `false` | 否 | 是否启用紧凑模式,紧凑模式下字段内部间距更小 |
30
+ | `variant` | 是 | `EditorVariant` | 否 | `undefined` | 否 | 编辑器外观样式变体 |
31
+ | `placeholder` | 是 | `string` | 否 | `undefined` | 否 | 占位提示文本,字段值为空时在输入区域内展示 |
32
+ | `style` | 否 | `string` | 否 | `undefined` | 否 | 自定义内联样式,会应用到字段根容器上 |
33
+ | `onfocus` | 否 | `(event: FocusEvent) => void` | 否 | `undefined` | 否 | 字段获得焦点时触发的回调 |
34
+ | `onblur` | 否 | `(event: FocusEvent) => void` | 否 | `undefined` | 否 | 字段失去焦点时触发的回调 |
35
+ | `onchange` | 是 | `(value?: any) => void` | 否 | `undefined` | 否 | 字段值发生变化时触发的回调 |
36
+ | `precision` | 否 | `TimePrecision` | 否 | `'M'` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
37
+ | `mandatory` | 否 | `boolean` | 否 | `false` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
38
+ | `suffix` | 否 | `string` | 否 | `undefined` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
39
+ | `prefix` | 否 | `string` | 否 | `undefined` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
40
+ | `value` | 是 | `number \| undefined` | 否 | `$bindable<number \| undefined>()` | 是 | 组件的核心值。支持绑定时建议使用 `bind:value`,外部修改会同步到组件。 |
41
+ | `leadingIcon` | 否 | `Snippet` | 否 | `undefined` | 否 | Svelte Snippet 渲染入口,用于替换或补充默认内容。 |
42
+ | `trailingIcon` | 否 | `Snippet` | 否 | `undefined` | 否 | Svelte Snippet 渲染入口,用于替换或补充默认内容。 |
43
+
44
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
45
+
46
+ ## 重要属性说明
47
+
48
+ ### `disabled`
49
+
50
+ 是否禁用该字段,禁用后字段不可编辑且不响应交互
51
+
52
+ - 类型:`boolean`
53
+ - 默认值:`false`
54
+ - 示例写法:`disabled={false}`
55
+
56
+ ### `readonly`
57
+
58
+ 是否只读,只读状态下字段不可编辑但可聚焦和复制
59
+
60
+ - 类型:`boolean`
61
+ - 默认值:`false`
62
+ - 示例写法:`readonly={false}`
63
+
64
+ ### `variant`
65
+
66
+ 编辑器外观样式变体
67
+
68
+ - 类型:`EditorVariant`
69
+ - 默认值:`undefined`
70
+ - 示例写法:`variant="plain"`
71
+
72
+ ### `placeholder`
73
+
74
+ 占位提示文本,字段值为空时在输入区域内展示
75
+
76
+ - 类型:`string`
77
+ - 默认值:`undefined`
78
+ - 示例写法:`placeholder="请输入或选择"`
79
+
80
+ ### `onchange`
81
+
82
+ 字段值发生变化时触发的回调
83
+
84
+ - 类型:`(value?: any) => void`
85
+ - 默认值:`undefined`
86
+ - 示例写法:`onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}`
87
+
88
+ ### `value`
89
+
90
+ 组件的核心值。支持绑定时建议使用 `bind:value`,外部修改会同步到组件。
91
+
92
+ - 类型:`number | undefined`
93
+ - 默认值:`$bindable<number | undefined>()`
94
+ - 推荐写法:`bind:value`
95
+
96
+ ## 相关类型定义
97
+
98
+ 以下定义帮助理解复杂属性的数据结构;其中部分辅助类型属于内部实现,不一定是独立导出入口。
99
+
100
+ ### `EditorVariant`
101
+
102
+ ```ts
103
+ export type EditorVariant = '' | 'plain' | 'outlined' | 'filled';
104
+ ```
105
+
106
+ ## 示例
107
+
108
+ 完整示例见 [example.svelte](./example.svelte)。
109
+ ```svelte
110
+ <script lang="ts">
111
+ import TimeEditor from '@ticatec/uniface-element/TimeEditor';
112
+ let value = $state<any>('09:30:00');
113
+ </script>
114
+
115
+ <TimeEditor
116
+ bind:value
117
+ onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}
118
+ onfocus={async (...args: any[]) => { console.log('onfocus', ...args); return true; }}
119
+ variant="plain"
120
+ placeholder="请输入或选择"
121
+ disabled={false}
122
+ readonly={false}
123
+ compact={true}
124
+ />
125
+ <p>当前状态:{JSON.stringify({value})}</p>
126
+ ```
127
+
128
+ ## 源码
129
+
130
+ - `src/lib/form/time_editor/TimeEditor.svelte`
@@ -0,0 +1,16 @@
1
+ <script lang="ts">
2
+ import TimeEditor from '@ticatec/uniface-element/TimeEditor';
3
+ let value = $state<any>('09:30:00');
4
+ </script>
5
+
6
+ <TimeEditor
7
+ bind:value
8
+ onchange={async (...args: any[]) => { console.log('onchange', ...args); return true; }}
9
+ onfocus={async (...args: any[]) => { console.log('onfocus', ...args); return true; }}
10
+ variant="plain"
11
+ placeholder="请输入或选择"
12
+ disabled={false}
13
+ readonly={false}
14
+ compact={true}
15
+ />
16
+ <p>当前状态:{JSON.stringify({value})}</p>
@@ -0,0 +1,52 @@
1
+ # Toast
2
+
3
+ 命令式服务。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 通过命令式 API 显示自动消失的轻量通知。
8
+
9
+ ## 适用场景
10
+
11
+ - 保存成功、网络失败和操作反馈
12
+ - 无需打断用户当前操作的短消息
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import Toast from '@ticatec/uniface-element/Toast';
18
+ ```
19
+
20
+ ## 公开成员与方法
21
+
22
+ | 成员 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
23
+ | --- | --- | --- | --- | --- | --- | --- |
24
+ | `message` | 是 | `string` | 否 | `$state('')` | 是 | 内部响应式状态;由上方方法统一管理。这是一个单例服务而非组件,不能使用 `bind:message`,仅供参考,不建议直接修改。 |
25
+ | `type` | 是 | `ToastType` | 否 | `$state<ToastType>('info')` | 是 | 内部响应式状态;由上方方法统一管理。这是一个单例服务而非组件,不能使用 `bind:type`,仅供参考,不建议直接修改。 |
26
+ | `visible` | 是 | `boolean` | 否 | `$state(false)` | 是 | 内部响应式状态:标记当前是否正在显示。由 `show()`/`hide()` 等方法统一管理;这是一个单例服务而非组件,不能使用 `bind:visible`,不建议直接修改。 |
27
+ | `contentHeight` | 是 | `number` | 否 | `$state(0)` | 是 | 内部响应式状态;由上方方法统一管理。这是一个单例服务而非组件,不能使用 `bind:contentHeight`,仅供参考,不建议直接修改。 |
28
+ | `show()` | 否 | `(msg: string, type: ToastType = 'info', duration: number = 3) => void` | 否 | `—` | 否 | 显示 toast 通知 |
29
+ | `info()` | 否 | `(msg: string, duration: number = 3) => void` | 否 | `—` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
30
+ | `success()` | 否 | `(msg: string, duration: number = 3) => void` | 否 | `—` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
31
+ | `error()` | 否 | `(msg: string, duration: number = 3) => void` | 否 | `—` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
32
+
33
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
34
+
35
+ ## 示例
36
+
37
+ 完整示例见 [example.svelte](./example.svelte)。
38
+ ```svelte
39
+ <script lang="ts">
40
+ import Toast from '@ticatec/uniface-element/Toast';
41
+
42
+ function notify() {
43
+ Toast.show('操作成功');
44
+ }
45
+ </script>
46
+
47
+ <button type="button" onclick={notify}>显示提示</button>
48
+ ```
49
+
50
+ ## 源码
51
+
52
+ - `src/lib/overlay/toast/Toast.svelte.ts`
@@ -0,0 +1,9 @@
1
+ <script lang="ts">
2
+ import Toast from '@ticatec/uniface-element/Toast';
3
+
4
+ function notify() {
5
+ Toast.show('操作成功');
6
+ }
7
+ </script>
8
+
9
+ <button type="button" onclick={notify}>显示提示</button>
@@ -0,0 +1,44 @@
1
+ # Tooltip
2
+
3
+ 浮层与弹窗组件。本文档由源码自动生成,类型以当前版本为准。
4
+
5
+ ## 简介
6
+
7
+ 自动读取 data-tip/data-tooltip 并显示悬停提示。
8
+
9
+ ## 适用场景
10
+
11
+ - 解释图标、缩写和不可用操作
12
+ - 需要全局统一、支持 Markdown 的提示层
13
+
14
+ ## 导入
15
+
16
+ ```ts
17
+ import Tooltip from '@ticatec/uniface-element/Tooltip';
18
+ ```
19
+
20
+ 别名入口:`@ticatec/uniface-element/PopupHint`
21
+
22
+ ## 属性
23
+
24
+ | 属性 | 重要 | 类型 | 必填 | 默认值 | 可绑定/响应式 | 说明 |
25
+ | --- | --- | --- | --- | --- | --- | --- |
26
+ | `delay` | 否 | `number` | 否 | `200` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
27
+ | `offset` | 否 | `number` | 否 | `6` | 否 | 可选配置,具体取值范围和数据结构见类型列。 |
28
+
29
+ > 组件的“可绑定”表示源码使用了 Svelte 5 的 `$bindable`;服务的“响应式”表示成员使用了 `$state`。复杂类型请同时参考 TypeScript 自动补全。
30
+
31
+ ## 示例
32
+
33
+ 完整示例见 [example.svelte](./example.svelte)。
34
+ ```svelte
35
+ <script lang="ts">
36
+ import Tooltip from '@ticatec/uniface-element/Tooltip';
37
+ </script>
38
+
39
+ <Tooltip/>
40
+ ```
41
+
42
+ ## 源码
43
+
44
+ - `src/lib/overlay/tooltip/Tooltip.svelte`
@@ -0,0 +1,5 @@
1
+ <script lang="ts">
2
+ import Tooltip from '@ticatec/uniface-element/Tooltip';
3
+ </script>
4
+
5
+ <Tooltip/>