@ldforge/editor 0.1.8 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -0
- package/dist/controls.d.ts +2 -0
- package/dist/controls.d.ts.map +1 -1
- package/dist/controls.js +2 -0
- package/dist/controls.js.map +1 -1
- package/dist/editor-height.d.ts +8 -0
- package/dist/editor-height.d.ts.map +1 -0
- package/dist/editor-height.js +34 -0
- package/dist/editor-height.js.map +1 -0
- package/dist/index.d.ts +33 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +347 -33
- package/dist/index.js.map +1 -1
- package/dist/renderer-info.d.ts +4 -0
- package/dist/renderer-info.d.ts.map +1 -0
- package/dist/renderer-info.js +41 -0
- package/dist/renderer-info.js.map +1 -0
- package/dist/renderer-wizard.d.ts.map +1 -1
- package/dist/renderer-wizard.js +109 -25
- package/dist/renderer-wizard.js.map +1 -1
- package/dist/share.d.ts +16 -0
- package/dist/share.d.ts.map +1 -0
- package/dist/share.js +113 -0
- package/dist/share.js.map +1 -0
- package/dist/sparql/completion.d.ts.map +1 -1
- package/dist/sparql/completion.js +5 -0
- package/dist/sparql/completion.js.map +1 -1
- package/dist/styles.css +496 -82
- package/dist/tab-api.d.ts +7 -1
- package/dist/tab-api.d.ts.map +1 -1
- package/dist/tab-api.js +29 -1
- package/dist/tab-api.js.map +1 -1
- package/dist/theme.d.ts +4 -0
- package/dist/theme.d.ts.map +1 -0
- package/dist/theme.js +73 -0
- package/dist/theme.js.map +1 -0
- package/docs/api/configuration.md +72 -21
- package/docs/api/editor.md +184 -19
- package/docs/api/overview.md +8 -0
- package/docs/api/plugins.md +6 -2
- package/docs/api/tab.md +37 -9
- package/docs/api/transport.md +19 -2
- package/docs/renderers.md +29 -1
- package/package.json +3 -3
- package/src/controls.ts +4 -0
- package/src/editor-height.ts +42 -0
- package/src/index.ts +440 -30
- package/src/renderer-info.ts +52 -0
- package/src/renderer-wizard.ts +114 -25
- package/src/share.ts +125 -0
- package/src/sparql/completion.ts +5 -0
- package/src/styles.css +496 -82
- package/src/tab-api.ts +44 -4
- package/src/theme.ts +87 -0
package/src/index.ts
CHANGED
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
import {
|
|
2
|
+
createAutoGrowControl,
|
|
3
|
+
DEFAULT_EDITOR_ROWS,
|
|
4
|
+
validateEditorRows,
|
|
5
|
+
} from './editor-height.js';
|
|
6
|
+
import { renderRendererInfo } from './renderer-info.js';
|
|
7
|
+
import { applyTheme, themeTokens } from './theme.js';
|
|
8
|
+
import {
|
|
9
|
+
createShareControl,
|
|
10
|
+
createShareLink,
|
|
11
|
+
queryWithRenderer,
|
|
12
|
+
queryWithEndpoint,
|
|
13
|
+
} from './share.js';
|
|
1
14
|
import {
|
|
2
15
|
createFontSizeControl,
|
|
3
16
|
DEFAULT_FONT_SIZE,
|
|
@@ -103,6 +116,10 @@ export type {
|
|
|
103
116
|
export interface EditorOptions {
|
|
104
117
|
readonly executor: QueryExecutor;
|
|
105
118
|
readonly query?: string;
|
|
119
|
+
/** Absolute recipient page URL. Defaults to the current page URL. */
|
|
120
|
+
readonly shareBaseUrl?: string;
|
|
121
|
+
/** Applied connection endpoint to include when the query has none. Read at share time. */
|
|
122
|
+
readonly shareEndpoint?: string | (() => string | undefined);
|
|
106
123
|
/** Initially collapse PREFIX declarations on each tab. Defaults to false. */
|
|
107
124
|
readonly prefixesCollapsed?: boolean;
|
|
108
125
|
/** Built-in UI visibility; all flags default to true. False hides all built-in controls. */
|
|
@@ -120,12 +137,24 @@ export interface EditorOptions {
|
|
|
120
137
|
readonly onLocaleChange?: (preference: LocalePreference) => void;
|
|
121
138
|
/** CodeMirror query text size only, 10–24px. */
|
|
122
139
|
readonly fontSize?: number;
|
|
140
|
+
/** Query viewport in visual lines; minimum when autoGrow is true. Defaults to 15. */
|
|
141
|
+
readonly editorRows?: number;
|
|
142
|
+
/** Grow with query content instead of scrolling a fixed viewport. Defaults to true. */
|
|
143
|
+
readonly autoGrow?: boolean;
|
|
144
|
+
readonly onAutoGrowChange?: (enabled: boolean) => void;
|
|
145
|
+
readonly onEditorRowsChange?: (rows: number) => void;
|
|
146
|
+
/** Instance accent as an opaque #RGB or #RRGGBB color. Omit for the default theme. */
|
|
147
|
+
readonly themeMainColor?: string;
|
|
123
148
|
readonly onFontSizeChange?: (size: number) => void;
|
|
124
149
|
/** Omit to use the combined Run/Stop button; provide an array to replace the toolbar. */
|
|
125
150
|
readonly buttons?: readonly ButtonPlugin[];
|
|
126
151
|
/** Optional dropdown presentation and additional declarative button groups. */
|
|
127
152
|
readonly toolbar?: ToolbarOptions;
|
|
128
153
|
readonly renderers?: readonly ResultRendererPlugin[];
|
|
154
|
+
/** Show the dropdown of other registered renderers. Defaults to true. */
|
|
155
|
+
readonly availablePlugins?: boolean;
|
|
156
|
+
/** Renderers pinned on the result bar, by registered ID or descriptor. Defaults to Table and JSON. */
|
|
157
|
+
readonly visiblePlugins?: readonly (string | ResultRendererPlugin)[];
|
|
129
158
|
readonly settings?: readonly SettingsPlugin[];
|
|
130
159
|
readonly extensions?: readonly Extension[];
|
|
131
160
|
readonly onQueryChange?: (query: string) => void;
|
|
@@ -140,7 +169,24 @@ export interface ForgeEditor extends EditorContext {
|
|
|
140
169
|
getToolBar(): ToolbarApi;
|
|
141
170
|
/** Registered renderers only; does not load their external visual libraries. */
|
|
142
171
|
getRenderers(): readonly ResultRendererPlugin[];
|
|
172
|
+
showAvailablePlugins(): void;
|
|
173
|
+
hideAvailablePlugins(): void;
|
|
174
|
+
/** Pin a registered renderer without selecting it or changing its support predicate. */
|
|
175
|
+
showPlugin(plugin: string | ResultRendererPlugin): void;
|
|
176
|
+
/** Unpin a renderer; an active renderer remains visible until another is selected. */
|
|
177
|
+
hidePlugin(plugin: string | ResultRendererPlugin): void;
|
|
143
178
|
getRendererWizard(): RendererWizardApi;
|
|
179
|
+
/** Share URL for the active query, including its selected renderer. Does not edit. */
|
|
180
|
+
getShareLink(): string;
|
|
181
|
+
/** Copy the share URL and persist its renderer header as one undoable edit. */
|
|
182
|
+
copyShareLink(): Promise<string>;
|
|
183
|
+
getThemeMainColor(): string | undefined;
|
|
184
|
+
/** Undefined restores the default theme. */
|
|
185
|
+
setThemeMainColor(color?: string): void;
|
|
186
|
+
getEditorRows(): number;
|
|
187
|
+
setEditorRows(rows: number): void;
|
|
188
|
+
isAutoGrowEnabled(): boolean;
|
|
189
|
+
setAutoGrow(enabled: boolean): void;
|
|
144
190
|
getFontSize(): number;
|
|
145
191
|
setFontSize(size: number): void;
|
|
146
192
|
isLoadingIndicatorEnabled(): boolean;
|
|
@@ -204,8 +250,13 @@ export function createEditor(
|
|
|
204
250
|
container: HTMLElement,
|
|
205
251
|
options: EditorOptions,
|
|
206
252
|
): ForgeEditor {
|
|
253
|
+
let themeMainColor = options.themeMainColor;
|
|
254
|
+
let tokens = themeTokens(themeMainColor);
|
|
207
255
|
let fontSize = options.fontSize ?? DEFAULT_FONT_SIZE;
|
|
208
256
|
validateFontSize(fontSize);
|
|
257
|
+
let editorRows = options.editorRows ?? DEFAULT_EDITOR_ROWS;
|
|
258
|
+
validateEditorRows(editorRows);
|
|
259
|
+
let autoGrow = options.autoGrow ?? true;
|
|
209
260
|
const controls = resolveControls(options.controls);
|
|
210
261
|
let loadingIndicatorEnabled = controls.loadingIndicator;
|
|
211
262
|
const buttons = new PluginRegistry(
|
|
@@ -216,6 +267,16 @@ export function createEditor(
|
|
|
216
267
|
),
|
|
217
268
|
);
|
|
218
269
|
const renderers = new PluginRegistry(options.renderers);
|
|
270
|
+
let availablePluginsVisible = options.availablePlugins ?? true;
|
|
271
|
+
function registeredPluginId(plugin: string | ResultRendererPlugin): string {
|
|
272
|
+
const id = typeof plugin === 'string' ? plugin : plugin.id;
|
|
273
|
+
if (!renderers.list().some((renderer) => renderer.id === id))
|
|
274
|
+
throw new TypeError(`Unknown result renderer: ${id}`);
|
|
275
|
+
return id;
|
|
276
|
+
}
|
|
277
|
+
const visiblePlugins = new Set(
|
|
278
|
+
options.visiblePlugins?.map(registeredPluginId) ?? ['table', 'json'],
|
|
279
|
+
);
|
|
219
280
|
const settings = new PluginRegistry(options.settings);
|
|
220
281
|
const catalog = namespaceCatalog(options.sparql ?? {});
|
|
221
282
|
const settingsCleanups: (() => void)[] = [];
|
|
@@ -234,6 +295,7 @@ export function createEditor(
|
|
|
234
295
|
const doc = container.ownerDocument;
|
|
235
296
|
const root = doc.createElement('section');
|
|
236
297
|
root.className = 'ldforge';
|
|
298
|
+
applyTheme(root, {}, tokens);
|
|
237
299
|
root.setAttribute('aria-label', 'SPARQL editor');
|
|
238
300
|
const toolbar = doc.createElement('div');
|
|
239
301
|
toolbar.className = 'ldforge-toolbar';
|
|
@@ -253,6 +315,8 @@ export function createEditor(
|
|
|
253
315
|
tabBar.hidden = !controls.tabs;
|
|
254
316
|
const editorHost = doc.createElement('div');
|
|
255
317
|
editorHost.className = 'ldforge-code';
|
|
318
|
+
editorHost.dataset.autoGrow = String(autoGrow);
|
|
319
|
+
editorHost.style.setProperty('--ldforge-query-rows', String(editorRows));
|
|
256
320
|
editorHost.style.setProperty('--ldforge-query-font-size', `${fontSize}px`);
|
|
257
321
|
editorHost.id = `ldforge-query-${settingsPanelNumber + 1}`;
|
|
258
322
|
editorHost.setAttribute('role', 'tabpanel');
|
|
@@ -263,6 +327,20 @@ export function createEditor(
|
|
|
263
327
|
status.setAttribute('aria-live', 'polite');
|
|
264
328
|
const resultToolbar = doc.createElement('div');
|
|
265
329
|
resultToolbar.className = 'ldforge-result-toolbar';
|
|
330
|
+
const rendererWarning = doc.createElement('div');
|
|
331
|
+
rendererWarning.className = 'ldforge-renderer-warning';
|
|
332
|
+
rendererWarning.setAttribute('role', 'status');
|
|
333
|
+
rendererWarning.hidden = true;
|
|
334
|
+
appendIcon(
|
|
335
|
+
rendererWarning,
|
|
336
|
+
createSvgIcon(['M12 3a9 9 0 1 0 0 18 9 9 0 0 0 0-18', 'M12 7v6m0 3v.01']),
|
|
337
|
+
);
|
|
338
|
+
const rendererWarningText = doc.createElement('span');
|
|
339
|
+
rendererWarning.append(rendererWarningText);
|
|
340
|
+
const rendererInfo = doc.createElement('section');
|
|
341
|
+
rendererInfo.className = 'ldforge-renderer-info';
|
|
342
|
+
rendererInfo.id = `${editorHost.id}-renderer-info`;
|
|
343
|
+
rendererInfo.hidden = true;
|
|
266
344
|
const resultTabs = doc.createElement('div');
|
|
267
345
|
resultTabs.className = 'ldforge-result-tabs';
|
|
268
346
|
resultTabs.setAttribute('role', 'tablist');
|
|
@@ -332,6 +410,14 @@ export function createEditor(
|
|
|
332
410
|
);
|
|
333
411
|
fontSizeControl.element.hidden = !controls.fontSize;
|
|
334
412
|
settingsPanel.append(fontSizeControl.element);
|
|
413
|
+
const autoGrowControl = createAutoGrowControl(
|
|
414
|
+
doc,
|
|
415
|
+
() => autoGrow,
|
|
416
|
+
() => locale,
|
|
417
|
+
(enabled) => context.setAutoGrow(enabled),
|
|
418
|
+
);
|
|
419
|
+
autoGrowControl.element.hidden = !controls.autoGrow;
|
|
420
|
+
settingsPanel.append(autoGrowControl.element);
|
|
335
421
|
const toggle = doc.createElement('button');
|
|
336
422
|
root.append(
|
|
337
423
|
toolbar,
|
|
@@ -339,6 +425,8 @@ export function createEditor(
|
|
|
339
425
|
tabBar,
|
|
340
426
|
editorHost,
|
|
341
427
|
resultToolbar,
|
|
428
|
+
rendererWarning,
|
|
429
|
+
rendererInfo,
|
|
342
430
|
output,
|
|
343
431
|
);
|
|
344
432
|
container.append(root);
|
|
@@ -350,6 +438,20 @@ export function createEditor(
|
|
|
350
438
|
let executedDirectives = parseQueryViewDirectives('');
|
|
351
439
|
let applyPreferredView = false;
|
|
352
440
|
|
|
441
|
+
function sharingQuery(): string {
|
|
442
|
+
const query = context.getQuery();
|
|
443
|
+
const declared = parseQueryViewDirectives(query).view;
|
|
444
|
+
const rendererId =
|
|
445
|
+
controller.state.status === 'success'
|
|
446
|
+
? selectedRenderer
|
|
447
|
+
: (declared ?? renderers.list()[0]?.id);
|
|
448
|
+
const endpoint =
|
|
449
|
+
typeof options.shareEndpoint === 'function'
|
|
450
|
+
? options.shareEndpoint()
|
|
451
|
+
: options.shareEndpoint;
|
|
452
|
+
return queryWithEndpoint(queryWithRenderer(query, rendererId), endpoint);
|
|
453
|
+
}
|
|
454
|
+
|
|
353
455
|
function assertAlive(): void {
|
|
354
456
|
if (disposed) throw new Error('Editor has been destroyed.');
|
|
355
457
|
}
|
|
@@ -368,6 +470,43 @@ export function createEditor(
|
|
|
368
470
|
context.setPrefixesCollapsed(!context.arePrefixesCollapsed());
|
|
369
471
|
return context.arePrefixesCollapsed();
|
|
370
472
|
},
|
|
473
|
+
getThemeMainColor() {
|
|
474
|
+
assertAlive();
|
|
475
|
+
return themeMainColor;
|
|
476
|
+
},
|
|
477
|
+
setThemeMainColor(color) {
|
|
478
|
+
assertAlive();
|
|
479
|
+
const next = themeTokens(color);
|
|
480
|
+
applyTheme(root, tokens, next);
|
|
481
|
+
tokens = next;
|
|
482
|
+
themeMainColor = color;
|
|
483
|
+
},
|
|
484
|
+
getEditorRows() {
|
|
485
|
+
assertAlive();
|
|
486
|
+
return editorRows;
|
|
487
|
+
},
|
|
488
|
+
setEditorRows(rows) {
|
|
489
|
+
assertAlive();
|
|
490
|
+
validateEditorRows(rows);
|
|
491
|
+
if (rows === editorRows) return;
|
|
492
|
+
editorRows = rows;
|
|
493
|
+
editorHost.style.setProperty('--ldforge-query-rows', String(rows));
|
|
494
|
+
view.requestMeasure();
|
|
495
|
+
options.onEditorRowsChange?.(rows);
|
|
496
|
+
},
|
|
497
|
+
isAutoGrowEnabled() {
|
|
498
|
+
assertAlive();
|
|
499
|
+
return autoGrow;
|
|
500
|
+
},
|
|
501
|
+
setAutoGrow(enabled) {
|
|
502
|
+
assertAlive();
|
|
503
|
+
if (enabled === autoGrow) return;
|
|
504
|
+
autoGrow = enabled;
|
|
505
|
+
editorHost.dataset.autoGrow = String(enabled);
|
|
506
|
+
autoGrowControl.refresh();
|
|
507
|
+
view.requestMeasure();
|
|
508
|
+
options.onAutoGrowChange?.(enabled);
|
|
509
|
+
},
|
|
371
510
|
getFontSize() {
|
|
372
511
|
assertAlive();
|
|
373
512
|
return fontSize;
|
|
@@ -395,10 +534,63 @@ export function createEditor(
|
|
|
395
534
|
assertAlive();
|
|
396
535
|
return renderers.list();
|
|
397
536
|
},
|
|
537
|
+
showAvailablePlugins() {
|
|
538
|
+
assertAlive();
|
|
539
|
+
availablePluginsVisible = true;
|
|
540
|
+
refreshPluginPicker();
|
|
541
|
+
},
|
|
542
|
+
hideAvailablePlugins() {
|
|
543
|
+
assertAlive();
|
|
544
|
+
availablePluginsVisible = false;
|
|
545
|
+
refreshPluginPicker();
|
|
546
|
+
},
|
|
547
|
+
showPlugin(plugin) {
|
|
548
|
+
assertAlive();
|
|
549
|
+
visiblePlugins.add(registeredPluginId(plugin));
|
|
550
|
+
refreshPluginPicker();
|
|
551
|
+
},
|
|
552
|
+
hidePlugin(plugin) {
|
|
553
|
+
assertAlive();
|
|
554
|
+
visiblePlugins.delete(registeredPluginId(plugin));
|
|
555
|
+
refreshPluginPicker();
|
|
556
|
+
},
|
|
398
557
|
getRendererWizard() {
|
|
399
558
|
assertAlive();
|
|
400
559
|
return rendererWizard.api;
|
|
401
560
|
},
|
|
561
|
+
getShareLink() {
|
|
562
|
+
assertAlive();
|
|
563
|
+
return createShareLink(
|
|
564
|
+
options.shareBaseUrl ?? doc.location.href,
|
|
565
|
+
sharingQuery(),
|
|
566
|
+
);
|
|
567
|
+
},
|
|
568
|
+
async copyShareLink() {
|
|
569
|
+
assertAlive();
|
|
570
|
+
const original = context.getQuery();
|
|
571
|
+
const tabId = queryTabs.snapshot().activeId;
|
|
572
|
+
const query = sharingQuery();
|
|
573
|
+
const link = createShareLink(
|
|
574
|
+
options.shareBaseUrl ?? doc.location.href,
|
|
575
|
+
query,
|
|
576
|
+
);
|
|
577
|
+
const clipboard = doc.defaultView?.navigator.clipboard;
|
|
578
|
+
if (!clipboard)
|
|
579
|
+
throw new Error(
|
|
580
|
+
locale === 'nl'
|
|
581
|
+
? 'Klembord is niet beschikbaar.'
|
|
582
|
+
: 'Clipboard is not available.',
|
|
583
|
+
);
|
|
584
|
+
await clipboard.writeText(link);
|
|
585
|
+
if (
|
|
586
|
+
!disposed &&
|
|
587
|
+
tabId === queryTabs.snapshot().activeId &&
|
|
588
|
+
context.getQuery() === original &&
|
|
589
|
+
query !== original
|
|
590
|
+
)
|
|
591
|
+
context.setQuery(query);
|
|
592
|
+
return link;
|
|
593
|
+
},
|
|
402
594
|
getToolBar() {
|
|
403
595
|
assertAlive();
|
|
404
596
|
return toolbarView.api;
|
|
@@ -409,6 +601,9 @@ export function createEditor(
|
|
|
409
601
|
},
|
|
410
602
|
formatQuery: (formatOptions) =>
|
|
411
603
|
tabApi.collection.getActive().formatQuery(formatOptions),
|
|
604
|
+
getPrefixes: () => tabApi.collection.getActive().getPrefixes(),
|
|
605
|
+
removePrefix: (prefix) =>
|
|
606
|
+
tabApi.collection.getActive().removePrefix(prefix),
|
|
412
607
|
addPrefix: (prefix, namespace) =>
|
|
413
608
|
tabApi.collection.getActive().addPrefix(prefix, namespace),
|
|
414
609
|
getWorkspace: () => queryTabs.snapshot(),
|
|
@@ -440,7 +635,9 @@ export function createEditor(
|
|
|
440
635
|
cancel: () => controller.cancel(),
|
|
441
636
|
focus: () => view.focus(),
|
|
442
637
|
destroy() {
|
|
638
|
+
doc.removeEventListener('pointerdown', dismissRendererPicker);
|
|
443
639
|
if (disposed) return;
|
|
640
|
+
shareControl.destroy();
|
|
444
641
|
rendererWizard.destroy();
|
|
445
642
|
toolbarView.destroy();
|
|
446
643
|
disposed = true;
|
|
@@ -544,9 +741,14 @@ export function createEditor(
|
|
|
544
741
|
warn:
|
|
545
742
|
options.onWarning ??
|
|
546
743
|
((warning) => console.warn(`[LDForge] ${warning.message}`)),
|
|
547
|
-
setQuery(id, query) {
|
|
548
|
-
if (queryTabs.snapshot().activeId === id)
|
|
549
|
-
|
|
744
|
+
setQuery(id, query, changes) {
|
|
745
|
+
if (queryTabs.snapshot().activeId === id) {
|
|
746
|
+
if (changes) {
|
|
747
|
+
// Map cursor/selection through the prefix edits instead of replacing
|
|
748
|
+
// the entire document and mapping every position to its end.
|
|
749
|
+
view.dispatch({ changes, annotations: isolateHistory.of('full') });
|
|
750
|
+
} else context.setQuery(query);
|
|
751
|
+
} else {
|
|
550
752
|
queryTabs.update(query, id);
|
|
551
753
|
notifyWorkspace();
|
|
552
754
|
}
|
|
@@ -671,6 +873,17 @@ export function createEditor(
|
|
|
671
873
|
toggle.setAttribute('aria-expanded', 'false');
|
|
672
874
|
},
|
|
673
875
|
});
|
|
876
|
+
const shareControl = createShareControl({
|
|
877
|
+
tools,
|
|
878
|
+
visible: controls.share,
|
|
879
|
+
getLocale: () => locale,
|
|
880
|
+
copy: () => context.copyShareLink(),
|
|
881
|
+
onError(error) {
|
|
882
|
+
status.textContent = translate(locale, 'actionFailed', {
|
|
883
|
+
message: error instanceof Error ? error.message : String(error),
|
|
884
|
+
});
|
|
885
|
+
},
|
|
886
|
+
});
|
|
674
887
|
root.insertBefore(prefixPicker.panel, tabBar);
|
|
675
888
|
|
|
676
889
|
function refreshButtons(): void {
|
|
@@ -688,12 +901,183 @@ export function createEditor(
|
|
|
688
901
|
else loadingIndicator.remove();
|
|
689
902
|
}
|
|
690
903
|
|
|
904
|
+
function refreshPluginPicker(): void {
|
|
905
|
+
const state = controller.state;
|
|
906
|
+
if (state.status !== 'success') return;
|
|
907
|
+
const available = renderers
|
|
908
|
+
.list()
|
|
909
|
+
.filter((plugin) => plugin.supports(state.result));
|
|
910
|
+
renderPluginPicker(
|
|
911
|
+
available,
|
|
912
|
+
available.find((plugin) => plugin.id === selectedRenderer) ??
|
|
913
|
+
available[0],
|
|
914
|
+
);
|
|
915
|
+
}
|
|
916
|
+
|
|
917
|
+
function renderPluginPicker(
|
|
918
|
+
available: readonly ResultRendererPlugin[],
|
|
919
|
+
renderer: ResultRendererPlugin | undefined,
|
|
920
|
+
): void {
|
|
921
|
+
resultTabs.replaceChildren();
|
|
922
|
+
rendererInfo.hidden = true;
|
|
923
|
+
rendererInfo.replaceChildren();
|
|
924
|
+
resultTabs.hidden = renderers.list().length === 0;
|
|
925
|
+
const picker = doc.createElement('details');
|
|
926
|
+
picker.className = 'ldforge-renderer-picker';
|
|
927
|
+
const pickerToggle = doc.createElement('summary');
|
|
928
|
+
pickerToggle.textContent = translate(locale, 'rendererChoose');
|
|
929
|
+
appendIcon(
|
|
930
|
+
pickerToggle,
|
|
931
|
+
createSvgIcon(['M3 3h7v7H3zM14 3h7v7h-7zM3 14h7v7H3zM14 14h7v7h-7z']),
|
|
932
|
+
);
|
|
933
|
+
pickerToggle.setAttribute(
|
|
934
|
+
'aria-label',
|
|
935
|
+
translate(locale, 'rendererChoose'),
|
|
936
|
+
);
|
|
937
|
+
const chevron = createSvgIcon(['m6 9 6 6 6-6'])(doc);
|
|
938
|
+
chevron.setAttribute('aria-hidden', 'true');
|
|
939
|
+
pickerToggle.append(chevron);
|
|
940
|
+
const pickerOptions = doc.createElement('div');
|
|
941
|
+
pickerOptions.className = 'ldforge-renderer-picker-options';
|
|
942
|
+
picker.append(pickerToggle, pickerOptions);
|
|
943
|
+
pickerToggle.addEventListener('keydown', (event) => {
|
|
944
|
+
if (event.key !== 'ArrowDown' && event.key !== 'ArrowUp') return;
|
|
945
|
+
event.preventDefault();
|
|
946
|
+
picker.open = true;
|
|
947
|
+
const choices = pickerOptions.querySelectorAll<HTMLButtonElement>(
|
|
948
|
+
'button:not(:disabled)',
|
|
949
|
+
);
|
|
950
|
+
(event.key === 'ArrowDown'
|
|
951
|
+
? choices[0]
|
|
952
|
+
: choices[choices.length - 1]
|
|
953
|
+
)?.focus();
|
|
954
|
+
});
|
|
955
|
+
pickerOptions.addEventListener('keydown', (event) => {
|
|
956
|
+
if (!['ArrowDown', 'ArrowUp', 'Home', 'End'].includes(event.key)) return;
|
|
957
|
+
event.preventDefault();
|
|
958
|
+
event.stopPropagation();
|
|
959
|
+
const choices = [
|
|
960
|
+
...pickerOptions.querySelectorAll<HTMLButtonElement>(
|
|
961
|
+
'button:not(:disabled)',
|
|
962
|
+
),
|
|
963
|
+
];
|
|
964
|
+
const current = choices.indexOf(doc.activeElement as HTMLButtonElement);
|
|
965
|
+
const next =
|
|
966
|
+
event.key === 'Home'
|
|
967
|
+
? 0
|
|
968
|
+
: event.key === 'End'
|
|
969
|
+
? choices.length - 1
|
|
970
|
+
: (current +
|
|
971
|
+
(event.key === 'ArrowDown' ? 1 : -1) +
|
|
972
|
+
choices.length) %
|
|
973
|
+
choices.length;
|
|
974
|
+
choices[next]?.focus();
|
|
975
|
+
});
|
|
976
|
+
|
|
977
|
+
picker.addEventListener('keydown', (event) => {
|
|
978
|
+
if (event.key === 'Escape') {
|
|
979
|
+
event.preventDefault();
|
|
980
|
+
picker.open = false;
|
|
981
|
+
pickerToggle.focus();
|
|
982
|
+
}
|
|
983
|
+
});
|
|
984
|
+
picker.addEventListener('focusout', (event) => {
|
|
985
|
+
if (event.relatedTarget && !picker.contains(event.relatedTarget as Node))
|
|
986
|
+
picker.open = false;
|
|
987
|
+
});
|
|
988
|
+
resultTabs.append(picker);
|
|
989
|
+
for (const [index, plugin] of renderers.list().entries()) {
|
|
990
|
+
const tab = doc.createElement('button');
|
|
991
|
+
tab.type = 'button';
|
|
992
|
+
tab.disabled = !available.includes(plugin);
|
|
993
|
+
tab.setAttribute('aria-disabled', String(tab.disabled));
|
|
994
|
+
tab.id = `${output.id}-tab-${index}`;
|
|
995
|
+
tab.dataset.rendererId = plugin.id;
|
|
996
|
+
tab.setAttribute('role', 'tab');
|
|
997
|
+
tab.setAttribute('aria-controls', output.id);
|
|
998
|
+
const selected = plugin === renderer;
|
|
999
|
+
tab.setAttribute('aria-selected', String(selected));
|
|
1000
|
+
tab.tabIndex = 0;
|
|
1001
|
+
tab.textContent = localize(plugin.label, locale);
|
|
1002
|
+
appendIcon(tab, plugin.icon);
|
|
1003
|
+
if (selected) output.setAttribute('aria-labelledby', tab.id);
|
|
1004
|
+
tab.addEventListener('click', () => {
|
|
1005
|
+
if (selectedRenderer === plugin.id) return;
|
|
1006
|
+
selectedRenderer = plugin.id;
|
|
1007
|
+
renderResult();
|
|
1008
|
+
resultTabs
|
|
1009
|
+
.querySelector<HTMLButtonElement>('[aria-selected="true"]')
|
|
1010
|
+
?.focus();
|
|
1011
|
+
});
|
|
1012
|
+
const info = doc.createElement('button');
|
|
1013
|
+
info.type = 'button';
|
|
1014
|
+
info.className = 'ldforge-renderer-info-toggle';
|
|
1015
|
+
info.dataset.rendererInfo = plugin.id;
|
|
1016
|
+
info.setAttribute('aria-controls', rendererInfo.id);
|
|
1017
|
+
info.setAttribute('aria-expanded', 'false');
|
|
1018
|
+
const infoLabel = translate(locale, 'rendererBindingContract', {
|
|
1019
|
+
renderer: localize(plugin.label, locale),
|
|
1020
|
+
});
|
|
1021
|
+
info.setAttribute('aria-label', infoLabel);
|
|
1022
|
+
info.title = infoLabel;
|
|
1023
|
+
appendIcon(
|
|
1024
|
+
info,
|
|
1025
|
+
createSvgIcon([
|
|
1026
|
+
'M12 3a9 9 0 1 0 0 18 9 9 0 0 0 0-18',
|
|
1027
|
+
'M12 11v6m0-10v.01',
|
|
1028
|
+
]),
|
|
1029
|
+
);
|
|
1030
|
+
const closeInfo = () => {
|
|
1031
|
+
rendererInfo.hidden = true;
|
|
1032
|
+
info.setAttribute('aria-expanded', 'false');
|
|
1033
|
+
pickerToggle.focus();
|
|
1034
|
+
};
|
|
1035
|
+
info.addEventListener('click', () => {
|
|
1036
|
+
const opening = info.getAttribute('aria-expanded') !== 'true';
|
|
1037
|
+
picker.open = false;
|
|
1038
|
+
resultTabs
|
|
1039
|
+
.querySelectorAll('[data-renderer-info]')
|
|
1040
|
+
.forEach((button) => button.setAttribute('aria-expanded', 'false'));
|
|
1041
|
+
rendererInfo.hidden = !opening;
|
|
1042
|
+
if (opening) {
|
|
1043
|
+
info.setAttribute('aria-expanded', 'true');
|
|
1044
|
+
rendererInfo.setAttribute('aria-label', infoLabel);
|
|
1045
|
+
renderRendererInfo(rendererInfo, plugin, locale, closeInfo);
|
|
1046
|
+
rendererInfo.querySelector<HTMLButtonElement>('button')?.focus();
|
|
1047
|
+
rendererInfo.onkeydown = (event) => {
|
|
1048
|
+
if (event.key === 'Escape') {
|
|
1049
|
+
event.preventDefault();
|
|
1050
|
+
closeInfo();
|
|
1051
|
+
}
|
|
1052
|
+
};
|
|
1053
|
+
}
|
|
1054
|
+
});
|
|
1055
|
+
const item = doc.createElement('div');
|
|
1056
|
+
item.className = 'ldforge-result-tab-item';
|
|
1057
|
+
item.setAttribute('role', 'presentation');
|
|
1058
|
+
if (selected || visiblePlugins.has(plugin.id)) {
|
|
1059
|
+
if (selected) item.classList.add('ldforge-result-tab-active');
|
|
1060
|
+
item.append(tab);
|
|
1061
|
+
resultTabs.insertBefore(item, picker);
|
|
1062
|
+
} else {
|
|
1063
|
+
item.append(tab, info);
|
|
1064
|
+
pickerOptions.append(item);
|
|
1065
|
+
}
|
|
1066
|
+
}
|
|
1067
|
+
picker.hidden =
|
|
1068
|
+
!availablePluginsVisible || pickerOptions.childElementCount === 0;
|
|
1069
|
+
}
|
|
1070
|
+
|
|
691
1071
|
function renderResult(): void {
|
|
692
1072
|
const previousCleanup = cleanup;
|
|
693
1073
|
cleanup = undefined;
|
|
694
1074
|
try {
|
|
695
1075
|
previousCleanup?.();
|
|
696
1076
|
output.replaceChildren();
|
|
1077
|
+
rendererWarning.hidden = true;
|
|
1078
|
+
rendererWarningText.textContent = '';
|
|
1079
|
+
rendererInfo.hidden = true;
|
|
1080
|
+
rendererInfo.replaceChildren();
|
|
697
1081
|
resultTabs.replaceChildren();
|
|
698
1082
|
resultTabs.hidden = true;
|
|
699
1083
|
rendererDocs.hidden = true;
|
|
@@ -709,6 +1093,41 @@ export function createEditor(
|
|
|
709
1093
|
const available = renderers
|
|
710
1094
|
.list()
|
|
711
1095
|
.filter((renderer) => renderer.supports(state.result));
|
|
1096
|
+
const requestedView = executedDirectives.view;
|
|
1097
|
+
if (
|
|
1098
|
+
requestedView &&
|
|
1099
|
+
!available.some((plugin) => plugin.id === requestedView)
|
|
1100
|
+
) {
|
|
1101
|
+
const requested = renderers
|
|
1102
|
+
.list()
|
|
1103
|
+
.find((plugin) => plugin.id === requestedView);
|
|
1104
|
+
const missing =
|
|
1105
|
+
requested?.wizard?.bindings.filter(
|
|
1106
|
+
(binding) =>
|
|
1107
|
+
binding.required &&
|
|
1108
|
+
(state.result.kind !== 'bindings' ||
|
|
1109
|
+
!state.result.variables.includes(binding.variable)),
|
|
1110
|
+
) ?? [];
|
|
1111
|
+
rendererWarningText.textContent = translate(
|
|
1112
|
+
locale,
|
|
1113
|
+
requested ? 'rendererUnsupported' : 'rendererUnavailable',
|
|
1114
|
+
{
|
|
1115
|
+
renderer: requested
|
|
1116
|
+
? localize(requested.label, locale)
|
|
1117
|
+
: requestedView,
|
|
1118
|
+
},
|
|
1119
|
+
);
|
|
1120
|
+
if (missing.length) {
|
|
1121
|
+
rendererWarningText.textContent +=
|
|
1122
|
+
' ' +
|
|
1123
|
+
translate(locale, 'rendererMissingBindings', {
|
|
1124
|
+
bindings: missing
|
|
1125
|
+
.map((binding) => `?${binding.variable}`)
|
|
1126
|
+
.join(', '),
|
|
1127
|
+
});
|
|
1128
|
+
}
|
|
1129
|
+
rendererWarning.hidden = false;
|
|
1130
|
+
}
|
|
712
1131
|
if (applyPreferredView) {
|
|
713
1132
|
if (available.some((plugin) => plugin.id === executedDirectives.view))
|
|
714
1133
|
selectedRenderer = executedDirectives.view;
|
|
@@ -717,30 +1136,7 @@ export function createEditor(
|
|
|
717
1136
|
const renderer =
|
|
718
1137
|
available.find((plugin) => plugin.id === selectedRenderer) ??
|
|
719
1138
|
available[0];
|
|
720
|
-
|
|
721
|
-
for (const [index, plugin] of available.entries()) {
|
|
722
|
-
const tab = doc.createElement('button');
|
|
723
|
-
tab.type = 'button';
|
|
724
|
-
tab.id = `${output.id}-tab-${index}`;
|
|
725
|
-
tab.dataset.rendererId = plugin.id;
|
|
726
|
-
tab.setAttribute('role', 'tab');
|
|
727
|
-
tab.setAttribute('aria-controls', output.id);
|
|
728
|
-
const selected = plugin === renderer;
|
|
729
|
-
tab.setAttribute('aria-selected', String(selected));
|
|
730
|
-
tab.tabIndex = selected ? 0 : -1;
|
|
731
|
-
tab.textContent = localize(plugin.label, locale);
|
|
732
|
-
appendIcon(tab, plugin.icon);
|
|
733
|
-
if (selected) output.setAttribute('aria-labelledby', tab.id);
|
|
734
|
-
tab.addEventListener('click', () => {
|
|
735
|
-
if (selectedRenderer === plugin.id) return;
|
|
736
|
-
selectedRenderer = plugin.id;
|
|
737
|
-
renderResult();
|
|
738
|
-
resultTabs
|
|
739
|
-
.querySelector<HTMLButtonElement>('[aria-selected="true"]')
|
|
740
|
-
?.focus();
|
|
741
|
-
});
|
|
742
|
-
resultTabs.append(tab);
|
|
743
|
-
}
|
|
1139
|
+
renderPluginPicker(available, renderer);
|
|
744
1140
|
if (!renderer) {
|
|
745
1141
|
output.textContent = translate(locale, 'noRenderer');
|
|
746
1142
|
return;
|
|
@@ -775,11 +1171,23 @@ export function createEditor(
|
|
|
775
1171
|
}
|
|
776
1172
|
}
|
|
777
1173
|
|
|
1174
|
+
doc.addEventListener('pointerdown', dismissRendererPicker);
|
|
1175
|
+
function dismissRendererPicker(event: Event): void {
|
|
1176
|
+
const picker =
|
|
1177
|
+
resultTabs.querySelector<HTMLDetailsElement>('details[open]');
|
|
1178
|
+
if (picker && !picker.contains(event.target as Node)) picker.open = false;
|
|
1179
|
+
}
|
|
1180
|
+
|
|
778
1181
|
resultTabs.addEventListener('keydown', (event) => {
|
|
779
1182
|
if (!['ArrowLeft', 'ArrowRight', 'Home', 'End'].includes(event.key)) return;
|
|
780
1183
|
const tabs = [
|
|
781
|
-
...resultTabs.querySelectorAll<HTMLButtonElement>(
|
|
782
|
-
|
|
1184
|
+
...resultTabs.querySelectorAll<HTMLButtonElement>(
|
|
1185
|
+
'[role="tab"]:not(:disabled)',
|
|
1186
|
+
),
|
|
1187
|
+
].filter((tab) => {
|
|
1188
|
+
const picker = tab.closest('details');
|
|
1189
|
+
return !picker || picker.open;
|
|
1190
|
+
});
|
|
783
1191
|
const current = tabs.indexOf(doc.activeElement as HTMLButtonElement);
|
|
784
1192
|
if (current < 0) return;
|
|
785
1193
|
event.preventDefault();
|
|
@@ -909,7 +1317,7 @@ export function createEditor(
|
|
|
909
1317
|
tab.setAttribute('aria-selected', String(selected));
|
|
910
1318
|
if (tab.parentElement)
|
|
911
1319
|
tab.parentElement.dataset.active = String(selected);
|
|
912
|
-
tab.tabIndex =
|
|
1320
|
+
tab.tabIndex = 0;
|
|
913
1321
|
if (selected) editorHost.setAttribute('aria-labelledby', tab.id);
|
|
914
1322
|
}
|
|
915
1323
|
}
|
|
@@ -918,8 +1326,10 @@ export function createEditor(
|
|
|
918
1326
|
}
|
|
919
1327
|
|
|
920
1328
|
function refreshLocale(): void {
|
|
1329
|
+
autoGrowControl.refresh();
|
|
921
1330
|
fontSizeControl.refresh();
|
|
922
1331
|
rendererWizard.refreshLocale();
|
|
1332
|
+
shareControl.refreshLocale();
|
|
923
1333
|
prefixPicker.refreshLocale();
|
|
924
1334
|
tools.setAttribute('aria-label', translate(locale, 'coreTools'));
|
|
925
1335
|
customActions.setAttribute('aria-label', translate(locale, 'extraActions'));
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { localize, translate } from '@ldforge/core';
|
|
2
|
+
import type { Locale, ResultRendererPlugin } from '@ldforge/core';
|
|
3
|
+
|
|
4
|
+
/** Shared metadata contract for built-in and host-provided renderers. */
|
|
5
|
+
export function renderRendererInfo(
|
|
6
|
+
panel: HTMLElement,
|
|
7
|
+
plugin: ResultRendererPlugin,
|
|
8
|
+
locale: Locale,
|
|
9
|
+
close: () => void,
|
|
10
|
+
): void {
|
|
11
|
+
const doc = panel.ownerDocument;
|
|
12
|
+
panel.replaceChildren();
|
|
13
|
+
const heading = doc.createElement('strong');
|
|
14
|
+
heading.textContent = translate(locale, 'rendererBindingContract', {
|
|
15
|
+
renderer: localize(plugin.label, locale),
|
|
16
|
+
});
|
|
17
|
+
const dismiss = doc.createElement('button');
|
|
18
|
+
dismiss.type = 'button';
|
|
19
|
+
dismiss.className = 'ldforge-renderer-info-close';
|
|
20
|
+
dismiss.textContent = '×';
|
|
21
|
+
dismiss.setAttribute('aria-label', translate(locale, 'rendererInfoClose'));
|
|
22
|
+
dismiss.addEventListener('click', close);
|
|
23
|
+
panel.append(heading, dismiss);
|
|
24
|
+
if (plugin.wizard?.description) {
|
|
25
|
+
const description = doc.createElement('p');
|
|
26
|
+
description.textContent = localize(plugin.wizard.description, locale);
|
|
27
|
+
panel.append(description);
|
|
28
|
+
}
|
|
29
|
+
if (plugin.wizard?.bindings.length) {
|
|
30
|
+
const list = doc.createElement('dl');
|
|
31
|
+
for (const binding of plugin.wizard.bindings) {
|
|
32
|
+
const term = doc.createElement('dt');
|
|
33
|
+
const variable = doc.createElement('code');
|
|
34
|
+
variable.textContent = `?${binding.variable}`;
|
|
35
|
+
term.append(
|
|
36
|
+
variable,
|
|
37
|
+
` · ${translate(locale, binding.required ? 'rendererBindingRequired' : 'rendererBindingOptional')}`,
|
|
38
|
+
);
|
|
39
|
+
const description = doc.createElement('dd');
|
|
40
|
+
description.textContent = localize(binding.description, locale);
|
|
41
|
+
list.append(term, description);
|
|
42
|
+
}
|
|
43
|
+
panel.append(list);
|
|
44
|
+
} else {
|
|
45
|
+
const empty = doc.createElement('p');
|
|
46
|
+
empty.textContent = translate(
|
|
47
|
+
locale,
|
|
48
|
+
plugin.wizard ? 'rendererNoNamedBindings' : 'rendererNoBindingContract',
|
|
49
|
+
);
|
|
50
|
+
panel.append(empty);
|
|
51
|
+
}
|
|
52
|
+
}
|