@ldforge/editor 0.1.5 → 0.1.6

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.
@@ -0,0 +1,400 @@
1
+ import { localize, parseQueryViewDirectives } from '@ldforge/core';
2
+ import type { Locale, ResultRendererPlugin } from '@ldforge/core';
3
+ import {
4
+ applyRendererHeader,
5
+ generateRendererHeader,
6
+ } from './renderer-header.js';
7
+ import type { RendererHeaderConfig } from './renderer-header.js';
8
+ export type { RendererHeaderConfig } from './renderer-header.js';
9
+ export interface RendererWizardApi {
10
+ readonly isOpen: boolean;
11
+ readonly isVisible: boolean;
12
+ open(): void;
13
+ close(): void;
14
+ setVisible(visible: boolean): void;
15
+ getRenderers(): readonly ResultRendererPlugin[];
16
+ generate(config: RendererHeaderConfig): string;
17
+ apply(config: RendererHeaderConfig): void;
18
+ }
19
+ interface Host {
20
+ root: HTMLElement;
21
+ tools: HTMLElement;
22
+ visible: boolean;
23
+ getLocale(): Locale;
24
+ getRenderers(): readonly ResultRendererPlugin[];
25
+ getQuery(): string;
26
+ setQuery(query: string): void;
27
+ getTabId(): string;
28
+ assertAlive(): void;
29
+ onOpen(): void;
30
+ }
31
+ const messages = {
32
+ en: {
33
+ title: 'Plugin wizard',
34
+ choose: 'Choose a renderer',
35
+ options: 'Choose options',
36
+ preview: 'Review header',
37
+ renderer: 'Renderer',
38
+ next: 'Next',
39
+ back: 'Back',
40
+ close: 'Close',
41
+ apply: 'Apply to query',
42
+ include: 'Include binding contract comments',
43
+ header: 'Generated header',
44
+ none: 'No registered renderers.',
45
+ noOptions: 'This renderer has no header options.',
46
+ noContract: 'This renderer does not declare a binding contract.',
47
+ changed: 'The active query changed. Reopen the wizard to apply a header.',
48
+ step: 'Step',
49
+ },
50
+ nl: {
51
+ title: 'Plugin wizard',
52
+ choose: 'Kies een renderer',
53
+ options: 'Kies de opties',
54
+ preview: 'Controleer de header',
55
+ renderer: 'Renderer',
56
+ next: 'Volgende',
57
+ back: 'Terug',
58
+ close: 'Sluiten',
59
+ apply: 'Toepassen op query',
60
+ include: 'Bindingcontracten als commentaar toevoegen',
61
+ header: 'Gegenereerde header',
62
+ none: 'Geen geregistreerde renderers.',
63
+ noOptions: 'Deze renderer heeft geen headeropties.',
64
+ noContract: 'Deze renderer heeft geen bindingcontract opgegeven.',
65
+ changed:
66
+ 'De actieve query is gewijzigd. Open de wizard opnieuw om een header toe te passen.',
67
+ step: 'Stap',
68
+ },
69
+ };
70
+ export function createRendererWizard(host: Host) {
71
+ const doc = host.root.ownerDocument;
72
+ let visible = host.visible;
73
+ let opened = false;
74
+ let disposed = false;
75
+ let step = 0;
76
+ let rendererId = '';
77
+ let values: Record<string, string> = {};
78
+ let includeBindings = true;
79
+ let tabId = '';
80
+ const button = doc.createElement('button');
81
+ button.type = 'button';
82
+ button.className = 'ldforge-icon-button ldforge-wizard-toggle';
83
+ button.innerHTML =
84
+ '<svg viewBox="0 0 24 24" width="16" height="16" aria-hidden="true"><path d="m4 20 12-12 4 4L8 24M13 3v4M11 5h4M20 2v4M18 4h4M3 8v4M1 10h4" fill="none" stroke="currentColor" stroke-width="1.5"/></svg>';
85
+ button.hidden = !visible;
86
+ if (visible) host.tools.append(button);
87
+ const dialog = doc.createElement('dialog');
88
+ dialog.className = 'ldforge-renderer-wizard';
89
+ host.root.append(dialog);
90
+ const heading = doc.createElement('h2');
91
+ heading.id = `${host.root.querySelector('[role=tabpanel]')?.id ?? 'ldforge'}-renderer-wizard-${++wizardNumber}`;
92
+ dialog.id = `${heading.id}-dialog`;
93
+ button.setAttribute('aria-controls', dialog.id);
94
+ dialog.setAttribute('aria-labelledby', heading.id);
95
+ const content = doc.createElement('div');
96
+ const footer = doc.createElement('div');
97
+ footer.className = 'ldforge-wizard-actions';
98
+ const error = doc.createElement('p');
99
+ error.setAttribute('role', 'alert');
100
+ dialog.append(heading, content, error, footer);
101
+ function config(): RendererHeaderConfig {
102
+ return { rendererId, options: values, includeBindings };
103
+ }
104
+ function close() {
105
+ if (!opened) return;
106
+ opened = false;
107
+ if (typeof dialog.close === 'function') dialog.close();
108
+ else dialog.removeAttribute('open');
109
+ button.setAttribute('aria-expanded', 'false');
110
+ if (button.isConnected && !button.hidden) button.focus();
111
+ }
112
+ const api: RendererWizardApi = Object.freeze<RendererWizardApi>({
113
+ get isOpen() {
114
+ return opened && !disposed;
115
+ },
116
+ get isVisible() {
117
+ return visible && !disposed;
118
+ },
119
+ getRenderers() {
120
+ host.assertAlive();
121
+ return host.getRenderers();
122
+ },
123
+ generate(config) {
124
+ host.assertAlive();
125
+ return generateRendererHeader(
126
+ host.getRenderers(),
127
+ config,
128
+ host.getLocale(),
129
+ );
130
+ },
131
+ apply(config) {
132
+ host.assertAlive();
133
+ host.setQuery(
134
+ applyRendererHeader(
135
+ host.getQuery(),
136
+ api.generate(config),
137
+ host.getRenderers(),
138
+ ),
139
+ );
140
+ },
141
+ close() {
142
+ host.assertAlive();
143
+ close();
144
+ },
145
+ setVisible(value) {
146
+ host.assertAlive();
147
+ visible = value;
148
+ button.hidden = !value;
149
+ if (value)
150
+ host.tools.insertBefore(
151
+ button,
152
+ host.tools.querySelector('.ldforge-settings-toggle'),
153
+ );
154
+ else {
155
+ button.remove();
156
+ close();
157
+ }
158
+ },
159
+ open() {
160
+ host.assertAlive();
161
+ if (opened) {
162
+ dialog.querySelector<HTMLElement>('select,input,button')?.focus();
163
+ return;
164
+ }
165
+ host.onOpen();
166
+ step = 0;
167
+ tabId = host.getTabId();
168
+ const directives = parseQueryViewDirectives(host.getQuery());
169
+ const renderers = host.getRenderers();
170
+ rendererId =
171
+ renderers.find((renderer) => renderer.id === directives.view)?.id ??
172
+ renderers[0]?.id ??
173
+ '';
174
+ values = {};
175
+ for (const option of renderers.find(
176
+ (renderer) => renderer.id === rendererId,
177
+ )?.wizard?.options ?? []) {
178
+ const value =
179
+ directives[option.key] ??
180
+ option.aliases
181
+ ?.map((alias) => directives[alias])
182
+ .find((value) => value !== undefined) ??
183
+ option.defaultValue ??
184
+ option.choices?.[0]?.value ??
185
+ '';
186
+ values[option.key] =
187
+ option.type === 'select' &&
188
+ !option.choices?.some((choice) => choice.value === value)
189
+ ? (option.defaultValue ?? option.choices?.[0]?.value ?? '')
190
+ : value;
191
+ }
192
+ opened = true;
193
+ button.setAttribute('aria-expanded', 'true');
194
+ draw();
195
+ if (typeof dialog.showModal === 'function') dialog.showModal();
196
+ else dialog.setAttribute('open', '');
197
+ dialog.querySelector<HTMLElement>('select,input,button')?.focus();
198
+ },
199
+ });
200
+ function draw() {
201
+ const locale = host.getLocale();
202
+ const text = messages[locale];
203
+ heading.textContent = `${text.title} · ${text.step} ${step + 1}/3`;
204
+ button.title = text.title;
205
+ button.setAttribute('aria-label', text.title);
206
+ content.replaceChildren();
207
+ footer.replaceChildren();
208
+ error.textContent = '';
209
+ const title = doc.createElement('h3');
210
+ title.textContent =
211
+ [text.choose, text.options, text.preview][step] ?? text.choose;
212
+ content.append(title);
213
+ const renderers = host.getRenderers();
214
+ const renderer = renderers.find((renderer) => renderer.id === rendererId);
215
+ function action(label: string, run: () => void) {
216
+ const control = doc.createElement('button');
217
+ control.type = 'button';
218
+ control.textContent = label;
219
+ control.addEventListener('click', run);
220
+ footer.append(control);
221
+ return control;
222
+ }
223
+ if (!renderer) {
224
+ const empty = doc.createElement('p');
225
+ empty.textContent = text.none;
226
+ content.append(empty);
227
+ action(text.close, close);
228
+ return;
229
+ }
230
+ if (step === 0) {
231
+ const label = doc.createElement('label');
232
+ label.textContent = text.renderer;
233
+ const select = doc.createElement('select');
234
+ select.setAttribute('aria-label', text.renderer);
235
+ for (const item of renderers)
236
+ select.append(new Option(localize(item.label, locale), item.id));
237
+ select.value = rendererId;
238
+ select.addEventListener('change', () => {
239
+ rendererId = select.value;
240
+ values = {};
241
+ for (const option of renderers.find((item) => item.id === rendererId)
242
+ ?.wizard?.options ?? [])
243
+ values[option.key] =
244
+ option.defaultValue ?? option.choices?.[0]?.value ?? '';
245
+ });
246
+ label.append(select);
247
+ content.append(label);
248
+ }
249
+ if (step === 1) {
250
+ if (renderer.wizard?.description) {
251
+ const description = doc.createElement('p');
252
+ description.textContent = localize(renderer.wizard.description, locale);
253
+ content.append(description);
254
+ }
255
+ const options = renderer.wizard?.options ?? [];
256
+ if (!options.length) {
257
+ const message = doc.createElement('p');
258
+ message.textContent = text.noOptions;
259
+ content.append(message);
260
+ }
261
+ for (const option of options) {
262
+ const label = doc.createElement('label');
263
+ label.textContent = localize(option.label, locale);
264
+ const input =
265
+ option.type === 'select'
266
+ ? doc.createElement('select')
267
+ : doc.createElement('input');
268
+ if (
269
+ input instanceof
270
+ (doc.defaultView?.HTMLSelectElement ?? HTMLSelectElement)
271
+ )
272
+ for (const choice of option.choices ?? [])
273
+ input.append(
274
+ new Option(localize(choice.label, locale), choice.value),
275
+ );
276
+ else (input as HTMLInputElement).type = 'text';
277
+ input.setAttribute('aria-label', localize(option.label, locale));
278
+ input.value =
279
+ values[option.key] ??
280
+ option.defaultValue ??
281
+ option.choices?.[0]?.value ??
282
+ '';
283
+ input.addEventListener('input', () => {
284
+ values[option.key] = input.value;
285
+ });
286
+ input.addEventListener('change', () => {
287
+ values[option.key] = input.value;
288
+ });
289
+ label.append(input);
290
+ content.append(label);
291
+ }
292
+ }
293
+ if (step === 2) {
294
+ const label = doc.createElement('label');
295
+ label.className = 'ldforge-wizard-checkbox';
296
+ const include = doc.createElement('input');
297
+ include.type = 'checkbox';
298
+ include.checked = includeBindings;
299
+ label.append(include, text.include);
300
+ content.append(label);
301
+ const preview = doc.createElement('textarea');
302
+ preview.readOnly = true;
303
+ preview.rows = 12;
304
+ preview.setAttribute('aria-label', text.header);
305
+ function refresh() {
306
+ try {
307
+ preview.value = api.generate(config());
308
+ error.textContent = '';
309
+ } catch (problem) {
310
+ error.textContent =
311
+ problem instanceof Error ? problem.message : String(problem);
312
+ }
313
+ }
314
+ include.addEventListener('change', () => {
315
+ includeBindings = include.checked;
316
+ refresh();
317
+ });
318
+ content.append(preview);
319
+ if (!renderer.wizard?.bindings.length && !renderer.wizard?.description) {
320
+ const message = doc.createElement('p');
321
+ message.textContent = text.noContract;
322
+ content.append(message);
323
+ }
324
+ refresh();
325
+ }
326
+ action(text.close, close);
327
+ if (step > 0)
328
+ action(text.back, () => {
329
+ step--;
330
+ draw();
331
+ dialog.querySelector<HTMLElement>('select,input,button')?.focus();
332
+ });
333
+ if (step < 2)
334
+ action(text.next, () => {
335
+ step++;
336
+ draw();
337
+ dialog
338
+ .querySelector<HTMLElement>('select,input,textarea,button')
339
+ ?.focus();
340
+ });
341
+ else
342
+ action(text.apply, () => {
343
+ try {
344
+ if (tabId !== host.getTabId()) throw new Error(text.changed);
345
+ api.apply(config());
346
+ close();
347
+ } catch (problem) {
348
+ error.textContent =
349
+ problem instanceof Error ? problem.message : String(problem);
350
+ }
351
+ });
352
+ }
353
+ button.setAttribute('aria-haspopup', 'dialog');
354
+ button.setAttribute('aria-expanded', 'false');
355
+ button.addEventListener('click', () => api.open());
356
+ dialog.addEventListener('cancel', (event) => {
357
+ event.preventDefault();
358
+ close();
359
+ });
360
+ dialog.addEventListener('keydown', (event) => {
361
+ if (event.key === 'Escape') {
362
+ event.preventDefault();
363
+ event.stopPropagation();
364
+ close();
365
+ }
366
+ if (event.key === 'Tab') {
367
+ const items = [
368
+ ...dialog.querySelectorAll<HTMLElement>('select,input,textarea,button'),
369
+ ].filter((item) => !item.hasAttribute('disabled'));
370
+ const first = items[0],
371
+ last = items.at(-1);
372
+ if (event.shiftKey && doc.activeElement === first) {
373
+ event.preventDefault();
374
+ last?.focus();
375
+ } else if (!event.shiftKey && doc.activeElement === last) {
376
+ event.preventDefault();
377
+ first?.focus();
378
+ }
379
+ }
380
+ });
381
+ button.title = messages[host.getLocale()].title;
382
+ button.setAttribute('aria-label', button.title);
383
+ return {
384
+ api,
385
+ refreshLocale() {
386
+ if (opened) draw();
387
+ else {
388
+ button.title = messages[host.getLocale()].title;
389
+ button.setAttribute('aria-label', button.title);
390
+ }
391
+ },
392
+ destroy() {
393
+ close();
394
+ disposed = true;
395
+ dialog.remove();
396
+ button.remove();
397
+ },
398
+ };
399
+ }
400
+ let wizardNumber = 0;
package/src/styles.css CHANGED
@@ -69,7 +69,7 @@
69
69
  }
