@quillmark/svelte 0.11.0 → 0.13.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.
Files changed (62) hide show
  1. package/dist/core/address.d.ts +17 -10
  2. package/dist/core/address.js +26 -12
  3. package/dist/core/bloom.js +4 -3
  4. package/dist/core/codec/decode.d.ts +17 -0
  5. package/dist/core/codec/decode.js +78 -19
  6. package/dist/core/codec/encode.js +1 -1
  7. package/dist/core/codec/field.d.ts +64 -15
  8. package/dist/core/codec/field.js +201 -65
  9. package/dist/core/codec/index.d.ts +3 -3
  10. package/dist/core/codec/index.js +3 -3
  11. package/dist/core/codec/islands.d.ts +5 -4
  12. package/dist/core/codec/islands.js +23 -38
  13. package/dist/core/codec/keymap.d.ts +5 -4
  14. package/dist/core/codec/keymap.js +5 -4
  15. package/dist/core/codec/prose.css +42 -0
  16. package/dist/core/codec/schema.d.ts +24 -5
  17. package/dist/core/codec/schema.js +40 -9
  18. package/dist/core/codec/slash.js +0 -0
  19. package/dist/core/errors.d.ts +3 -2
  20. package/dist/core/rungs.d.ts +8 -0
  21. package/dist/core/rungs.js +24 -0
  22. package/dist/core/theme.css +19 -6
  23. package/dist/preview/paint.js +21 -17
  24. package/dist/visual/ArrayField.svelte +649 -176
  25. package/dist/visual/ArrayField.svelte.d.ts +16 -1
  26. package/dist/visual/BooleanField.svelte +36 -11
  27. package/dist/visual/BooleanField.svelte.d.ts +2 -0
  28. package/dist/visual/Card.svelte +6 -25
  29. package/dist/visual/DateField.svelte +66 -31
  30. package/dist/visual/EnumField.svelte +27 -9
  31. package/dist/visual/EnumField.svelte.d.ts +5 -0
  32. package/dist/visual/Field.svelte +113 -38
  33. package/dist/visual/FormatPopover.svelte +4 -3
  34. package/dist/visual/MatrixField.svelte +353 -0
  35. package/dist/visual/MatrixField.svelte.d.ts +36 -0
  36. package/dist/visual/NumberField.svelte +31 -14
  37. package/dist/visual/NumberField.svelte.d.ts +5 -1
  38. package/dist/visual/ObjectField.svelte +404 -139
  39. package/dist/visual/ObjectField.svelte.d.ts +17 -2
  40. package/dist/visual/ProseField.svelte +53 -23
  41. package/dist/visual/ProseField.svelte.d.ts +15 -3
  42. package/dist/visual/ProseValue.svelte +102 -46
  43. package/dist/visual/ProseValue.svelte.d.ts +17 -5
  44. package/dist/visual/TextField.svelte +35 -18
  45. package/dist/visual/TextField.svelte.d.ts +7 -0
  46. package/dist/visual/VariantField.svelte +56 -2
  47. package/dist/visual/VariantField.svelte.d.ts +10 -1
  48. package/dist/visual/VisualEditorInner.svelte +77 -73
  49. package/dist/visual/controls.css +47 -5
  50. package/dist/visual/diagnostics.d.ts +26 -2
  51. package/dist/visual/diagnostics.js +52 -5
  52. package/dist/visual/hold.js +2 -2
  53. package/dist/visual/icons/nodes.d.ts +3 -0
  54. package/dist/visual/icons/nodes.js +2 -1
  55. package/dist/visual/leaves.d.ts +25 -12
  56. package/dist/visual/motion.d.ts +14 -5
  57. package/dist/visual/motion.js +13 -11
  58. package/dist/visual/strings.d.ts +27 -10
  59. package/dist/visual/strings.js +8 -2
  60. package/dist/visual/structure.d.ts +159 -40
  61. package/dist/visual/structure.js +337 -45
  62. package/package.json +2 -2
@@ -1,4 +1,8 @@
1
1
  import type { Content, PathStep, QuillFieldSchema } from '@quillmark/wasm';
