@svgrid/grid 2.7.0 → 3.0.1

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 (264) hide show
  1. package/CHANGELOG.md +116 -88
  2. package/README.md +199 -199
  3. package/dist/FlexRender.svelte +96 -96
  4. package/dist/GridFooter.svelte +181 -181
  5. package/dist/SvAutoComplete.svelte +169 -169
  6. package/dist/SvAvatar.svelte +75 -75
  7. package/dist/SvCalendar.svelte +503 -503
  8. package/dist/SvCarousel.svelte +141 -141
  9. package/dist/SvCheckBox.svelte +102 -102
  10. package/dist/SvCircularProgress.svelte +109 -109
  11. package/dist/SvColorInput.svelte +181 -181
  12. package/dist/SvComboBox.svelte +279 -279
  13. package/dist/SvContextMenu.svelte +116 -116
  14. package/dist/SvCountryInput.svelte +163 -163
  15. package/dist/SvDrawer.svelte +254 -254
  16. package/dist/SvDropDownList.svelte +378 -378
  17. package/dist/SvDurationInput.svelte +126 -126
  18. package/dist/SvField.svelte +293 -293
  19. package/dist/SvForm.svelte +437 -437
  20. package/dist/SvGridCellEditor.svelte +748 -744
  21. package/dist/SvGridChart.svelte +1716 -1716
  22. package/dist/SvGridChartPanel.svelte +485 -485
  23. package/dist/SvGridChartView.svelte +70 -70
  24. package/dist/SvGridDropdown.svelte +728 -728
  25. package/dist/SvGridSelect.svelte +270 -270
  26. package/dist/SvGroupCell.svelte +116 -116
  27. package/dist/SvListBox.svelte +334 -334
  28. package/dist/SvMaskedInput.svelte +122 -122
  29. package/dist/SvMenu.svelte +124 -124
  30. package/dist/SvMenuList.svelte +146 -146
  31. package/dist/SvMultiSelect.svelte +293 -293
  32. package/dist/SvNumberInput.svelte +172 -172
  33. package/dist/SvOtpInput.svelte +158 -158
  34. package/dist/SvPasswordInput.svelte +151 -151
  35. package/dist/SvPhoneInput.svelte +133 -133
  36. package/dist/SvPopover.svelte +197 -197
  37. package/dist/SvProgress.svelte +116 -116
  38. package/dist/SvRadioGroup.svelte +107 -107
  39. package/dist/SvRating.svelte +112 -112
  40. package/dist/SvResult.svelte +73 -73
  41. package/dist/SvRichText.svelte +211 -211
  42. package/dist/SvRowGroupPanel.svelte +170 -170
  43. package/dist/SvScrollArea.svelte +61 -61
  44. package/dist/SvSlider.svelte +203 -203
  45. package/dist/SvSwitchButton.svelte +108 -108
  46. package/dist/SvTagsInput.svelte +115 -115
  47. package/dist/SvTextInput.svelte +147 -147
  48. package/dist/SvTimePicker.svelte +245 -245
  49. package/dist/SvToaster.svelte +159 -159
  50. package/dist/SvToggleButton.svelte +85 -85
  51. package/dist/SvTooltip.svelte +161 -161
  52. package/dist/SvTour.svelte +208 -208
  53. package/dist/SvTree.svelte +444 -444
  54. package/dist/SvTreeSelect.svelte +239 -239
  55. package/dist/cdn/{GridMenus-C4oLsJyj.js → GridMenus-CYzOvmNQ.js} +3 -3
  56. package/dist/cdn/{GridMenus-yEivjNwl.js → GridMenus-DFB6iwF8.js} +3 -3
  57. package/dist/cdn/{SvDateRangeInput-DflbiP7N.js → SvDateRangeInput-CaOuMs8O.js} +1 -1
  58. package/dist/cdn/{SvDateRangeInput-Bh0A0JkF.js → SvDateRangeInput-DMLKmGEc.js} +1 -1
  59. package/dist/cdn/{SvDateTimePicker-Bivn8dAP.js → SvDateTimePicker-CCbDZNZB.js} +1 -1
  60. package/dist/cdn/{SvDateTimePicker-BWwpfB_o.js → SvDateTimePicker-sonaH0oh.js} +1 -1
  61. package/dist/cdn/{SvGridCellEditor-Ba7rY3eu.js → SvGridCellEditor-BWnTi2N7.js} +2 -2
  62. package/dist/cdn/{SvGridCellEditor-AXL8cHGO.js → SvGridCellEditor-CjEJMJKc.js} +2 -2
  63. package/dist/cdn/{SvGridChart-CwhFz7GV.js → SvGridChart-BEJmNNx9.js} +1 -1
  64. package/dist/cdn/{SvGridChart-Bs2GIR2Q.js → SvGridChart-BwVos976.js} +1 -1
  65. package/dist/cdn/{SvGridChartPanel-1WXuStzM.js → SvGridChartPanel-BOknOkrP.js} +1 -1
  66. package/dist/cdn/{SvGridChartPanel-e5_nqNP9.js → SvGridChartPanel-D2PjII4O.js} +1 -1
  67. package/dist/cdn/{SvGridChartView-SmPW10dI.js → SvGridChartView-00LPUHL1.js} +1 -1
  68. package/dist/cdn/{SvGridChartView-eSPuJE6g.js → SvGridChartView-BhUEJ5ki.js} +1 -1
  69. package/dist/cdn/{SvGridDropdown-B1ZcLpgs.js → SvGridDropdown-D0VdjeR8.js} +1 -1
  70. package/dist/cdn/{SvGridDropdown-CtdbHcIS.js → SvGridDropdown-D13MtJ2j.js} +1 -1
  71. package/dist/cdn/{date-format-DZT7T1wf.js → date-format-BNii4zeD.js} +2 -2
  72. package/dist/cdn/{date-format-CcP1tafP.js → date-format-BnnHlqGw.js} +2 -2
  73. package/dist/cdn/{row-drag-touch-Ddaa-QeB.js → row-drag-touch-CycRR65n.js} +12 -10
  74. package/dist/cdn/{src-COC0vnpg.js → src-C8QjSaq-.js} +53 -55
  75. package/dist/cdn/{src-pYGV2rMR.js → src-D0hO2eYN.js} +52 -54
  76. package/dist/cdn/svgrid.js +7 -7
  77. package/dist/cdn/svgrid.svelte-external.js +7 -7
  78. package/dist/chart-export.js +8 -8
  79. package/dist/editing.js +22 -13
  80. package/dist/row-drag-touch.d.ts +5 -1
  81. package/dist/row-drag-touch.js +15 -4
  82. package/dist/row-drag.js +7 -3
  83. package/package.json +11 -11
  84. package/src/FlexRender.svelte +96 -96
  85. package/src/GridFooter.svelte +181 -181
  86. package/src/SvAutoComplete.svelte +169 -169
  87. package/src/SvAvatar.svelte +75 -75
  88. package/src/SvCalendar.svelte +503 -503
  89. package/src/SvCalendar.test.ts +226 -226
  90. package/src/SvCarousel.svelte +141 -141
  91. package/src/SvCheckBox.svelte +102 -102
  92. package/src/SvCircularProgress.svelte +109 -109
  93. package/src/SvColorInput.svelte +181 -181
  94. package/src/SvComboBox.svelte +279 -279
  95. package/src/SvContextMenu.svelte +116 -116
  96. package/src/SvCountryInput.svelte +163 -163
  97. package/src/SvDrawer.svelte +254 -254
  98. package/src/SvDropDownList.svelte +378 -378
  99. package/src/SvDurationInput.svelte +126 -126
  100. package/src/SvField.svelte +293 -293
  101. package/src/SvForm.svelte +437 -437
  102. package/src/SvForm.test.ts +411 -411
  103. package/src/SvGrid.types.ts +2092 -2092
  104. package/src/SvGridCellEditor.svelte +748 -744
  105. package/src/SvGridChart.svelte +1716 -1716
  106. package/src/SvGridChartPanel.svelte +485 -485
  107. package/src/SvGridChartView.svelte +70 -70
  108. package/src/SvGridDropdown.svelte +728 -728
  109. package/src/SvGridSelect.svelte +270 -270
  110. package/src/SvGroupCell.svelte +116 -116
  111. package/src/SvListBox.svelte +334 -334
  112. package/src/SvMaskedInput.svelte +122 -122
  113. package/src/SvMenu.svelte +124 -124
  114. package/src/SvMenu.test.ts +97 -97
  115. package/src/SvMenuList.svelte +146 -146
  116. package/src/SvMultiSelect.svelte +293 -293
  117. package/src/SvNumberInput.svelte +172 -172
  118. package/src/SvOtpInput.svelte +158 -158
  119. package/src/SvPasswordInput.svelte +151 -151
  120. package/src/SvPhoneInput.svelte +133 -133
  121. package/src/SvPopover.svelte +197 -197
  122. package/src/SvProgress.svelte +116 -116
  123. package/src/SvRadioGroup.svelte +107 -107
  124. package/src/SvRating.svelte +112 -112
  125. package/src/SvResult.svelte +73 -73
  126. package/src/SvRichText.svelte +211 -211
  127. package/src/SvRowGroupPanel.svelte +170 -170
  128. package/src/SvScrollArea.svelte +61 -61
  129. package/src/SvSlider.svelte +203 -203
  130. package/src/SvSwitchButton.svelte +108 -108
  131. package/src/SvTagsInput.svelte +115 -115
  132. package/src/SvTextInput.svelte +147 -147
  133. package/src/SvTimePicker.svelte +245 -245
  134. package/src/SvToaster.svelte +159 -159
  135. package/src/SvToaster.test.ts +95 -95
  136. package/src/SvToggleButton.svelte +85 -85
  137. package/src/SvTooltip.svelte +161 -161
  138. package/src/SvTour.svelte +208 -208
  139. package/src/SvTree.svelte +444 -444
  140. package/src/SvTreeSelect.svelte +239 -239
  141. package/src/a11y/dismissable.test.ts +119 -119
  142. package/src/a11y/dismissable.ts +114 -114
  143. package/src/a11y.contract.test.ts +49 -49
  144. package/src/a11y.test.ts +59 -59
  145. package/src/a11y.ts +61 -61
  146. package/src/ai.test.ts +502 -502
  147. package/src/ai.ts +1419 -1419
  148. package/src/build-api.coverage.test.ts +633 -633
  149. package/src/build-api.ts +846 -846
  150. package/src/builtin-editors.grid.test.ts +83 -83
  151. package/src/cell-formatting.ts +171 -171
  152. package/src/cell-render.test.ts +513 -513
  153. package/src/cell-render.ts +496 -496
  154. package/src/cell-values.ts +148 -148
  155. package/src/chart-export.ts +202 -202
  156. package/src/chart-view.svelte.ts +36 -36
  157. package/src/chart.ts +2321 -2321
  158. package/src/collaboration.test.ts +104 -104
  159. package/src/collaboration.ts +167 -167
  160. package/src/column-groups.ts +78 -78
  161. package/src/core.performance.test.ts +30 -30
  162. package/src/core.ts +1865 -1865
  163. package/src/createAutocomplete.svelte.ts +132 -132
  164. package/src/createCombobox.svelte.ts +191 -191
  165. package/src/createCountryInput.svelte.ts +157 -157
  166. package/src/createDropdownList.svelte.ts +168 -168
  167. package/src/createForm.svelte.ts +386 -386
  168. package/src/createGrid.svelte.ts +42 -42
  169. package/src/createGrid.test.ts +10 -10
  170. package/src/createGridState.svelte.ts +17 -17
  171. package/src/createListbox.svelte.ts +250 -250
  172. package/src/createMenu.svelte.ts +224 -224
  173. package/src/createPopoverSelect.svelte.ts +213 -213
  174. package/src/createSlider.svelte.ts +191 -191
  175. package/src/createTooltip.svelte.ts +144 -144
  176. package/src/createTree.svelte.ts +322 -322
  177. package/src/datetime/date-core.ts +206 -206
  178. package/src/datetime/date-restrict.ts +61 -61
  179. package/src/datetime/timezone.ts +135 -135
  180. package/src/dock-manager-model.ts +596 -596
  181. package/src/dock-model.ts +374 -374
  182. package/src/editing.test.ts +974 -974
  183. package/src/editing.ts +618 -609
  184. package/src/editor-contract.ts +171 -171
  185. package/src/editor-registry.grid.test.ts +144 -144
  186. package/src/editor-registry.ts +122 -122
  187. package/src/export-data-api.test.ts +126 -126
  188. package/src/export-format.test.ts +107 -107
  189. package/src/export-format.ts +601 -601
  190. package/src/filter-operators.ts +160 -160
  191. package/src/filtering/excel-filters.ts +325 -325
  192. package/src/flex-render.ts +3 -3
  193. package/src/form-field.ts +127 -127
  194. package/src/group-display.test.ts +167 -167
  195. package/src/group-display.ts +200 -200
  196. package/src/headless.ts +87 -87
  197. package/src/js-scroller.svelte.ts +173 -173
  198. package/src/keyboard-handlers.ts +270 -270
  199. package/src/keyboard.test.ts +59 -59
  200. package/src/keyboard.ts +97 -97
  201. package/src/list-nav.test.ts +49 -49
  202. package/src/list-nav.ts +29 -29
  203. package/src/list-option.test.ts +56 -56
  204. package/src/list-option.ts +179 -179
  205. package/src/menus.ts +597 -597
  206. package/src/merge-objects.ts +48 -48
  207. package/src/overlays.test.ts +90 -90
  208. package/src/positioning.ts +268 -268
  209. package/src/render-component.ts +28 -28
  210. package/src/row-drag-touch.ts +226 -211
  211. package/src/row-drag.test.ts +401 -353
  212. package/src/row-drag.ts +419 -415
  213. package/src/row-resize.test.ts +524 -524
  214. package/src/row-resize.ts +228 -228
  215. package/src/scheduler-ical.ts +181 -181
  216. package/src/scheduler-model.test.ts +562 -562
  217. package/src/scheduler-model.ts +873 -873
  218. package/src/selection.test.ts +885 -885
  219. package/src/server-data-source.test.ts +383 -383
  220. package/src/server-data-source.ts +469 -469
  221. package/src/sparkline.test.ts +68 -68
  222. package/src/sparkline.ts +169 -169
  223. package/src/spreadsheet.test.ts +488 -488
  224. package/src/spreadsheet.ts +312 -312
  225. package/src/static-functions.ts +11 -11
  226. package/src/subscribe.ts +38 -38
  227. package/src/summaries.ts +113 -113
  228. package/src/svgrid-wrapper.types.ts +563 -563
  229. package/src/svgrid.async-editor-options.test.ts +273 -273
  230. package/src/svgrid.auto-row-height.test.ts +204 -204
  231. package/src/svgrid.behavior.test.ts +910 -910
  232. package/src/svgrid.charting.test.ts +534 -534
  233. package/src/svgrid.comments-autocomplete.test.ts +127 -127
  234. package/src/svgrid.context-menu.test.ts +147 -147
  235. package/src/svgrid.features.test.ts +157 -157
  236. package/src/svgrid.filter-depth.test.ts +163 -163
  237. package/src/svgrid.filter-menu-listbox.svelte.test.ts +382 -377
  238. package/src/svgrid.filter-menu-scroll.test.ts +112 -112
  239. package/src/svgrid.grand-total.test.ts +188 -188
  240. package/src/svgrid.group-display-mode.test.ts +171 -171
  241. package/src/svgrid.group-footers.test.ts +121 -121
  242. package/src/svgrid.group-pagination.test.ts +153 -153
  243. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  244. package/src/svgrid.tree-data.test.ts +186 -186
  245. package/src/svgrid.wrapper.test.ts +63 -63
  246. package/src/svgriddropdown.async-panel.svelte.test.ts +195 -195
  247. package/src/test-setup.ts +62 -62
  248. package/src/themes/index.ts +288 -288
  249. package/src/toast-store.svelte.ts +250 -250
  250. package/src/toast-store.test.ts +147 -147
  251. package/src/tree-row-model.test.ts +168 -168
  252. package/src/ui-buttons.test.ts +144 -144
  253. package/src/ui-inputs.test.ts +118 -118
  254. package/src/ui-localization.test.ts +113 -113
  255. package/src/ui-range.test.ts +70 -70
  256. package/src/ui-selection.test.ts +155 -155
  257. package/src/ui-tier1.test.ts +142 -142
  258. package/src/virtual.test.ts +88 -88
  259. package/src/virtualization/column-virtualizer.test.ts +27 -27
  260. package/src/virtualization/column-virtualizer.ts +30 -30
  261. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  262. package/src/virtualization/types.ts +30 -30
  263. package/src/virtualization/virtualizer.test.ts +47 -47
  264. package/src/virtualization/virtualizer.ts +322 -322
