guidex 0.3.2 → 0.4.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 +133 -35
- package/dist/lib/app/editorState.d.ts +25 -23
- package/dist/lib/app/shareLink.d.ts +2 -3
- package/dist/lib/{chantLayout-B0xiaMo9.js → chantLayout-g_xuQ9nD.js} +875 -1167
- package/dist/lib/chantLayout.d.ts +37 -2
- package/dist/lib/chantMarkup.d.ts +63 -20
- package/dist/lib/editorStorage.d.ts +14 -4
- package/dist/lib/embed/core.d.ts +22 -4
- package/dist/lib/embed/index.js +1 -1
- package/dist/lib/embed/manual.d.ts +6 -3
- package/dist/lib/embed/manual.js +37 -46
- package/dist/lib/glyphFamilies.d.ts +7 -0
- package/dist/lib/guidex.css +29 -2
- package/dist/lib/guidoRender.d.ts +13 -3
- package/dist/lib/guidoScript.d.ts +74 -20
- package/dist/lib/guidoScriptTransforms.d.ts +0 -18
- package/dist/lib/guidoStyles.d.ts +85 -74
- package/dist/lib/react/GuidexScore.d.ts +14 -5
- package/dist/lib/react/index.d.ts +2 -0
- package/dist/lib/react/index.js +12 -2
- package/dist/lib/scoreImage-Dz3c55Zi.js +1985 -0
- package/dist/lib/stanzas.d.ts +6 -3
- package/dist/lib/textMarkup.d.ts +67 -0
- package/dist/lib/word/index.js +1 -1
- package/dist/lib/{wordChecker-EQx8frRp.js → wordChecker-B_9vyTt6.js} +39 -13
- package/dist/lib/wordExport.d.ts +19 -4
- package/dist-embed/guidex-embed.min.css +1 -1
- package/dist-embed/guidex-embed.min.js +1 -1
- package/package.json +1 -1
- package/dist/lib/scoreImage-DSEupCru.js +0 -1002
package/README.md
CHANGED
|
@@ -22,7 +22,8 @@ The package ships a typed ESM build with an exports map:
|
|
|
22
22
|
(`chantText(script)`, the `GuidoScript` parser, `unescape`,
|
|
23
23
|
`scriptSyllables`), the script helpers (`PITCH_ROWS`, `transposeNotes`,
|
|
24
24
|
`SCORE_MARKERS`, `splitNoteMarkers`, `composeScript` — see *Combining
|
|
25
|
-
scripts* below) and the style sets (`STYLE_SETS`, `DEFAULT_STYLE_SET`,
|
|
25
|
+
scripts* below) and the style sets (`STYLE_SETS`, `DEFAULT_STYLE_SET`,
|
|
26
|
+
`defineStyleSet`, `StyleSetName`).
|
|
26
27
|
Also the Word-compatible export: `toWordHtml(script, options?)`,
|
|
27
28
|
`toWordText(script, options?)`, the clipboard writers
|
|
28
29
|
`copyWordHtml` / `copyWordPlainText`, and the paste checker
|
|
@@ -60,21 +61,25 @@ script — for a lyrics column, a search index, and the like:
|
|
|
60
61
|
import { chantText, GuidoScript } from 'guidex'
|
|
61
62
|
|
|
62
63
|
chantText('(M)A(0) di(0q)e(qQ0)bus(1) an(3)ti(1e)quis(qQ0-:)') // 'A diebus antiquis'
|
|
64
|
+
chantText('(M)__V.__() De(1)us(2) **() in(3)') // 'Deus in'
|
|
65
|
+
chantText('(M)__V.__() De(1)us(2)', { labels: true }) // 'V. Deus'
|
|
63
66
|
new GuidoScript('(M)A(0) di(0q)e(qQ0)bus(1) an(3)ti(1e)quis(qQ0-:)').words
|
|
64
67
|
// [{ text: 'A', syllables: [{ text: 'A', notes: '0' }] },
|
|
65
68
|
// { text: 'diebus', syllables: [{ text: 'di', notes: '0q' }, { text: 'e', notes: 'qQ0' }, { text: 'bus', notes: '1' }] },
|
|
66
69
|
// { text: 'antiquis', syllables: [{ text: 'an', notes: '3' }, { text: 'ti', notes: '1e' }, { text: 'quis', notes: 'qQ0-:' }] }]
|
|
67
70
|
```
|
|
68
71
|
|
|
69
|
-
`scriptSyllables(script)` walks the
|
|
72
|
+
`scriptSyllables(script)` walks the sung syllables with their notes, held
|
|
70
73
|
groups, word starts and source offsets (held groups, `~` slots and
|
|
71
|
-
statements are skipped,
|
|
74
|
+
statements are skipped, and labels and signs too unless `{ roles }` asks
|
|
75
|
+
for them). `text` is the clean text and `source` the syllable as written.
|
|
76
|
+
Its indices are the ones `composeScript` takes:
|
|
72
77
|
|
|
73
78
|
```js
|
|
74
79
|
import { scriptSyllables } from 'guidex'
|
|
75
80
|
|
|
76
81
|
scriptSyllables('(M)Ülj(11) az(0) ra,(qQ0-:) mon(3)')[2]
|
|
77
|
-
// { text: 'ra,', notes: 'qQ0-:', held: [], wordStart: true, wordEnd: true,
|
|
82
|
+
// { text: 'ra,', source: 'ra,', role: 'sung', notes: 'qQ0-:', held: [], wordStart: true, wordEnd: true,
|
|
78
83
|
// start: 17, notesStart: 21, notesEnd: 26, end: 27, token: 2 }
|
|
79
84
|
```
|
|
80
85
|
|
|
@@ -108,12 +113,11 @@ composeScript([{ script: antiphon, to: 3 }, { marker: 'intonation' }, { script:
|
|
|
108
113
|
|
|
109
114
|
### Marked-up text
|
|
110
115
|
|
|
111
|
-
The
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
runs, `plus` for a `+` inside a Liturgy run:
|
|
116
|
+
The text with its markup, for displaying it outside the score: `chantRuns`
|
|
117
|
+
gives the structure (words → syllables → runs) and `chantHtml` serializes
|
|
118
|
+
it as HTML. Runs carry their `marks` and the `role` of their syllable. They
|
|
119
|
+
are the same in every style set, with letter case as written, and they
|
|
120
|
+
hold only initials the script itself writes.
|
|
117
121
|
|
|
118
122
|
```js
|
|
119
123
|
import { chantHtml, chantRuns } from 'guidex'
|
|
@@ -121,33 +125,91 @@ import { chantHtml, chantRuns } from 'guidex'
|
|
|
121
125
|
const script = '(c4)__V.__() *Psa*lmus(1) **(2) De(7)us(2)'
|
|
122
126
|
|
|
123
127
|
chantHtml(script) // '<span class="liturgy">V.</span> <span class="initial">Psa</span>lmus <span class="star">∗</span> Deus'
|
|
124
|
-
|
|
125
|
-
//
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
//
|
|
128
|
+
chantHtml(script, { roles: ['sung'], classPrefix: 'gx-' })
|
|
129
|
+
// '<span class="gx-initial">Psa</span>lmus Deus'
|
|
130
|
+
|
|
131
|
+
chantRuns(script, { merge: 'word', roles: ['sung', 'label'] })
|
|
132
|
+
// [{ text: 'V.', kind: 'liturgy', marks: ['liturgy'], role: 'label', wordEnd: true },
|
|
133
|
+
// { text: 'Psa', initial: true, marks: ['initial'], role: 'sung', wordEnd: false },
|
|
134
|
+
// { text: 'lmus', marks: [], role: 'sung', wordEnd: true },
|
|
135
|
+
// { text: 'Deus', marks: [], role: 'sung', wordEnd: true }]
|
|
129
136
|
```
|
|
130
137
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
serves both. Style them yourself — the BNS and Vesperale looks
|
|
136
|
-
correspond to:
|
|
138
|
+
Without `merge`, each syllable keeps its own runs, for consumers that
|
|
139
|
+
hyphenate. `kind` is derived from `marks` and kept for existing consumers.
|
|
140
|
+
`chantTextStyle('red,sc', { style })` gives the resolved look of marks, for
|
|
141
|
+
styling prose to match a score.
|
|
137
142
|
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
143
|
+
### Styling text under the staff
|
|
144
|
+
|
|
145
|
+
Any part of the text can be styled with a `{marks:text}` span, which may
|
|
146
|
+
cross syllables and words. Marks are comma-separated, later ones win, and
|
|
147
|
+
spans nest:
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
{red,b:Al}le(1)lú(2)ia(3) part of a word
|
|
151
|
+
{i:Mi(1)se(2)ré(3)re.(4)} across syllables
|
|
152
|
+
{rubric:Pater noster {plain:secreto}}() a black word in a rubric
|
|
153
|
+
*D*{sc:eus}(1) a red initial, then small caps
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
| Mark | Effect |
|
|
157
|
+
| --- | --- |
|
|
158
|
+
| `red`, `color:<name>` | Colour, from the palette or a style set's `colors` |
|
|
159
|
+
| `b`, `i` | Bold, italic |
|
|
160
|
+
| `sc` | Real small caps: the text itself stays as written |
|
|
161
|
+
| `up` | Capitals, display only |
|
|
162
|
+
| `size:<n>` | Size multiplier |
|
|
163
|
+
| `raise:<n>` | Baseline shift |
|
|
164
|
+
| `font:<name>` | A font: `liturgy`, `times`, or a style set's `fonts` |
|
|
165
|
+
| `plain` | Reset everything before it |
|
|
166
|
+
|
|
167
|
+
These mean the same in every style set. `liturgy`, `rubric` and `initial`
|
|
168
|
+
are the style set's own, and `__x__`, `_x_` and `*x*` are short for them.
|
|
169
|
+
The hyphen inside a span takes the span's look, size included, and the one
|
|
170
|
+
at its edge stays plain. `\{`, `\}`, `\_` and `\*` are literal.
|
|
171
|
+
|
|
172
|
+
A consumer adds its own marks and style sets without patching the package:
|
|
173
|
+
|
|
174
|
+
```js
|
|
175
|
+
import { defineStyleSet, renderScore } from 'guidex'
|
|
176
|
+
|
|
177
|
+
defineStyleSet('Psalterium', {
|
|
178
|
+
extends: 'BNS',
|
|
179
|
+
marks: { rubric: { smallCaps: true, scale: 0.8, color: 'red' } },
|
|
180
|
+
colors: { gold: '#b8860b' },
|
|
181
|
+
})
|
|
182
|
+
renderScore(el, script, { style: 'Psalterium', marks: { cue: { italic: true } } })
|
|
146
183
|
```
|
|
147
184
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
185
|
+
A malformed span, an unknown mark, or a character the Liturgy font lacks
|
|
186
|
+
renders plainly and comes back in the render's `warnings`
|
|
187
|
+
(`markupWarnings(script, { style, marks })` checks without rendering).
|
|
188
|
+
|
|
189
|
+
### What a syllable is for
|
|
190
|
+
|
|
191
|
+
| Role | What it is | `chantText` | Stanza slot | `scriptSyllables` |
|
|
192
|
+
| --- | --- | --- | --- | --- |
|
|
193
|
+
| `sung` | The words | Yes | Yes | Yes |
|
|
194
|
+
| `label` | A wrapped syllable with no pitch: `V.`, `R.`, `ANT.` | With `{ labels: true }` | No | With `roles` |
|
|
195
|
+
| `sign` | `**`, `*`, `†` alone, the cross `__+__` | No | No | With `roles` |
|
|
196
|
+
| `aid` | Sung, not the text: the differentia, inside `(@aid)…(@aid off)` | With `{ aids: true }` | Yes | Yes |
|
|
197
|
+
|
|
198
|
+
A label or a sign may stand on spacing and a bar (`**(-----,,)`); guidex
|
|
199
|
+
leaves the choice of bars to the author.
|
|
200
|
+
|
|
201
|
+
### The Liturgy font
|
|
202
|
+
|
|
203
|
+
`liturgy.ttf` maps exactly five characters; anything else in a `__…__` run
|
|
204
|
+
falls back to a serif and warns.
|
|
205
|
+
|
|
206
|
+
| Character | Glyph |
|
|
207
|
+
| --- | --- |
|
|
208
|
+
| `V` | The versicle label, as `__V.__` |
|
|
209
|
+
| `R` | The response label, as `__R.__` |
|
|
210
|
+
| `.` | The stop of those labels |
|
|
211
|
+
| `/` | The font's slash |
|
|
212
|
+
| `+` | The cross, drawn at 70% and raised |
|
|
151
213
|
|
|
152
214
|
### Word export
|
|
153
215
|
|
|
@@ -337,13 +399,32 @@ updates when the `script` prop changes. Props mirror the options below:
|
|
|
337
399
|
|
|
338
400
|
| Option | Values | Default |
|
|
339
401
|
| ----------- | ------------------------------- | -------------- |
|
|
340
|
-
| `maxWidth` | pixels, or `auto` (fits the element, re-rendered on resize) | `auto` |
|
|
402
|
+
| `maxWidth` | pixels, `Infinity` (never break), or `auto` (fits the element, re-rendered on resize) | `auto` |
|
|
341
403
|
| `style` | `BNS`, `Vesperale` | `BNS` |
|
|
342
404
|
| `bold` | boolean | `false` |
|
|
343
405
|
| `textPx` | base text size in px (notes render at 2×) | `18` |
|
|
406
|
+
| `staffFill` | how far each staff runs: `all-but-last`, `none`, `all`, `longest` | `all-but-last` |
|
|
407
|
+
| `staffFillSnapPx` | with `longest`: fill to the full width when the longest line ends this close to it (`data-staff-fill-snap`) | `0` |
|
|
344
408
|
| `transpose` | pitch-row shift (see `transposeBy`) | `0` |
|
|
345
409
|
| `debug` | boolean (measurement titles on spans) | `false` |
|
|
346
410
|
|
|
411
|
+
guidex breaks the lines itself and the browser never re-wraps them. With
|
|
412
|
+
`auto` every line fits the element, apart from a single note group too
|
|
413
|
+
wide for it. A number can be wider than the element, and `Infinity` (or
|
|
414
|
+
any large number; `data-max-width="Infinity"` works too) means "never
|
|
415
|
+
break". The score then grows past its container as one box, and the
|
|
416
|
+
overflow is the host page's to handle:
|
|
417
|
+
|
|
418
|
+
```css
|
|
419
|
+
.my-score { overflow-x: auto; } /* or hidden, to clip */
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
`staffFill` sets where each staff stops. `all-but-last` fills every line
|
|
423
|
+
but the last to the available width, `none` stops every line at its own
|
|
424
|
+
notes, `all` fills every line, and `longest` ends every line with the
|
|
425
|
+
score's longest line, text included. Bars stay right after their notes,
|
|
426
|
+
with staff beyond them. With `maxWidth: Infinity`, `all` acts as `longest`.
|
|
427
|
+
|
|
347
428
|
## Embedding with a script tag (no bundler)
|
|
348
429
|
|
|
349
430
|
Host the `dist-embed/` folder (also attached to every GitHub Release)
|
|
@@ -400,6 +481,12 @@ its notes:
|
|
|
400
481
|
follows: they hang in the junction whitespace, the syllable text is
|
|
401
482
|
positioned under the note characters only, and a group starting with
|
|
402
483
|
a modifier needs only a 2-dash junction.
|
|
484
|
+
- A bracketed accidental at the start of a note group (`ÄôŨ¨õÕö`: a
|
|
485
|
+
bracket pair `Â`/`Ã`, `Ä`/`Å` or `Æ`/`Ç` around accidental signs, plus
|
|
486
|
+
any `¨`/`-` right after it) hangs the same way: it adds staff width in
|
|
487
|
+
the white space before the group, the syllable text aligns with the
|
|
488
|
+
note after it, and the group takes the 2-dash junction. A line never
|
|
489
|
+
breaks inside it.
|
|
403
490
|
- Control statements are groups whose content is an `@`-keyword, set
|
|
404
491
|
between syllables where a syllable's text would stand:
|
|
405
492
|
`(@break)` ends the current line pair at its position — the staff fills
|
|
@@ -413,10 +500,21 @@ its notes:
|
|
|
413
500
|
key and `(@key)` clears it: up to the line end the affected notes (in
|
|
414
501
|
every octave) get their accidental sign, and later lines open with
|
|
415
502
|
the new key. Neither forces a line break.
|
|
503
|
+
`(@tight)` … `(@tight off)` sets a run of syllables one dash closer
|
|
504
|
+
(the `E u o u a e` of a psalm termination), `(@keep)` … `(@keep off)`
|
|
505
|
+
keeps a run on one line, and `(@unit)` … `(@unit off)` does both. Runs
|
|
506
|
+
nest, and each `off` closes one level; a run left open lasts to the end
|
|
507
|
+
of the script. Wide text still widens the notes inside a tight run. A
|
|
508
|
+
kept run wider than a whole line wraps normally, and one with kept runs
|
|
509
|
+
inside it dissolves into them, starting on its own line. So a hymn
|
|
510
|
+
written as `(@keep)(@keep)verse 1(@keep off)(@keep)verse 2(@keep off)(@keep off)`
|
|
511
|
+
breaks between pairs of verses first, between verses next, and inside
|
|
512
|
+
a verse last.
|
|
416
513
|
- Style decorations on syllable text: `__…__` renders in the Liturgy
|
|
417
|
-
font, bold; `_…_` renders small
|
|
514
|
+
font, bold; `_…_` renders small capitals (BNS) or italic (Vesperale);
|
|
418
515
|
`*…*` marks an initial (bold, red in BNS). A syllable that is exactly
|
|
419
|
-
`**` renders the mediant star glyph.
|
|
516
|
+
`**` renders the mediant star glyph. `{marks:…}` styles any stretch of
|
|
517
|
+
text (see *Styling text under the staff*).
|
|
420
518
|
|
|
421
519
|
In the rendered score, notes are set in the Guidohu font at twice the
|
|
422
520
|
surrounding text size. Notes are measured with a hidden canvas after
|
|
@@ -1,14 +1,16 @@
|
|
|
1
|
+
import { StaffFill } from '../chantLayout';
|
|
1
2
|
import { ChantPrefs, EditorSettings, SavedChant } from '../editorStorage';
|
|
2
3
|
import { StyleSetName } from '../guidoStyles';
|
|
3
|
-
import {
|
|
4
|
+
import { TranspositionTarget } from '../guidoScriptTransforms';
|
|
4
5
|
import { GuidoScript } from '../guidoScript';
|
|
6
|
+
import { MarkWarning } from '../chantMarkup';
|
|
7
|
+
import { SpanProblem } from '../textMarkup';
|
|
5
8
|
import { EmptySlots, StanzaWarning } from '../stanzas';
|
|
6
9
|
import { SpacerChar } from '../wordExport';
|
|
7
10
|
import { WordInputs } from './wordCopy';
|
|
8
|
-
/** The render settings minus
|
|
9
|
-
*
|
|
10
|
-
|
|
11
|
-
export type RenderSettings = Omit<EditorSettings, 'word' | 'initial'>;
|
|
11
|
+
/** The render settings minus `word`, which has its own raw-string inputs
|
|
12
|
+
* (wordCopy.ts). */
|
|
13
|
+
export type RenderSettings = Omit<EditorSettings, 'word'>;
|
|
12
14
|
/** Transient feedback slots: one `word-copy-feedback`-style span each,
|
|
13
15
|
* shown for 4 s and cleared by their own timer (FeedbackSpan). */
|
|
14
16
|
export type FeedbackSlot = 'draft' | 'copyScript' | 'copyLink' | 'downloadImage' | 'wordCopy' | 'chantSaved' | 'chantSaveForm' | 'chantList';
|
|
@@ -33,9 +35,6 @@ export interface EditorState {
|
|
|
33
35
|
* from; any hand edit clears it. */
|
|
34
36
|
activeChipId: string | null;
|
|
35
37
|
settings: RenderSettings;
|
|
36
|
-
/** The live transform set: rebuilt by style changes, toggled by the
|
|
37
|
-
* initial checkbox, persisted as the derived `initial` boolean. */
|
|
38
|
-
transforms: ScriptTransform[];
|
|
39
38
|
/** Raw typed strings of the base/chant size inputs — the render and
|
|
40
39
|
* persistence use the clamped settings numbers. */
|
|
41
40
|
inputs: {
|
|
@@ -100,8 +99,14 @@ export type EditorAction = {
|
|
|
100
99
|
type: 'SET_BOLD';
|
|
101
100
|
bold: boolean;
|
|
102
101
|
} | {
|
|
103
|
-
type: '
|
|
104
|
-
|
|
102
|
+
type: 'SET_JUNCTION_DASHES';
|
|
103
|
+
dashes: number;
|
|
104
|
+
} | {
|
|
105
|
+
type: 'SET_STAFF_FILL';
|
|
106
|
+
fill: StaffFill;
|
|
107
|
+
} | {
|
|
108
|
+
type: 'SET_STAFF_FILL_SNAP';
|
|
109
|
+
px: number;
|
|
105
110
|
} | {
|
|
106
111
|
type: 'SET_MAX_WIDTH';
|
|
107
112
|
px: number;
|
|
@@ -175,47 +180,44 @@ export type EditorAction = {
|
|
|
175
180
|
type: 'HIDE_FEEDBACK';
|
|
176
181
|
slot: FeedbackSlot;
|
|
177
182
|
};
|
|
178
|
-
export declare function hasInitialTransform(transforms: ScriptTransform[]): boolean;
|
|
179
183
|
/** Signed label for the transpose slider: `+2`, `0` or `-3`. */
|
|
180
184
|
export declare function transposeLabel(shift: number): string;
|
|
181
185
|
/** The editor script's stanza facts: how many stanzas the draft has,
|
|
182
186
|
* the one rendered (the picked one, or 1 when the draft no longer has
|
|
183
187
|
* it; `STACK_ALL` while a draft with stanzas stacks them all), and the
|
|
184
|
-
* rendered stanzas' count mismatches. */
|
|
188
|
+
* rendered stanzas' count mismatches and markup problems. */
|
|
185
189
|
export interface EditorStanzas {
|
|
186
190
|
count: number;
|
|
187
191
|
stanza: number;
|
|
188
|
-
warnings: StanzaWarning[];
|
|
192
|
+
warnings: (StanzaWarning | MarkWarning | SpanProblem)[];
|
|
189
193
|
}
|
|
190
194
|
/** The stanza facts of a draft. A draft that does not parse has one
|
|
191
195
|
* stanza — the render reports the parse error itself. */
|
|
192
|
-
export declare function editorStanzas(script: string, picked: StanzaInputs): EditorStanzas;
|
|
196
|
+
export declare function editorStanzas(script: string, picked: StanzaInputs, style?: StyleSetName): EditorStanzas;
|
|
193
197
|
/** Builds the editor script: the draft with the picked stanza swapped
|
|
194
|
-
* in, plus the
|
|
195
|
-
* sets, and the exact transposition. A failing exact transposition (out
|
|
198
|
+
* in, plus the transposition the slider sets and the exact one. A failing exact transposition (out
|
|
196
199
|
* of range, missing glyph) is left out and its message returned for the
|
|
197
200
|
* editor to show. `scripts` is what the preview renders: the script
|
|
198
201
|
* alone, or every stanza stacked (the script is then stanza 1's). */
|
|
199
|
-
export declare function buildEditorScript(state: Pick<EditorState, 'script' | '
|
|
202
|
+
export declare function buildEditorScript(state: Pick<EditorState, 'script' | 'settings' | 'exact'> & Partial<Pick<EditorState, 'stanza'>>): {
|
|
200
203
|
script: GuidoScript;
|
|
201
204
|
scripts: GuidoScript[];
|
|
202
205
|
transposeError: string | null;
|
|
203
206
|
};
|
|
204
|
-
/** The render settings a saved chant snapshots: style, bold,
|
|
205
|
-
*
|
|
207
|
+
/** The render settings a saved chant snapshots: style, bold, base/chant
|
|
208
|
+
* sizes with their decouple state, and transpose —
|
|
206
209
|
* exactly what loading the chant re-applies. The max-width slider and
|
|
207
210
|
* the color pickers are not part of a chant. */
|
|
208
|
-
export declare function chantPrefsSnapshot(state: Pick<EditorState, 'settings'
|
|
211
|
+
export declare function chantPrefsSnapshot(state: Pick<EditorState, 'settings'>): ChantPrefs;
|
|
209
212
|
/** The full settings blob for storage: the live render settings plus the
|
|
210
|
-
*
|
|
213
|
+
* Word-copy slice's effective values. */
|
|
211
214
|
export declare function settingsSnapshot(state: EditorState): EditorSettings;
|
|
212
215
|
/** The state overlay a ChantPrefs snapshot restores — shared by the
|
|
213
216
|
* LOAD_CHANT reducer case and the shared-link init (issue #63), so both
|
|
214
217
|
* ride the same handoff: a decoupled chant without a custom size adopts
|
|
215
218
|
* the derived 2× base size of the chant's own base font size. */
|
|
216
219
|
export declare function chantPrefsOverlay(prefs: ChantPrefs): {
|
|
217
|
-
settings: Pick<RenderSettings, 'style' | 'bold' | 'transpose' | 'basePx' | 'decoupleNotes' | 'notesPx' | 'notesCustom'>;
|
|
218
|
-
transforms: ScriptTransform[];
|
|
220
|
+
settings: Pick<RenderSettings, 'style' | 'bold' | 'transpose' | 'basePx' | 'decoupleNotes' | 'notesPx' | 'notesCustom' | 'junctionDashes' | 'staffFill' | 'staffFillSnapPx'>;
|
|
219
221
|
inputs: {
|
|
220
222
|
basePx: string;
|
|
221
223
|
notesPx: string;
|
|
@@ -14,9 +14,8 @@ export interface SharedChant {
|
|
|
14
14
|
* the stored chant blobs. */
|
|
15
15
|
export declare function parseShareFragment(hash: string): SharedChant | null;
|
|
16
16
|
/** The share URL for the editor's current content: the raw script (the
|
|
17
|
-
*
|
|
18
|
-
* transpose prefs) plus the full prefs snapshot — every param always
|
|
17
|
+
* transposition re-derives on the receiving end from its pref) plus the full prefs snapshot — every param always
|
|
19
18
|
* emitted, so a link renders identically even if the defaults ever
|
|
20
19
|
* change. Percent-encoding rides on `URLSearchParams`, whose decoding
|
|
21
20
|
* the fragment parser mirrors. */
|
|
22
|
-
export declare function buildShareLink(state: Pick<EditorState, 'script' | 'settings'
|
|
21
|
+
export declare function buildShareLink(state: Pick<EditorState, 'script' | 'settings'>): string;
|