2
+ import { type DeepDiagnostic } from './diagnostics.js';
3
+ import type { LandingBox } from './leaves.js';
4
+ import ObjectField from './ObjectField.svelte';
5
+ import './controls.css';
2
6
  interface Props {
3
7
  value: Record<string, unknown> | undefined;
4
8
  properties: Record<string, QuillFieldSchema> | undefined;
@@ -11,8 +15,8 @@ interface Props {
11
15
  /**
12
16
  * The parent control's DOM id: the base each property's own three names derive
13
17
  * from ({@link propertyDomIds}). Absent — a subform mounted with no field around
14
- * it — the properties fall back to `aria-label`, which names them without a
15
- * `for` target to click.
18
+ * it, or a table's row — the properties fall back to `aria-label`, which names
19
+ * them without a `for` target to click.
16
20
  */
17
21
  idBase?: string;
18
22
  /** Accessible-name prefix used only on the `aria-label` fallback above. */
@@ -24,9 +28,20 @@ interface Props {
24
28
  * `undefined` for a property the stored value does not reach. */
25
29
  contentAt: (path: PathStep[]) => Content | undefined;
26
30
  onCommit: (obj: Record<string, unknown>) => void;
31
+ /** A table's row: the cells alone, on the tracks the table's header names, with
32
+ * no labels and no vertical of their own. */
33
+ bare?: boolean;
34
+ /** Raw keydown off a text or prose cell, for a row whose own keys run through its
35
+ * cells: the table's Enter and Backspace ({@link ArrayField}). */
36
+ onCellKey?: (e: KeyboardEvent, key: string) => void;
37
+ /** The diagnostics routed into this subform, each with its steps still to walk:
38
+ * one naming a property draws under that property's control, and one naming
39
+ * nothing this subform holds draws at its foot (`diagnostics.ts`). */
40
+ diagnostics?: readonly DeepDiagnostic[];
27
41
  }
28
42
  declare const ObjectField: import("svelte").Component<Props, {
29
43
  focus: () => void;
44
+ focusPath: (steps: readonly PathStep[], pos?: number) => LandingBox;
30
45
  }, "">;
31
46
  type ObjectField = ReturnType<typeof ObjectField>;
32
47
  export default ObjectField;
@@ -11,7 +11,7 @@
11
11
  import SlashMenu from './SlashMenu.svelte';
12
12
  import { wording } from './strings.js';
13
13
  import './controls.css';
14
- import type { Document, Quill, Addr } from '@quillmark/wasm';
14
+ import type { Document, Quill, Addr, Content, Diagnostic } from '@quillmark/wasm';
15
15
  import type { EditorErrorHandler } from '../core/errors.js';
16
16
 
17
17
  interface Props {
@@ -37,9 +37,18 @@
37
37
  labelledBy?: string;
38
38
  /** The parked `description` (FieldLabel) → `aria-describedby`. */
39
39
  describedBy?: string;
40
- /** Ghost shown on the empty leaf: an inline leaf's resolved `default:` or
41
- * nothing, a body's always text (`resolveBodyGhost`). */
40
+ /** The resolved `default:` where it prints: what an unset field's leaf holds
41
+ * until an edit takes it (`createField`). */
42
+ fallback?: Content;
43
+ /** Ghost shown on the empty leaf: the `none` an optional field prints unset, or
44
+ * nothing, and a body's always text (`resolveBodyGhost`). */
42
45
  placeholder?: string;
46
+ /** A field's leaf, whose placeholder goes at its first edit (`createField`). */
47
+ placeholderUntilEdit?: boolean;
48
+ /** Ghost shown on the empty leaf until its first edit, and in the placeholder's
49
+ * stead while the leaf holds the focus: an unset field's `example:`
50
+ * (`exampleGhost`). */
51
+ example?: string;
43
52
  /** Registry identity, stamped on the DOM node so a remount is visible as one. */
44
53
  leafKey: string;
45
54
  onFocus?: (addr: Addr) => void;
@@ -50,6 +59,9 @@
50
59
  /** The editor's leaf registry (`leaves.ts`). Registering the controller is what
51
60
  * makes this leaf a caret target and not merely a focus one. */
52
61
  leaves?: LeafRegistry;
62
+ /** The diagnostics routed to this field: each set re-evaluates a hold
63
+ * (`createField`), a re-validation being what follows an external write. */
64
+ diagnostics?: Diagnostic[];
53
65
  }
54
66
 
55
67
  let {
@@ -62,16 +74,23 @@
62
74
  label,
63
75
  labelledBy,
64
76
  describedBy,
77
+ fallback,
65
78
  placeholder,
79
+ placeholderUntilEdit,
80
+ example,
66
81
  leafKey,
67
82
  onFocus,
68
83
  onCaretMove,
69
84
  onChange,
70
85
  onError,
71
- leaves
86
+ leaves,
87
+ diagnostics
72
88
  }: Props = $props();
73
89
 
74
90
  let containerEl: HTMLDivElement | undefined = $state();
91
+ let held = $state(false);
92
+ const uid = $props.id();
93
+ const heldId = `${uid}-held`;
75
94
 
76
95
  // Handed to the codec as a getter: the island chrome redraws on each render, so a
77
96
  // locale swap reaches a mounted table without remounting the leaf and losing the caret.
@@ -82,10 +101,9 @@
82
101
  * trigger mounting on the block schema alone. */
83
102
  let slash: SlashState | undefined = $state();
84
103
 
85
- // The codec's own schema predicate (`createField`: `plaintext` implies `inline`), so
86
- // the box a leaf draws and the schema it holds cannot disagree. On `inline` alone a
87
- // `plaintext` field would take the block floor while holding one paragraph.
88
- const block = $derived(!(inline || plaintext));
104
+ // The codec's own schema predicate (`leafSchema`: `inline` is one textblock at either
105
+ // type), so the box a leaf draws and the schema it holds cannot disagree.
106
+ const block = $derived(!inline);
89
107
 
90
108
  let controller: FieldController | undefined;
91
109
 
@@ -107,7 +125,10 @@
107
125
  label,
108
126
  labelledBy,
109
127
  describedBy,
128
+ fallback,
110
129
  placeholder,
130
+ placeholderUntilEdit,
131
+ example,
111
132
  tableStrings: () => t.strings,
112
133
  onSlash: (next) => {
113
134
  slash = next;
@@ -115,7 +136,11 @@
115
136
  onFocus,
116
137
  onCaretMove,
117
138
  onChange,
118
- onError
139
+ onError,
140
+ heldNoteId: heldId,
141
+ onHold: (next) => {
142
+ held = next;
143
+ }
119
144
  });
120
145
  leaves?.registerProse(leafKey, controller);
121
146
  return () => {
@@ -126,10 +151,23 @@
126
151
  });