@@ -1,211 +1,211 @@
1
- <script lang="ts" module>
2
- export type RichTextTool =
3
- | 'bold' | 'italic' | 'underline' | 'strike'
4
- | 'h1' | 'h2' | 'h3' | 'p'
5
- | 'ul' | 'ol' | 'quote' | 'code'
6
- | 'alignLeft' | 'alignCenter' | 'alignRight'
7
- | 'link' | 'clear' | 'undo' | 'redo'
8
- | '|'
9
- </script>
10
-
11
- <script lang="ts">
12
- /**
13
- * SvRichText - a lightweight WYSIWYG editor: a formatting toolbar over a
14
- * `contentEditable` region, emitting HTML. Parity: Smart `smart-editor` (the
15
- * common commands). Uses `document.execCommand` - the pragmatic, widely-working
16
- * approach for a component-kit editor. Bindable `value` (HTML string).
17
- *
18
- * ```svelte
19
- * <SvRichText bind:value={html} placeholder="Write something…" />
20
- * ```
21
- */
22
- import { nextEditorId, resolveMessages } from './editor-contract'
23
-
24
- const DEFAULT_TOOLS: RichTextTool[] = [
25
- 'bold', 'italic', 'underline', 'strike', '|',
26
- 'h1', 'h2', 'h3', 'p', '|',
27
- 'ul', 'ol', 'quote', 'code', '|',
28
- 'alignLeft', 'alignCenter', 'alignRight', '|',
29
- 'link', 'clear', '|', 'undo', 'redo',
30
- ]
31
-
32
- /** Toolbar glyphs. Mode-independent and not language-dependent, so they stay
33
- * fixed; the LABELS beside them are localizable via `messages`. */
34
- const GLYPH: Record<Exclude<RichTextTool, '|'>, string> = {
35
- bold: 'B', italic: 'I', underline: 'U', strike: 'S',
36
- h1: 'H1', h2: 'H2', h3: 'H3', p: '¶',
37
- ul: '•', ol: '1.', quote: '❝', code: '</>',
38
- alignLeft: '≡', alignCenter: '≣', alignRight: '≡', link: '🔗',
39
- clear: '⌫', undo: '↶', redo: '↷',
40
- }
41
-
42
- /** User-facing strings (localizable via `messages`). Every one is a tooltip +
43
- * accessible name on a toolbar button, so leaving them hard-coded made the
44
- * whole toolbar English-only for screen-reader users. */
45
- type RichTextMessages = Record<Exclude<RichTextTool, '|'>, string> & { linkPrompt: string; toolbar: string }
46
- const DEFAULT_MESSAGES: RichTextMessages = {
47
- bold: 'Bold', italic: 'Italic', underline: 'Underline', strike: 'Strikethrough',
48
- h1: 'Heading 1', h2: 'Heading 2', h3: 'Heading 3', p: 'Paragraph',
49
- ul: 'Bullet list', ol: 'Numbered list', quote: 'Quote', code: 'Code block',
50
- alignLeft: 'Align left', alignCenter: 'Align center', alignRight: 'Align right',
51
- link: 'Link', clear: 'Clear formatting', undo: 'Undo', redo: 'Redo',
52
- linkPrompt: 'Link URL', toolbar: 'Formatting',
53
- }
54
-
55
- type Props = {
56
- /** HTML string (bindable). */
57
- value?: string
58
- onChange?: (html: string) => void
59
- placeholder?: string
60
- disabled?: boolean
61
- readonly?: boolean
62
- minHeight?: string
63
- /** Toolbar tools + order; use '|' for a separator. */
64
- tools?: RichTextTool[]
65
- ariaLabel?: string
66
- /** Override any toolbar label / prompt (localization). */
67
- messages?: Partial<RichTextMessages>
68
- }
69
-
70
- let {
71
- value = $bindable(''),
72
- onChange,
73
- placeholder = '',
74
- disabled = false,
75
- readonly = false,
76
- minHeight = '160px',
77
- tools = DEFAULT_TOOLS,
78
- ariaLabel = 'Rich text editor',
79
- messages,
80
- }: Props = $props()
81
-
82
- const M = $derived(resolveMessages(DEFAULT_MESSAGES, messages))
83
- const uid = nextEditorId('sv-rt')
84
- let editorEl = $state<HTMLDivElement | null>(null)
85
- let focused = $state(false)
86
- let empty = $state(true)
87
- let activeState = $state<Record<string, boolean>>({})
88
-
89
- // Push external value into the DOM only when it differs and we're not typing
90
- // (writing innerHTML while focused would collapse the caret).
91
- $effect(() => {
92
- const v = value ?? ''
93
- // A contenteditable owns its own DOM: letting Svelte re-render the body
94
- // would wipe the caret mid-typing, so the value is pushed in by hand and
95
- // only while the editor is unfocused.
96
- // eslint-disable-next-line svelte/no-dom-manipulating
97
- if (editorEl && !focused && editorEl.innerHTML !== v) editorEl.innerHTML = v
98
- if (editorEl) empty = editorEl.textContent!.trim().length === 0
99
- })
100
-
101
- function sync() {
102
- if (!editorEl) return
103
- const html = editorEl.innerHTML
104
- empty = editorEl.textContent!.trim().length === 0
105
- value = html
106
- onChange?.(html)
107
- }
108
- function q(cmd: string): boolean {
109
- try { return document.queryCommandState(cmd) } catch { return false }
110
- }
111
- function refreshState() {
112
- activeState = {
113
- bold: q('bold'), italic: q('italic'), underline: q('underline'), strike: q('strikeThrough'),
114
- ul: q('insertUnorderedList'), ol: q('insertOrderedList'),
115
- }
116
- }
117
- function exec(cmd: string, arg?: string) {
118
- if (disabled || readonly) return
119
- editorEl?.focus()
120
- try { document.execCommand(cmd, false, arg) } catch { /* jsdom / unsupported */ }
121
- sync()
122
- refreshState()
123
- }
124
-
125
- const run: Record<Exclude<RichTextTool, '|'>, () => void> = {
126
- bold: () => exec('bold'), italic: () => exec('italic'), underline: () => exec('underline'), strike: () => exec('strikeThrough'),
127
- h1: () => exec('formatBlock', 'H1'), h2: () => exec('formatBlock', 'H2'), h3: () => exec('formatBlock', 'H3'), p: () => exec('formatBlock', 'P'),
128
- ul: () => exec('insertUnorderedList'), ol: () => exec('insertOrderedList'),
129
- quote: () => exec('formatBlock', 'BLOCKQUOTE'), code: () => exec('formatBlock', 'PRE'),
130
- alignLeft: () => exec('justifyLeft'), alignCenter: () => exec('justifyCenter'), alignRight: () => exec('justifyRight'),
131
- link: () => { const url = typeof prompt === 'function' ? prompt(M.linkPrompt, 'https://') : null; if (url) exec('createLink', url) },
132
- clear: () => exec('removeFormat'), undo: () => exec('undo'), redo: () => exec('redo'),
133
- }
134
- </script>
135
-
136
- <div class="sv-rt" class:is-disabled={disabled} class:is-readonly={readonly}>
137
- {#if !readonly}
138
- <div class="sv-rt__toolbar" role="toolbar" aria-label={M.toolbar} aria-controls={uid}>
139
- {#each tools as t, i (i)}
140
- {#if t === '|'}
141
- <span class="sv-rt__sep" aria-hidden="true"></span>
142
- {:else}
143
- <button
144
- type="button"
145
- class="sv-rt__btn"
146
- class:is-on={activeState[t]}
147
- data-tool={t}
148
- title={M[t]}
149
- aria-label={M[t]}
150
- aria-pressed={activeState[t] ? true : undefined}
151
- {disabled}
152
- onmousedown={(e) => e.preventDefault()}
153
- onclick={run[t]}
154
- >{GLYPH[t]}</button>
155
- {/if}
156
- {/each}
157
- </div>
158
- {/if}
159
- <!-- svelte-ignore a11y_no_noninteractive_tabindex -->
160
- <div
161
- bind:this={editorEl}
162
- id={uid}
163
- class="sv-rt__body"
164
- class:is-empty={empty}
165
- style:min-height={minHeight}
166
- contenteditable={!disabled && !readonly}
167
- role="textbox"
168
- aria-multiline="true"
169
- aria-label={ariaLabel}
170
- data-placeholder={placeholder}
171
- tabindex={disabled ? -1 : 0}
172
- oninput={sync}
173
- onfocus={() => (focused = true)}
174
- onblur={() => { focused = false; sync() }}
175
- onkeyup={refreshState}
176
- onmouseup={refreshState}
177
- ></div>
178
- </div>
179
-
180
- <style>
181
- .sv-rt {
182
- --_accent: var(--sg-accent, #2563eb);
183
- border: 1px solid var(--sg-input-border, var(--sg-border, #cbd5e1)); border-radius: var(--sg-radius, 8px);
184
- background: var(--sg-input-bg, #fff); color: var(--sg-fg, #0f172a); overflow: hidden;
185
- display: flex; flex-direction: column;
186
- }
187
- .sv-rt:focus-within { border-color: var(--_accent); box-shadow: 0 0 0 2px color-mix(in srgb, var(--_accent) 20%, transparent); }
188
- .sv-rt.is-disabled { opacity: 0.6; }
189
- .sv-rt__toolbar { display: flex; flex-wrap: wrap; align-items: center; gap: 1px; padding: 5px 6px; border-bottom: 1px solid var(--sg-border, #e2e8f0); background: var(--sg-header-bg, #f8fafc); }
190
- .sv-rt__btn {
191
- min-width: 28px; height: 28px; padding: 0 6px; display: grid; place-items: center;
192
- background: none; border: 0; border-radius: 6px; color: var(--sg-fg, #334155); cursor: pointer;
193
- font-size: 12.5px; font-weight: 600;
194
- }
195
- .sv-rt__btn:hover:not(:disabled) { background: var(--sg-row-hover-bg, #eef2f7); }
196
- .sv-rt__btn.is-on { background: color-mix(in srgb, var(--_accent) 16%, transparent); color: var(--_accent); }
197
- .sv-rt__btn[data-tool='italic'] { font-style: italic; }
198
- .sv-rt__btn[data-tool='underline'] { text-decoration: underline; }
199
- .sv-rt__btn[data-tool='strike'] { text-decoration: line-through; }
200
- .sv-rt__btn[data-tool='alignRight'] { transform: scaleX(-1); }
201
- .sv-rt__sep { width: 1px; height: 18px; background: var(--sg-border, #e2e8f0); margin: 0 4px; }
202
- .sv-rt__body { padding: 10px 12px; outline: none; overflow: auto; font-size: 14px; line-height: 1.6; }
203
- .sv-rt__body.is-empty::before { content: attr(data-placeholder); color: var(--sg-muted, #94a3b8); pointer-events: none; }
204
- .sv-rt__body :global(h1) { font-size: 1.5em; font-weight: 700; margin: 0.4em 0; }
205
- .sv-rt__body :global(h2) { font-size: 1.25em; font-weight: 700; margin: 0.4em 0; }
206
- .sv-rt__body :global(h3) { font-size: 1.1em; font-weight: 650; margin: 0.4em 0; }
207
- .sv-rt__body :global(blockquote) { margin: 0.4em 0; padding-inline-start: 12px; border-inline-start: 3px solid var(--sg-border, #cbd5e1); color: var(--sg-muted, #64748b); }
208
- .sv-rt__body :global(pre) { margin: 0.4em 0; padding: 10px 12px; border-radius: 8px; background: var(--sg-row-hover-bg, #f1f5f9); font: 12.5px/1.6 ui-monospace, monospace; overflow-x: auto; }
209
- .sv-rt__body :global(a) { color: var(--_accent); }
210
- .sv-rt__body :global(ul), .sv-rt__body :global(ol) { margin: 0.4em 0; padding-inline-start: 24px; }
211
- </style>
1
+ <script lang="ts" module>
2
+ export type RichTextTool =
3
+ | 'bold' | 'italic' | 'underline' | 'strike'
4
+ | 'h1' | 'h2' | 'h3' | 'p'
5
+ | 'ul' | 'ol' | 'quote' | 'code'
6
+ | 'alignLeft' | 'alignCenter' | 'alignRight'
7
+ | 'link' | 'clear' | 'undo' | 'redo'
8
+ | '|'
9
+ </script>
10
+
11
+ <script lang="ts">
12
+ /**
13
+ * SvRichText - a lightweight WYSIWYG editor: a formatting toolbar over a
14
+ * `contentEditable` region, emitting HTML. Parity: Smart `smart-editor` (the
15
+ * common commands). Uses `document.execCommand` - the pragmatic, widely-working
16
+ * approach for a component-kit editor. Bindable `value` (HTML string).
17
+ *
18
+ * ```svelte
19
+ * <SvRichText bind:value={html} placeholder="Write something…" />
20
+ * ```
21
+ */
22
+ import { nextEditorId, resolveMessages } from './editor-contract'
23
+
24
+ const DEFAULT_TOOLS: RichTextTool[] = [
25
+ 'bold', 'italic', 'underline', 'strike', '|',
26
+ 'h1', 'h2', 'h3', 'p', '|',
27
+ 'ul', 'ol', 'quote', 'code', '|',
28
+ 'alignLeft', 'alignCenter', 'alignRight', '|',
29
+ 'link', 'clear', '|', 'undo', 'redo',
30
+ ]
31
+
32
+ /** Toolbar glyphs. Mode-independent and not language-dependent, so they stay
33
+ * fixed; the LABELS beside them are localizable via `messages`. */
34
+ const GLYPH: Record<Exclude<RichTextTool, '|'>, string> = {
35
+ bold: 'B', italic: 'I', underline: 'U', strike: 'S',
36
+ h1: 'H1', h2: 'H2', h3: 'H3', p: '¶',
37
+ ul: '•', ol: '1.', quote: '❝', code: '</>',
38
+ alignLeft: '≡', alignCenter: '≣', alignRight: '≡', link: '🔗',
39
+ clear: '⌫', undo: '↶', redo: '↷',
40
+ }
41
+
42
+ /** User-facing strings (localizable via `messages`). Every one is a tooltip +
43
+ * accessible name on a toolbar button, so leaving them hard-coded made the
44
+ * whole toolbar English-only for screen-reader users. */
45
+ type RichTextMessages = Record<Exclude<RichTextTool, '|'>, string> & { linkPrompt: string; toolbar: string }
46
+ const DEFAULT_MESSAGES: RichTextMessages = {
47
+ bold: 'Bold', italic: 'Italic', underline: 'Underline', strike: 'Strikethrough',
48
+ h1: 'Heading 1', h2: 'Heading 2', h3: 'Heading 3', p: 'Paragraph',
49
+ ul: 'Bullet list', ol: 'Numbered list', quote: 'Quote', code: 'Code block',
50
+ alignLeft: 'Align left', alignCenter: 'Align center', alignRight: 'Align right',
51
+ link: 'Link', clear: 'Clear formatting', undo: 'Undo', redo: 'Redo',
52
+ linkPrompt: 'Link URL', toolbar: 'Formatting',
53
+ }
54
+
55
+ type Props = {
56
+ /** HTML string (bindable). */
57
+ value?: string
58
+ onChange?: (html: string) => void
59
+ placeholder?: string
60
+ disabled?: boolean
61
+ readonly?: boolean
62
+ minHeight?: string
63
+ /** Toolbar tools + order; use '|' for a separator. */
64
+ tools?: RichTextTool[]
65
+ ariaLabel?: string
66
+ /** Override any toolbar label / prompt (localization). */
67
+ messages?: Partial<RichTextMessages>
68
+ }
69
+
70
+ let {
71
+ value = $bindable(''),
72
+ onChange,
73
+ placeholder = '',
74
+ disabled = false,
75
+ readonly = false,
76
+ minHeight = '160px',
77
+ tools = DEFAULT_TOOLS,
78
+ ariaLabel = 'Rich text editor',
79
+ messages,
80
+ }: Props = $props()
81
+
82
+ const M = $derived(resolveMessages(DEFAULT_MESSAGES, messages))
83
+ const uid = nextEditorId('sv-rt')
84
+ let editorEl = $state<HTMLDivElement | null>(null)
85
+ let focused = $state(false)
86
+ let empty = $state(true)
87
+ let activeState = $state<Record<string, boolean>>({})
88
+
89
+ // Push external value into the DOM only when it differs and we're not typing
90
+ // (writing innerHTML while focused would collapse the caret).
91
+ $effect(() => {
92
+ const v = value ?? ''
93
+ // A contenteditable owns its own DOM: letting Svelte re-render the body
94
+ // would wipe the caret mid-typing, so the value is pushed in by hand and
95
+ // only while the editor is unfocused.
96
+ // eslint-disable-next-line svelte/no-dom-manipulating
97
+ if (editorEl && !focused && editorEl.innerHTML !== v) editorEl.innerHTML = v
98
+ if (editorEl) empty = editorEl.textContent!.trim().length === 0
99
+ })
100
+
101
+ function sync() {
102
+ if (!editorEl) return
103
+ const html = editorEl.innerHTML
104
+ empty = editorEl.textContent!.trim().length === 0
105
+ value = html
106
+ onChange?.(html)
107
+ }
108
+ function q(cmd: string): boolean {
109
+ try { return document.queryCommandState(cmd) } catch { return false }
110
+ }
111
+ function refreshState() {
112
+ activeState = {
113
+ bold: q('bold'), italic: q('italic'), underline: q('underline'), strike: q('strikeThrough'),
114
+ ul: q('insertUnorderedList'), ol: q('insertOrderedList'),
115
+ }
116
+ }
117
+ function exec(cmd: string, arg?: string) {
118
+ if (disabled || readonly) return
119
+ editorEl?.focus()
120
+ try { document.execCommand(cmd, false, arg) } catch { /* jsdom / unsupported */ }
121
+ sync()
122
+ refreshState()
123
+ }
124
+
125
+ const run: Record<Exclude<RichTextTool, '|'>, () => void> = {
126
+ bold: () => exec('bold'), italic: () => exec('italic'), underline: () => exec('underline'), strike: () => exec('strikeThrough'),
127
+ h1: () => exec('formatBlock', 'H1'), h2: () => exec('formatBlock', 'H2'), h3: () => exec('formatBlock', 'H3'), p: () => exec('formatBlock', 'P'),
128
+ ul: () => exec('insertUnorderedList'), ol: () => exec('insertOrderedList'),
129
+ quote: () => exec('formatBlock', 'BLOCKQUOTE'), code: () => exec('formatBlock', 'PRE'),
130
+ alignLeft: () => exec('justifyLeft'), alignCenter: () => exec('justifyCenter'), alignRight: () => exec('justifyRight'),
131
+ link: () => { const url = typeof prompt === 'function' ? prompt(M.linkPrompt, 'https://') : null; if (url) exec('createLink', url) },
132
+ clear: () => exec('removeFormat'), undo: () => exec('undo'), redo: () => exec('redo'),
133
+ }
134
+ </script>
135
+
136
+ <div class="sv-rt" class:is-disabled={disabled} class:is-readonly={readonly}>
137
+ {#if !readonly}
138
+ <div class="sv-rt__toolbar" role="toolbar" aria-label={M.toolbar} aria-controls={uid}>
139
+ {#each tools as t, i (i)}
140
+ {#if t === '|'}
141
+ <span class="sv-rt__sep" aria-hidden="true"></span>
142
+ {:else}
143
+ <button
144
+ type="button"
145
+ class="sv-rt__btn"
146
+ class:is-on={activeState[t]}
147
+ data-tool={t}
148
+ title={M[t]}
149
+ aria-label={M[t]}
150
+ aria-pressed={activeState[t] ? true : undefined}
151
+ {disabled}
152
+ onmousedown={(e) => e.preventDefault()}
153
+ onclick={run[t]}
154
+ >{GLYPH[t]}</button>
155
+ {/if}
156
+ {/each}
157
+ </div>
158
+ {/if}
159
+ <!-- svelte-ignore a11y_no_noninteractive_tabindex -->
160
+ <div
161
+ bind:this={editorEl}
162
+ id={uid}
163
+ class="sv-rt__body"
164
+ class:is-empty={empty}
165
+ style:min-height={minHeight}
166
+ contenteditable={!disabled && !readonly}
167
+ role="textbox"
168
+ aria-multiline="true"
169
+ aria-label={ariaLabel}
170
+ data-placeholder={placeholder}
171
+ tabindex={disabled ? -1 : 0}
172
+ oninput={sync}
173
+ onfocus={() => (focused = true)}
174
+ onblur={() => { focused = false; sync() }}
175
+ onkeyup={refreshState}
176
+ onmouseup={refreshState}
177
+ ></div>
178
+ </div>
179
+
180
+ <style>
181
+ .sv-rt {
182
+ --_accent: var(--sg-accent, #2563eb);
183
+ border: 1px solid var(--sg-input-border, var(--sg-border, #cbd5e1)); border-radius: var(--sg-radius, 8px);
184
+ background: var(--sg-input-bg, #fff); color: var(--sg-fg, #0f172a); overflow: hidden;
185
+ display: flex; flex-direction: column;
186
+ }
187
+ .sv-rt:focus-within { border-color: var(--_accent); box-shadow: 0 0 0 2px color-mix(in srgb, var(--_accent) 20%, transparent); }
188
+ .sv-rt.is-disabled { opacity: 0.6; }
189
+ .sv-rt__toolbar { display: flex; flex-wrap: wrap; align-items: center; gap: 1px; padding: 5px 6px; border-bottom: 1px solid var(--sg-border, #e2e8f0); background: var(--sg-header-bg, #f8fafc); }
190
+ .sv-rt__btn {
191
+ min-width: 28px; height: 28px; padding: 0 6px; display: grid; place-items: center;
192
+ background: none; border: 0; border-radius: 6px; color: var(--sg-fg, #334155); cursor: pointer;
193
+ font-size: 12.5px; font-weight: 600;
194
+ }
195
+ .sv-rt__btn:hover:not(:disabled) { background: var(--sg-row-hover-bg, #eef2f7); }
196
+ .sv-rt__btn.is-on { background: color-mix(in srgb, var(--_accent) 16%, transparent); color: var(--_accent); }
197
+ .sv-rt__btn[data-tool='italic'] { font-style: italic; }
198
+ .sv-rt__btn[data-tool='underline'] { text-decoration: underline; }
199
+ .sv-rt__btn[data-tool='strike'] { text-decoration: line-through; }
200
+ .sv-rt__btn[data-tool='alignRight'] { transform: scaleX(-1); }
201
+ .sv-rt__sep { width: 1px; height: 18px; background: var(--sg-border, #e2e8f0); margin: 0 4px; }
202
+ .sv-rt__body { padding: 10px 12px; outline: none; overflow: auto; font-size: 14px; line-height: 1.6; }
203
+ .sv-rt__body.is-empty::before { content: attr(data-placeholder); color: var(--sg-muted, #94a3b8); pointer-events: none; }
204
+ .sv-rt__body :global(h1) { font-size: 1.5em; font-weight: 700; margin: 0.4em 0; }
205
+ .sv-rt__body :global(h2) { font-size: 1.25em; font-weight: 700; margin: 0.4em 0; }
206
+ .sv-rt__body :global(h3) { font-size: 1.1em; font-weight: 650; margin: 0.4em 0; }
207
+ .sv-rt__body :global(blockquote) { margin: 0.4em 0; padding-inline-start: 12px; border-inline-start: 3px solid var(--sg-border, #cbd5e1); color: var(--sg-muted, #64748b); }
208
+ .sv-rt__body :global(pre) { margin: 0.4em 0; padding: 10px 12px; border-radius: 8px; background: var(--sg-row-hover-bg, #f1f5f9); font: 12.5px/1.6 ui-monospace, monospace; overflow-x: auto; }
209
+ .sv-rt__body :global(a) { color: var(--_accent); }
210
+ .sv-rt__body :global(ul), .sv-rt__body :global(ol) { margin: 0.4em 0; padding-inline-start: 24px; }
211
+ </style>