70
70
  .ldforge .cm-editor {
71
71
  min-height: 240px;
72
- font-size: 14px;
72
+ font-size: var(--ldforge-query-font-size, 12px);
73
73
  }
74
74
  .ldforge .cm-scroller {
75
75
  font-family: ui-monospace, monospace;
@@ -674,3 +674,176 @@
674
674
  .ldforge-toolbar-separator[hidden] {
675
675
  display: none;
676
676
  }
677
+
678
+ .ldforge-renderer-wizard {
679
+ width: min(640px, calc(100vw - 32px));
680
+ max-height: calc(100vh - 40px);
681
+ overflow: auto;
682
+ padding: 24px;
683
+ border: 1px solid var(--ldforge-border, #d4dfdd);
684
+ border-radius: 12px;
685
+ color: #183c35;
686
+ background: #fff;
687
+ box-shadow: 0 16px 60px #183c3533;
688
+ }
689
+ .ldforge-renderer-wizard::backdrop {
690
+ background: #183c3555;
691
+ }
692
+ .ldforge-renderer-wizard h2 {
693
+ font-size: 18px;
694
+ margin: 0 0 16px;
695
+ }
696
+ .ldforge-renderer-wizard h3 {
697
+ font-size: 15px;
698
+ }
699
+ .ldforge-renderer-wizard label {
700
+ display: flex;
701
+ flex-direction: column;
702
+ gap: 6px;
703
+ margin: 12px 0;
704
+ }
705
+ .ldforge-renderer-wizard input,
706
+ .ldforge-renderer-wizard select,
707
+ .ldforge-renderer-wizard textarea {
708
+ box-sizing: border-box;
709
+ max-width: 100%;
710
+ padding: 8px;
711
+ border: 1px solid #c5d6cd;
712
+ border-radius: 5px;
713
+ font: inherit;
714
+ }
715
+ .ldforge-renderer-wizard textarea {
716
+ width: 100%;
717
+ font-family: monospace;
718
+ font-size: 12px;
719
+ line-height: 1.6;
720
+ resize: vertical;
721
+ }
722
+ .ldforge-renderer-wizard .ldforge-wizard-checkbox {
723
+ flex-direction: row;
724
+ align-items: center;
725
+ }
726
+ .ldforge-wizard-actions {
727
+ display: flex;
728
+ gap: 8px;
729
+ justify-content: flex-end;
730
+ margin-top: 16px;
731
+ }
732
+ .ldforge-wizard-actions button {
733
+ padding: 8px 12px;
734
+ border: 1px solid #c5d6cd;
735
+ border-radius: 5px;
736
+ background: #f0f6f2;
737
+ color: #183c35;
738
+ cursor: pointer;
739
+ }
740
+ .ldforge-renderer-wizard [role='alert']:empty {
741
+ display: none;
742
+ }
743
+ .ldforge-renderer-wizard .ldforge-wizard-checkbox input {
744
+ width: auto;
745
+ flex: 0 0 auto;
746
+ margin: 0;
747
+ }
748
+
749
+ .ldforge-loading-indicator {
750
+ min-height: 120px;
751
+ display: flex;
752
+ align-items: center;
753
+ justify-content: center;
754
+ gap: 12px;
755
+ color: #405c57;
756
+ font-size: 13px;
757
+ }
758
+ .ldforge-spinner {
759
+ display: inline-block;
760
+ width: 28px;
761
+ height: 28px;
762
+ border: 3px solid #cde0d8;
763
+ border-top-color: #087f73;
764
+ border-radius: 50%;
765
+ animation: ldforge-spin 0.8s linear infinite;
766
+ }
767
+ @keyframes ldforge-spin {
768
+ to {
769
+ transform: rotate(360deg);
770
+ }
771
+ }
772
+ @media (prefers-reduced-motion: reduce) {
773
+ .ldforge-spinner {
774
+ animation: none;
775
+ }
776
+ }
777
+
778
+ .ldforge-font-size {
779
+ margin: 16px 0;
780
+ border: 1px solid var(--ldforge-border);
781
+ border-radius: 6px;
782
+ }
783
+ .ldforge-font-size button,
784
+ .ldforge-font-size select {
785
+ margin: 3px;
786
+ }
787
+ .ldforge-settings select:not([multiple]) {
788
+ appearance: none;
789
+ -webkit-appearance: none;
790
+ min-height: 38px;
791
+ max-width: 100%;
792
+ padding: 8px 34px 8px 12px;
793
+ border: 1px solid #bfd0c6;
794
+ border-radius: 8px;
795
+ background-color: #f7faf6;
796
+ background-image:
797
+ linear-gradient(45deg, transparent 50%, #537460 50%),
798
+ linear-gradient(135deg, #537460 50%, transparent 50%);
799
+ background-position:
800
+ calc(100% - 18px) 50%,
801
+ calc(100% - 14px) 50%;
802
+ background-size: 4px 4px;
803
+ background-repeat: no-repeat;
804
+ color: #183c35;
805
+ cursor: pointer;
806
+ transition:
807
+ border-color 120ms ease,
808
+ background-color 120ms ease;
809
+ }
810
+ .ldforge-settings select:not([multiple]):hover:not(:disabled) {
811
+ border-color: #7e9e8b;
812
+ background-color: #f0f6ef;
813
+ }
814
+ .ldforge-settings select:focus-visible {
815
+ outline: 2px solid #087f73;
816
+ outline-offset: 2px;
817
+ border-color: #087f73;
818
+ }
819
+ .ldforge-settings select:disabled {
820
+ cursor: default;
821
+ opacity: 0.55;
822
+ }
823
+ .ldforge-settings option {
824
+ background: #fff;
825
+ color: #183c35;
826
+ }
827
+ .ldforge-font-size select {
828
+ min-width: 100px;
829
+ }
830
+ @media (forced-colors: active) {
831
+ .ldforge-settings select:not([multiple]) {
832
+ appearance: auto;
833
+ -webkit-appearance: auto;
834
+ background-image: none;
835
+ }
836
+ }
837
+
838
+ .ldforge-resource-info svg {
839
+ opacity: 0.55;
840
+ transition: opacity 120ms ease;
841
+ }
842
+ .ldforge-resource-info:hover svg,
843
+ .ldforge-resource-info:focus-visible svg {
844
+ opacity: 1;
845
+ }
846
+ .ldforge-resource-info:focus-visible {
847
+ outline: 2px solid currentColor;
848
+ outline-offset: 2px;
849
+ }
package/src/toolbar.ts CHANGED
@@ -178,7 +178,10 @@ export function createToolbar(
178
178
  ...items.slice(0, index + 1),
179
179
  ];
180
180
  next = candidates.find((item) =>
181
- localize(item.plugin.label, host.getLocale())
181
+ localize(
182
+ item.plugin.getLabel?.(host.context) ?? item.plugin.label,
183
+ host.getLocale(),
184
+ )
182
185
  .toLowerCase()
183
186
  .startsWith(prefix),
184
187
  );
@@ -217,7 +220,7 @@ export function createToolbar(
217
220
  return record.plugin.id;
218
221
  },
219
222
  get label() {
220
- return record.plugin.label;
223
+ return record.plugin.getLabel?.(host.context) ?? record.plugin.label;
221
224
  },
222
225
  get groupId() {
223
226
  return record.group?.options.id;
@@ -479,20 +482,23 @@ export function createToolbar(
479
482
  if (disposed) return;
480
483
  const locale = host.getLocale();
481
484
  for (const record of buttons.values()) {
482
- const label = localize(record.plugin.label, locale);
485
+ const label = localize(
486
+ record.plugin.getLabel?.(host.context) ?? record.plugin.label,
487
+ locale,
488
+ );
489
+ const icon = record.plugin.getIcon
490
+ ? record.plugin.getIcon(host.context)
491
+ : record.plugin.icon;
492
+ const title =
493
+ record.plugin.getTitle?.(host.context) ?? record.plugin.title;
483
494
  const text = doc.createElement('span');
484
495
  text.className = 'ldforge-button-label';
485
496
  text.textContent = label;
486
497
  record.element.replaceChildren(text);
487
498
  record.element.setAttribute('aria-label', label);
488
- record.element.classList.toggle(
489
- 'ldforge-button-has-icon',
490
- Boolean(record.plugin.icon),
491
- );
492
- appendIcon(record.element, record.plugin.icon);
493
- record.element.title = record.plugin.title
494
- ? localize(record.plugin.title, locale)
495
- : label;
499
+ record.element.classList.toggle('ldforge-button-has-icon', Boolean(icon));
500
+ appendIcon(record.element, icon);
501
+ record.element.title = title ? localize(title, locale) : label;
496
502
  record.element.disabled =
497
503
  record.plugin.isDisabled?.(host.context) ?? false;
498
504
  record.element.hidden = !host.isVisible(record.plugin);