127
152
 
128
153
  // A retype does not remount the leaf (its key is the card's session id), so the new
129
- // kind's ghost is pushed into the live view rather than paid for with the caret.
154
+ // kind's ghost and default are pushed into the live view rather than paid for with
155
+ // the caret.
130
156
  $effect(() => {
131
157
  controller?.setPlaceholder(placeholder);
132
158
  });
159
+ $effect(() => {
160
+ controller?.setExample(example);
161
+ });
162
+ $effect(() => {
163
+ controller?.setFallback(fallback);
164
+ });
165
+
166
+ // Only a narrowed or a plain leaf can hold, so only one of them asks.
167
+ $effect(() => {
168
+ void diagnostics;
169
+ if (inline || plaintext) controller?.applyExternal();
170
+ });
133
171
  </script>
134
172
 
135
173
  <div
@@ -139,7 +177,11 @@
139
177
  class:qm-focus-ring-within={!unframed}
140
178
  class:qm-prose-block={block}
141
179
  data-leaf-key={leafKey}
142
- ></div>
180
+ >
181
+ {#if held}
182
+ <span id={heldId} class="qm-prose-held-note">{t.strings.proseHeld}</span>
183
+ {/if}
184
+ </div>
143
185
  <SlashMenu menu={slash} leaf={() => controller} label={t.strings.slashLabel} />
144
186
 
145
187
  <style>
@@ -179,16 +221,4 @@
179
221
  .qm-prose :global(.ProseMirror) {
180
222
  outline: none;
181
223
  }
182
- /* Empty-leaf ghost, at the rung every scalar's placeholder takes: a node decoration's
183
- data attr, so it stays out of the document; `float`/`height: 0` keep it from
184
- displacing the caret. The italic is what a leaf with no written neighbour has
185
- instead of the step to `ink`. */
186
- .qm-prose :global(.ProseMirror .qm-prose-placeholder::before) {
187
- content: attr(data-placeholder);
188
- color: var(--_qm-ink-label);
189
- font-style: italic;
190
- float: left;
191
- height: 0;
192
- pointer-events: none;
193
- }
194
224
  </style>
@@ -1,6 +1,6 @@
1
1
  import type { LeafRegistry } from './leaves.js';
2
2
  import './controls.css';
3
- import type { Document, Quill, Addr } from '@quillmark/wasm';
3
+ import type { Document, Quill, Addr, Content, Diagnostic } from '@quillmark/wasm';
4
4
  import type { EditorErrorHandler } from '../core/errors.js';
5
5
  interface Props {
6
6
  doc: Document;
@@ -25,9 +25,18 @@ interface Props {
25
25
  labelledBy?: string;
26
26
  /** The parked `description` (FieldLabel) → `aria-describedby`. */
27
27
  describedBy?: string;
28
- /** Ghost shown on the empty leaf: an inline leaf's resolved `default:` or
29
- * nothing, a body's always text (`resolveBodyGhost`). */
28
+ /** The resolved `default:` where it prints: what an unset field's leaf holds
29
+ * until an edit takes it (`createField`). */
30
+ fallback?: Content;
31
+ /** Ghost shown on the empty leaf: the `none` an optional field prints unset, or
32
+ * nothing, and a body's always text (`resolveBodyGhost`). */
30
33
  placeholder?: string;
34
+ /** A field's leaf, whose placeholder goes at its first edit (`createField`). */
35
+ placeholderUntilEdit?: boolean;
36
+ /** Ghost shown on the empty leaf until its first edit, and in the placeholder's
37
+ * stead while the leaf holds the focus: an unset field's `example:`
38
+ * (`exampleGhost`). */
39
+ example?: string;
31
40
  /** Registry identity, stamped on the DOM node so a remount is visible as one. */
32
41
  leafKey: string;
33
42
  onFocus?: (addr: Addr) => void;
@@ -38,6 +47,9 @@ interface Props {
38
47
  /** The editor's leaf registry (`leaves.ts`). Registering the controller is what
39
48
  * makes this leaf a caret target and not merely a focus one. */
40
49
  leaves?: LeafRegistry;
50
+ /** The diagnostics routed to this field: each set re-evaluates a hold
51
+ * (`createField`), a re-validation being what follows an external write. */
52
+ diagnostics?: Diagnostic[];
41
53
  }
42
54
  declare const ProseField: import("svelte").Component<Props, {
43
55
  focus: () => void;
@@ -4,12 +4,12 @@
4
4
  `object`'s property, a variant's cell ({@link ObjectField}). None of them is
5
5
  `applyChange`-addressable: `Addr.field` is a flat name, so `keywords[0]` and
6
6
  `contact.note` have no op address. So this is not a `createField` leaf: it mounts a
7
- minimal PM view over the codec's decode/encode + inline schema, and on every edit
7
+ minimal PM view over the codec's decode/encode and a leaf schema, and on every edit
8
8
  hands the re-encoded `Content` up to the parent — {@link ArrayField}, which commits
9
9
  the whole array, or {@link ObjectField}, which commits the whole container
10
- (`writer.set(field, next)`). Anchors inside a value are dropped on that write:
11
- acceptable for inline refs. Mounts once per stable key (an element's session id, a
12
- property's name), so the parent's re-derive leaves the caret where it is.
10
+ (`writer.set(field, next)`). Anchors inside a value are dropped on that write.
11
+ Mounts once per stable key (an element's session id, a property's name), so the
12
+ parent's re-derive leaves the caret where it is.
13
13
 
14
14
  The content is read, not passed: `reader.getContentAt(addr, path)` decodes through
15
15
  the codec the leaf's own declared type names, so what it rests as — the content
@@ -17,37 +17,55 @@
17
17
  being the row's or the cell's business. Read once, at mount, since that is when this
18
18
  leaf takes its state.
19
19
 
20
- One textblock wherever it mounts, no islands and no slash menu. `plaintext` is
21
- inline at the codec, so that is the declared shape for every plaintext leaf; a block
22
- `richtext` is held one rung narrower than it declares, having no room for a second
23
- paragraph in the figure a repeater row and a subform cell draw.
20
+ The schema is the declared type's where the parent has room for it: a subform cell
21
+ declaring no `inline` takes the full row ({@link ObjectField}), a `richtext` one on the
22
+ block schema and a `plaintext` one on the plain schema, paragraphs and hard breaks.
23
+ An array element is one textblock whatever it declares, since Enter there is the
24
+ repeater's. There is no slash menu at either width, and an island draws as its
25
+ placeholder: an atom a keystroke can delete and no view edits.
26
+
27
+ A leaf over content its schema cannot hold is held: a narrowed one over anything but
28
+ one plain paragraph (`fitsInline`), a plain one over anything but plain lines
29
+ (`fitsPlain`). Its decode would join or drop what is left over, and the first
30
+ keystroke would write that loss back, so a held leaf draws its content on the block
31
+ schema, read-only, with a note inside its box, and commits nothing.
24
32
  -->
25
33
  <script lang="ts">
26
34
  import { onMount } from 'svelte';
27
35
  import { EditorState, Selection } from 'prosemirror-state';
28
36
  import { EditorView } from 'prosemirror-view';
29
37
  import {
38
+ blockSchema,
30
39
  decode,
40
+ emptyContent,
41
+ fitsLeaf,
42
+ heldAttributes,
43
+ leafSchema,
31
44
  pmToContent,
32
- inlineSchema,
33
- plaintextSchema,
34
45
  proseAttributes,
35
46
  proseLeafPlugins,
36
47
  buildLineIndex,
37
48
  usvToPM
38
49
  } from '../core/codec/index.js';
50
+ import { wording } from './strings.js';
39
51
  import './controls.css';
40
52
  import type { Content } from '@quillmark/wasm';
41
53
 
42
54
  interface Props {
43
- /** This leaf's content, read at mount (the parent's boundary read). A thunk
44
- * rather than a value: the parent re-derives per revision and this leaf takes
45
- * its state once, so a value prop would be a boundary read per leaf per render,
46
- * all but one of them discarded. */
47
- content: () => Content;
55
+ /** This leaf's content, read at mount (the parent's boundary read), `undefined`
56
+ * where nothing is stored. A thunk rather than a value: the parent re-derives
57
+ * per revision and this leaf takes its state once, so a value prop would be a
58
+ * boundary read per leaf per render, all but one of them discarded. */
59
+ content: () => Content | undefined;
60
+ /** The default an unset leaf holds, where it prints: drawn at the default rung,
61
+ * and handed up whole with the first edit in it, as `createField` takes one. */
62
+ fallback?: Content;
48
63
  /** The mark-free schema (a `plaintext` leaf): literal text, no formatting,
49
64
  * exactly as the scalar field of that type mounts. */
50
65
  plaintext?: boolean;
66
+ /** A multi-block schema, for a cell the parent draws at full width: the block
67
+ * schema, or the plain one with `plaintext`. Absent, the leaf is one textblock. */
68
+ block?: boolean;
51
69
  /** Accessible name for the editable region, where nothing else names it: an
52
70
  * array has no per-element label. A cell with a label element takes
53
71
  * `labelledBy`. */
@@ -58,6 +76,12 @@
58
76
  labelledBy?: string;
59
77
  /** The parked `description` (FieldLabel) → `aria-describedby`. */
60
78
  describedBy?: string;
79
+ /** The empty leaf's ghosts, a subform cell's, until the leaf's first edit: the
80
+ * `none` an optional cell prints unset, and the `example:` drawn where there is no
81
+ * placeholder and in its stead while the leaf holds the focus (`createField`'s
82
+ * pair). Read per decoration pass. */
83
+ placeholder?: string;
84
+ example?: string;
61
85
  onChange: (rt: Content) => void;
62
86
  /** Raw keydown, for a container whose own keys run through this leaf: the
63
87
  * array repeater's Enter/Backspace (`ArrayField`). Fires before the view's own
@@ -66,15 +90,23 @@
66
90
  }
67
91
  let {
68
92
  content,
93
+ fallback,
69
94
  plaintext = false,
95
+ block = false,
70
96
  label,
71
97
  labelledBy,
72
98
  describedBy,
99
+ placeholder,
100
+ example,
73
101
  onChange,
74
102
  onKey
75
103
  }: Props = $props();
76
104
 
77
- let containerEl: HTMLDivElement | undefined = $state();
105
+ const t = wording();
106
+ const uid = $props.id();
107
+ const heldId = `${uid}-held`;
108
+ let editorEl: HTMLDivElement | undefined = $state();
109
+ let held = $state(false);
78
110
  let view: EditorView | undefined;
79
111
  /** Take the caret: what a parent placing focus on this leaf calls. The view's
80
112
  * focus, not the element's: a PM view restores its selection, where a bare DOM
@@ -107,39 +139,55 @@
107
139
  }
108
140
 
109
141
  onMount(() => {
110
- if (!containerEl) return;
111
- // An inline, value-by-value leaf: the same keymap and plugin stack a
112
- // `createField` leaf mounts (shared `proseLeafPlugins`), minus the
113
- // anchor-position plugin (anchors are dropped on the parent's value write, per
114
- // the header). Its own `dispatchTransaction` hands `Content` up.
115
- //
116
- // The schema is the declared type's, as `createField` picks it: `plaintext`
117
- // declares no mark types, so there is nothing to toggle, to paste in, or to
118
- // mint a shorthand with.
119
- const schema = plaintext ? plaintextSchema : inlineSchema;
120
- const pmDoc = decode(content(), schema);
142
+ if (!editorEl) return;
143
+ // The same keymap and plugin stack a `createField` leaf mounts (shared
144
+ // `proseLeafPlugins`), minus the anchor-position plugin: anchors are dropped on
145
+ // the parent's value write, per the header.
146
+ const inline = !block;
147
+ const stored = content();
148
+ const rt = stored ?? fallback ?? emptyContent();
149
+ let defaulted = stored === undefined && !!fallback;
150
+ held = !fitsLeaf(rt, { inline, plaintext });
151
+ const named = held
152
+ ? heldAttributes({ label, labelledBy, describedBy }, heldId)
153
+ : (proseAttributes({ label, labelledBy, describedBy }) ?? {});
154
+ const defaultNamed = { ...named, 'data-default': '' };
155
+ const schema = held ? blockSchema : leafSchema({ plaintext, inline });
121
156
  const state = EditorState.create({
122
- doc: pmDoc,
123
- plugins: proseLeafPlugins(schema, { inline: true })
157
+ doc: decode(rt, schema),
158
+ plugins: held
159
+ ? []
160
+ : proseLeafPlugins(schema, {
161
+ inline,
162
+ placeholder: () => placeholder,
163
+ placeholderUntilEdit: true,
164
+ example: () => example
165
+ })
124
166
  });
125
- const mounted = new EditorView(containerEl, {
126
- state,
127
- // Which of `aria-label` / `aria-labelledby` wins is the codec's one answer
128
- // (`proseAttributes`), so a cell carrying a label element and a row carrying
129
- // none cannot name their regions by different rules.
130
- attributes: proseAttributes({ label, labelledBy, describedBy }),
131
- dispatchTransaction(tr) {
132
- const next = mounted.state.apply(tr);
133
- mounted.updateState(next);
134
- if (tr.docChanged) onChange(pmToContent(next.doc));
135
- },
136
- handleDOMEvents: {
137
- keydown: (_v, e) => {
138
- onKey?.(e);
139
- return false;
167
+ const mounted = new EditorView(
168
+ { mount: editorEl },
169
+ {
170
+ state,
171
+ editable: () => !held,
172
+ // Which of `aria-label` / `aria-labelledby` wins is the codec's one answer
173
+ // (`proseAttributes`), so a cell carrying a label element and a row carrying
174
+ // none cannot name their regions by different rules.
175
+ attributes: () => (defaulted ? defaultNamed : named),
176
+ dispatchTransaction(tr) {
177
+ const next = mounted.state.apply(tr);
178
+ const edit = tr.docChanged && !held;
179
+ if (edit) defaulted = false;
180
+ mounted.updateState(next);
181
+ if (edit) onChange(pmToContent(next.doc));
182
+ },
183
+ handleDOMEvents: {
184
+ keydown: (_v, e) => {
185
+ onKey?.(e);
186
+ return false;
187
+ }
140
188
  }
141
189
  }
142
- });
190
+ );
143
191
  view = mounted;
144
192
  return () => {
145
193
  view = undefined;
@@ -153,7 +201,15 @@
153
201
  like the text cell beside it. No floor: the reset in `core/codec/prose.css` makes one
154
202
  line of prose measure one line. Width is the row's or the cell's to give: the leaf
155
203
  fills the track it is placed in. -->
156
- <div bind:this={containerEl} class="qm-prose-value qm-control-box qm-focus-ring-within"></div>
204
+ <div class="qm-prose-value qm-control-box qm-focus-ring-within">
205
+ <div bind:this={editorEl}></div>
206
+ <!-- Inside the box, so the cell or row holds one child either way: a subform cell's
207
+ subgrid has a row for the label and one for the box, and an array row's slabs
208
+ stand the box's height. -->
209
+ {#if held}
210
+ <span id={heldId} class="qm-prose-held-note">{t.strings.proseHeld}</span>
211
+ {/if}
212
+ </div>
157
213
 
158
214
  <style>
159
215
  /* Caret-primary, matching ProseField: the contenteditable's own outline is
@@ -1,14 +1,20 @@
1
1
  import './controls.css';
2
2
  import type { Content } from '@quillmark/wasm';
3
3
  interface Props {
4
- /** This leaf's content, read at mount (the parent's boundary read). A thunk
5
- * rather than a value: the parent re-derives per revision and this leaf takes
6
- * its state once, so a value prop would be a boundary read per leaf per render,
7
- * all but one of them discarded. */
8
- content: () => Content;
4
+ /** This leaf's content, read at mount (the parent's boundary read), `undefined`
5
+ * where nothing is stored. A thunk rather than a value: the parent re-derives
6
+ * per revision and this leaf takes its state once, so a value prop would be a
7
+ * boundary read per leaf per render, all but one of them discarded. */
8
+ content: () => Content | undefined;
9
+ /** The default an unset leaf holds, where it prints: drawn at the default rung,
10
+ * and handed up whole with the first edit in it, as `createField` takes one. */
11
+ fallback?: Content;
9
12
  /** The mark-free schema (a `plaintext` leaf): literal text, no formatting,
10
13
  * exactly as the scalar field of that type mounts. */
11
14
  plaintext?: boolean;
15
+ /** A multi-block schema, for a cell the parent draws at full width: the block
16
+ * schema, or the plain one with `plaintext`. Absent, the leaf is one textblock. */
17
+ block?: boolean;
12
18
  /** Accessible name for the editable region, where nothing else names it: an
13
19
  * array has no per-element label. A cell with a label element takes
14
20
  * `labelledBy`. */
@@ -19,6 +25,12 @@ interface Props {
19
25
  labelledBy?: string;
20
26
  /** The parked `description` (FieldLabel) → `aria-describedby`. */
21
27
  describedBy?: string;
28
+ /** The empty leaf's ghosts, a subform cell's, until the leaf's first edit: the
29
+ * `none` an optional cell prints unset, and the `example:` drawn where there is no
30
+ * placeholder and in its stead while the leaf holds the focus (`createField`'s
31
+ * pair). Read per decoration pass. */
32
+ placeholder?: string;
33
+ example?: string;
22
34
  onChange: (rt: Content) => void;
23
35
  /** Raw keydown, for a container whose own keys run through this leaf: the
24
36
  * array repeater's Enter/Backspace (`ArrayField`). Fires before the view's own
@@ -1,12 +1,17 @@
1
1
  <!--
2
- A `string` field → text input. Commits a non-empty edit live (on input) via the
3
- parent's typed `writer.set`, so the preview tracks typing. A cleared field is the
4
- unset rung of the commitment ladder (VISUAL_EDITOR §"Structure mirrors the schema"): it
5
- commits `undefined` (the parent removes the field, ghosted `default:` renders):
6
- but at `change` (blur), not per keystroke, so select-all-and-retype doesn't flash
7
- the field through its default between the delete and the first typed char.
8
- Trade-off (recorded in VISUAL_EDITOR): an explicit empty string over a non-empty
9
- default is inexpressible from the UI: clear and unset collapse to one gesture.
2
+ A `string` field → text input. Commits every edit live (on input) via the parent's
3
+ typed `writer.set`, so the preview tracks typing.
4
+
5
+ An unset field whose `default:` prints holds that default as its text, at the
6
+ default rung (theme.css): the value it prints, drawn as one and a step off a written
7
+ one. Nothing is written until an edit, which writes the whole text as authored: the
8
+ default taken, whatever the edit left of it. Tabbing through writes nothing; a
9
+ keystroke typed and removed pins the default.
10
+
11
+ An emptied input writes what empty means for this field (VISUAL_EDITOR §"The
12
+ commitment ladder"): `""` over a default that prints, the only answer that prints empty there;
13
+ the unset rung elsewhere, where unset already prints nothing and the field stays
14
+ unanswered, and an optional cell returns to `none`.
10
15
  -->
11
16
  <script lang="ts">
12
17
  import { syncedLocal } from './synced.svelte.js';
@@ -14,7 +19,14 @@
14
19
 
15
20
  interface Props {
16
21
  value: string | undefined;
22
+ /** The resolved `default:` where it prints: the text an unset field holds. */
23
+ fallback?: string;
24
+ /** Words at rest about an unset field that holds no text: the `None` an optional
25
+ * cell prints. */
17
26
  placeholder?: string;
27
+ /** An unset field's `example:` (`exampleGhost`): drawn wherever the field holds no
28
+ * text, and in `placeholder`'s stead while the input holds the focus. */
29
+ example?: string;
18
30
  /** Accessible name for an input nothing else names: an array element, whose
19
31
  * name is the field label plus its 1-based index. A field's own input takes
20
32
  * `id` instead and is named by the `<label for>` beside it. */
@@ -29,11 +41,17 @@
29
41
  * array repeater's Enter/Backspace (`ArrayField`). */
30
42
  onKey?: (e: KeyboardEvent) => void;
31
43
  }
32
- let { value, placeholder, label, id, describedBy, onCommit, onKey }: Props = $props();
44
+ let { value, fallback, placeholder, example, label, id, describedBy, onCommit, onKey }: Props =
45
+ $props();
33
46
 
34
- // Local input state synced to `value`: own-typing stays local, only an external
35
- // change reconciles back in (see `syncedLocal`).
36
- const local = syncedLocal(() => value ?? '');
47
+ // Local input state synced to `value`, or to the default an unset field holds:
48
+ // own-typing stays local, only an external change reconciles back in (see
49
+ // `syncedLocal`).
50
+ const local = syncedLocal(() => value ?? fallback ?? '');
51
+ const defaulted = $derived(value == null && !!fallback && local.value === fallback);
52
+
53
+ let focused = $state(false);
54
+ const ghost = $derived(focused ? (example ?? placeholder) : (placeholder ?? example));
37
55
 
38
56
  let inputEl: HTMLInputElement | undefined = $state();
39
57
  /** Take the caret: what a parent placing focus on this control calls. */
@@ -48,16 +66,15 @@
48
66
  type="text"
49
67
  value={local.value}
50
68
  {id}
51
- {placeholder}
69
+ placeholder={ghost}
70
+ data-default={defaulted ? '' : undefined}
52
71
  aria-label={id ? undefined : label}
53
72
  aria-describedby={describedBy}
54
73
  onkeydown={onKey}
74
+ onfocus={() => (focused = true)}
75
+ onblur={() => (focused = false)}
55
76
  oninput={(e) => {
56
77
  local.value = (e.currentTarget as HTMLInputElement).value;
57
- // Live-commit a non-empty edit; defer a cleared field to `change` (see header).
58
- if (local.value !== '') onCommit(local.value);
59
- }}
60
- onchange={() => {
61
- if (local.value === '') onCommit(undefined);
78
+ onCommit(local.value !== '' ? local.value : fallback ? '' : undefined);
62
79
  }}
63
80
  />
@@ -1,7 +1,14 @@
1
1
  import './controls.css';
2
2
  interface Props {
3
3
  value: string | undefined;
4
+ /** The resolved `default:` where it prints: the text an unset field holds. */
5
+ fallback?: string;
6
+ /** Words at rest about an unset field that holds no text: the `None` an optional
7
+ * cell prints. */
4
8
  placeholder?: string;
9
+ /** An unset field's `example:` (`exampleGhost`): drawn wherever the field holds no
10
+ * text, and in `placeholder`'s stead while the input holds the focus. */
11
+ example?: string;
5
12
  /** Accessible name for an input nothing else names: an array element, whose
6
13
  * name is the field label plus its 1-based index. A field's own input takes
7
14
  * `id` instead and is named by the `<label for>` beside it. */