@cube-drone/marquee-react-renderer 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/LICENSE +373 -0
- package/README.md +163 -0
- package/dist/Marquee.d.ts +62 -0
- package/dist/Marquee.js +224 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.js +15 -0
- package/dist/locate.d.ts +9 -0
- package/dist/locate.js +71 -0
- package/dist/render.d.ts +28 -0
- package/dist/render.js +593 -0
- package/package.json +56 -0
- package/src/Marquee.ts +356 -0
- package/src/index.ts +26 -0
- package/src/locate.ts +76 -0
- package/src/render.ts +782 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,373 @@
|
|
|
1
|
+
Mozilla Public License Version 2.0
|
|
2
|
+
==================================
|
|
3
|
+
|
|
4
|
+
1. Definitions
|
|
5
|
+
--------------
|
|
6
|
+
|
|
7
|
+
1.1. "Contributor"
|
|
8
|
+
means each individual or legal entity that creates, contributes to
|
|
9
|
+
the creation of, or owns Covered Software.
|
|
10
|
+
|
|
11
|
+
1.2. "Contributor Version"
|
|
12
|
+
means the combination of the Contributions of others (if any) used
|
|
13
|
+
by a Contributor and that particular Contributor's Contribution.
|
|
14
|
+
|
|
15
|
+
1.3. "Contribution"
|
|
16
|
+
means Covered Software of a particular Contributor.
|
|
17
|
+
|
|
18
|
+
1.4. "Covered Software"
|
|
19
|
+
means Source Code Form to which the initial Contributor has attached
|
|
20
|
+
the notice in Exhibit A, the Executable Form of such Source Code
|
|
21
|
+
Form, and Modifications of such Source Code Form, in each case
|
|
22
|
+
including portions thereof.
|
|
23
|
+
|
|
24
|
+
1.5. "Incompatible With Secondary Licenses"
|
|
25
|
+
means
|
|
26
|
+
|
|
27
|
+
(a) that the initial Contributor has attached the notice described
|
|
28
|
+
in Exhibit B to the Covered Software; or
|
|
29
|
+
|
|
30
|
+
(b) that the Covered Software was made available under the terms of
|
|
31
|
+
version 1.1 or earlier of the License, but not also under the
|
|
32
|
+
terms of a Secondary License.
|
|
33
|
+
|
|
34
|
+
1.6. "Executable Form"
|
|
35
|
+
means any form of the work other than Source Code Form.
|
|
36
|
+
|
|
37
|
+
1.7. "Larger Work"
|
|
38
|
+
means a work that combines Covered Software with other material, in
|
|
39
|
+
a separate file or files, that is not Covered Software.
|
|
40
|
+
|
|
41
|
+
1.8. "License"
|
|
42
|
+
means this document.
|
|
43
|
+
|
|
44
|
+
1.9. "Licensable"
|
|
45
|
+
means having the right to grant, to the maximum extent possible,
|
|
46
|
+
whether at the time of the initial grant or subsequently, any and
|
|
47
|
+
all of the rights conveyed by this License.
|
|
48
|
+
|
|
49
|
+
1.10. "Modifications"
|
|
50
|
+
means any of the following:
|
|
51
|
+
|
|
52
|
+
(a) any file in Source Code Form that results from an addition to,
|
|
53
|
+
deletion from, or modification of the contents of Covered
|
|
54
|
+
Software; or
|
|
55
|
+
|
|
56
|
+
(b) any new file in Source Code Form that contains any Covered
|
|
57
|
+
Software.
|
|
58
|
+
|
|
59
|
+
1.11. "Patent Claims" of a Contributor
|
|
60
|
+
means any patent claim(s), including without limitation, method,
|
|
61
|
+
process, and apparatus claims, in any patent Licensable by such
|
|
62
|
+
Contributor that would be infringed, but for the grant of the
|
|
63
|
+
License, by the making, using, selling, offering for sale, having
|
|
64
|
+
made, import, or transfer of either its Contributions or its
|
|
65
|
+
Contributor Version.
|
|
66
|
+
|
|
67
|
+
1.12. "Secondary License"
|
|
68
|
+
means either the GNU General Public License, Version 2.0, the GNU
|
|
69
|
+
Lesser General Public License, Version 2.1, the GNU Affero General
|
|
70
|
+
Public License, Version 3.0, or any later versions of those
|
|
71
|
+
licenses.
|
|
72
|
+
|
|
73
|
+
1.13. "Source Code Form"
|
|
74
|
+
means the form of the work preferred for making modifications.
|
|
75
|
+
|
|
76
|
+
1.14. "You" (or "Your")
|
|
77
|
+
means an individual or a legal entity exercising rights under this
|
|
78
|
+
License. For legal entities, "You" includes any entity that
|
|
79
|
+
controls, is controlled by, or is under common control with You. For
|
|
80
|
+
purposes of this definition, "control" means (a) the power, direct
|
|
81
|
+
or indirect, to cause the direction or management of such entity,
|
|
82
|
+
whether by contract or otherwise, or (b) ownership of more than
|
|
83
|
+
fifty percent (50%) of the outstanding shares or beneficial
|
|
84
|
+
ownership of such entity.
|
|
85
|
+
|
|
86
|
+
2. License Grants and Conditions
|
|
87
|
+
--------------------------------
|
|
88
|
+
|
|
89
|
+
2.1. Grants
|
|
90
|
+
|
|
91
|
+
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
92
|
+
non-exclusive license:
|
|
93
|
+
|
|
94
|
+
(a) under intellectual property rights (other than patent or trademark)
|
|
95
|
+
Licensable by such Contributor to use, reproduce, make available,
|
|
96
|
+
modify, display, perform, distribute, and otherwise exploit its
|
|
97
|
+
Contributions, either on an unmodified basis, with Modifications, or
|
|
98
|
+
as part of a Larger Work; and
|
|
99
|
+
|
|
100
|
+
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
|
101
|
+
for sale, have made, import, and otherwise transfer either its
|
|
102
|
+
Contributions or its Contributor Version.
|
|
103
|
+
|
|
104
|
+
2.2. Effective Date
|
|
105
|
+
|
|
106
|
+
The licenses granted in Section 2.1 with respect to any Contribution
|
|
107
|
+
become effective for each Contribution on the date the Contributor first
|
|
108
|
+
distributes such Contribution.
|
|
109
|
+
|
|
110
|
+
2.3. Limitations on Grant Scope
|
|
111
|
+
|
|
112
|
+
The licenses granted in this Section 2 are the only rights granted under
|
|
113
|
+
this License. No additional rights or licenses will be implied from the
|
|
114
|
+
distribution or licensing of Covered Software under this License.
|
|
115
|
+
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
116
|
+
Contributor:
|
|
117
|
+
|
|
118
|
+
(a) for any code that a Contributor has removed from Covered Software;
|
|
119
|
+
or
|
|
120
|
+
|
|
121
|
+
(b) for infringements caused by: (i) Your and any other third party's
|
|
122
|
+
modifications of Covered Software, or (ii) the combination of its
|
|
123
|
+
Contributions with other software (except as part of its Contributor
|
|
124
|
+
Version); or
|
|
125
|
+
|
|
126
|
+
(c) under Patent Claims infringed by Covered Software in the absence of
|
|
127
|
+
its Contributions.
|
|
128
|
+
|
|
129
|
+
This License does not grant any rights in the trademarks, service marks,
|
|
130
|
+
or logos of any Contributor (except as may be necessary to comply with
|
|
131
|
+
the notice requirements in Section 3.4).
|
|
132
|
+
|
|
133
|
+
2.4. Subsequent Licenses
|
|
134
|
+
|
|
135
|
+
No Contributor makes additional grants as a result of Your choice to
|
|
136
|
+
distribute the Covered Software under a subsequent version of this
|
|
137
|
+
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
138
|
+
permitted under the terms of Section 3.3).
|
|
139
|
+
|
|
140
|
+
2.5. Representation
|
|
141
|
+
|
|
142
|
+
Each Contributor represents that the Contributor believes its
|
|
143
|
+
Contributions are its original creation(s) or it has sufficient rights
|
|
144
|
+
to grant the rights to its Contributions conveyed by this License.
|
|
145
|
+
|
|
146
|
+
2.6. Fair Use
|
|
147
|
+
|
|
148
|
+
This License is not intended to limit any rights You have under
|
|
149
|
+
applicable copyright doctrines of fair use, fair dealing, or other
|
|
150
|
+
equivalents.
|
|
151
|
+
|
|
152
|
+
2.7. Conditions
|
|
153
|
+
|
|
154
|
+
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
|
155
|
+
in Section 2.1.
|
|
156
|
+
|
|
157
|
+
3. Responsibilities
|
|
158
|
+
-------------------
|
|
159
|
+
|
|
160
|
+
3.1. Distribution of Source Form
|
|
161
|
+
|
|
162
|
+
All distribution of Covered Software in Source Code Form, including any
|
|
163
|
+
Modifications that You create or to which You contribute, must be under
|
|
164
|
+
the terms of this License. You must inform recipients that the Source
|
|
165
|
+
Code Form of the Covered Software is governed by the terms of this
|
|
166
|
+
License, and how they can obtain a copy of this License. You may not
|
|
167
|
+
attempt to alter or restrict the recipients' rights in the Source Code
|
|
168
|
+
Form.
|
|
169
|
+
|
|
170
|
+
3.2. Distribution of Executable Form
|
|
171
|
+
|
|
172
|
+
If You distribute Covered Software in Executable Form then:
|
|
173
|
+
|
|
174
|
+
(a) such Covered Software must also be made available in Source Code
|
|
175
|
+
Form, as described in Section 3.1, and You must inform recipients of
|
|
176
|
+
the Executable Form how they can obtain a copy of such Source Code
|
|
177
|
+
Form by reasonable means in a timely manner, at a charge no more
|
|
178
|
+
than the cost of distribution to the recipient; and
|
|
179
|
+
|
|
180
|
+
(b) You may distribute such Executable Form under the terms of this
|
|
181
|
+
License, or sublicense it under different terms, provided that the
|
|
182
|
+
license for the Executable Form does not attempt to limit or alter
|
|
183
|
+
the recipients' rights in the Source Code Form under this License.
|
|
184
|
+
|
|
185
|
+
3.3. Distribution of a Larger Work
|
|
186
|
+
|
|
187
|
+
You may create and distribute a Larger Work under terms of Your choice,
|
|
188
|
+
provided that You also comply with the requirements of this License for
|
|
189
|
+
the Covered Software. If the Larger Work is a combination of Covered
|
|
190
|
+
Software with a work governed by one or more Secondary Licenses, and the
|
|
191
|
+
Covered Software is not Incompatible With Secondary Licenses, this
|
|
192
|
+
License permits You to additionally distribute such Covered Software
|
|
193
|
+
under the terms of such Secondary License(s), so that the recipient of
|
|
194
|
+
the Larger Work may, at their option, further distribute the Covered
|
|
195
|
+
Software under the terms of either this License or such Secondary
|
|
196
|
+
License(s).
|
|
197
|
+
|
|
198
|
+
3.4. Notices
|
|
199
|
+
|
|
200
|
+
You may not remove or alter the substance of any license notices
|
|
201
|
+
(including copyright notices, patent notices, disclaimers of warranty,
|
|
202
|
+
or limitations of liability) contained within the Source Code Form of
|
|
203
|
+
the Covered Software, except that You may alter any license notices to
|
|
204
|
+
the extent required to remedy known factual inaccuracies.
|
|
205
|
+
|
|
206
|
+
3.5. Application of Additional Terms
|
|
207
|
+
|
|
208
|
+
You may choose to offer, and to charge a fee for, warranty, support,
|
|
209
|
+
indemnity or liability obligations to one or more recipients of Covered
|
|
210
|
+
Software. However, You may do so only on Your own behalf, and not on
|
|
211
|
+
behalf of any Contributor. You must make it absolutely clear that any
|
|
212
|
+
such warranty, support, indemnity, or liability obligation is offered by
|
|
213
|
+
You alone, and You hereby agree to indemnify every Contributor for any
|
|
214
|
+
liability incurred by such Contributor as a result of warranty, support,
|
|
215
|
+
indemnity or liability terms You offer. You may include additional
|
|
216
|
+
disclaimers of warranty and limitations of liability specific to any
|
|
217
|
+
jurisdiction.
|
|
218
|
+
|
|
219
|
+
4. Inability to Comply Due to Statute or Regulation
|
|
220
|
+
---------------------------------------------------
|
|
221
|
+
|
|
222
|
+
If it is impossible for You to comply with any of the terms of this
|
|
223
|
+
License with respect to some or all of the Covered Software due to
|
|
224
|
+
statute, judicial order, or regulation then You must: (a) comply with
|
|
225
|
+
the terms of this License to the maximum extent possible; and (b)
|
|
226
|
+
describe the limitations and the code they affect. Such description must
|
|
227
|
+
be placed in a text file included with all distributions of the Covered
|
|
228
|
+
Software under this License. Except to the extent prohibited by statute
|
|
229
|
+
or regulation, such description must be sufficiently detailed for a
|
|
230
|
+
recipient of ordinary skill to be able to understand it.
|
|
231
|
+
|
|
232
|
+
5. Termination
|
|
233
|
+
--------------
|
|
234
|
+
|
|
235
|
+
5.1. The rights granted under this License will terminate automatically
|
|
236
|
+
if You fail to comply with any of its terms. However, if You become
|
|
237
|
+
compliant, then the rights granted under this License from a particular
|
|
238
|
+
Contributor are reinstated (a) provisionally, unless and until such
|
|
239
|
+
Contributor explicitly and finally terminates Your grants, and (b) on an
|
|
240
|
+
ongoing basis, if such Contributor fails to notify You of the
|
|
241
|
+
non-compliance by some reasonable means prior to 60 days after You have
|
|
242
|
+
come back into compliance. Moreover, Your grants from a particular
|
|
243
|
+
Contributor are reinstated on an ongoing basis if such Contributor
|
|
244
|
+
notifies You of the non-compliance by some reasonable means, this is the
|
|
245
|
+
first time You have received notice of non-compliance with this License
|
|
246
|
+
from such Contributor, and You become compliant prior to 30 days after
|
|
247
|
+
Your receipt of the notice.
|
|
248
|
+
|
|
249
|
+
5.2. If You initiate litigation against any entity by asserting a patent
|
|
250
|
+
infringement claim (excluding declaratory judgment actions,
|
|
251
|
+
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
252
|
+
directly or indirectly infringes any patent, then the rights granted to
|
|
253
|
+
You by any and all Contributors for the Covered Software under Section
|
|
254
|
+
2.1 of this License shall terminate.
|
|
255
|
+
|
|
256
|
+
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
|
257
|
+
end user license agreements (excluding distributors and resellers) which
|
|
258
|
+
have been validly granted by You or Your distributors under this License
|
|
259
|
+
prior to termination shall survive termination.
|
|
260
|
+
|
|
261
|
+
************************************************************************
|
|
262
|
+
* *
|
|
263
|
+
* 6. Disclaimer of Warranty *
|
|
264
|
+
* ------------------------- *
|
|
265
|
+
* *
|
|
266
|
+
* Covered Software is provided under this License on an "as is" *
|
|
267
|
+
* basis, without warranty of any kind, either expressed, implied, or *
|
|
268
|
+
* statutory, including, without limitation, warranties that the *
|
|
269
|
+
* Covered Software is free of defects, merchantable, fit for a *
|
|
270
|
+
* particular purpose or non-infringing. The entire risk as to the *
|
|
271
|
+
* quality and performance of the Covered Software is with You. *
|
|
272
|
+
* Should any Covered Software prove defective in any respect, You *
|
|
273
|
+
* (not any Contributor) assume the cost of any necessary servicing, *
|
|
274
|
+
* repair, or correction. This disclaimer of warranty constitutes an *
|
|
275
|
+
* essential part of this License. No use of any Covered Software is *
|
|
276
|
+
* authorized under this License except under this disclaimer. *
|
|
277
|
+
* *
|
|
278
|
+
************************************************************************
|
|
279
|
+
|
|
280
|
+
************************************************************************
|
|
281
|
+
* *
|
|
282
|
+
* 7. Limitation of Liability *
|
|
283
|
+
* -------------------------- *
|
|
284
|
+
* *
|
|
285
|
+
* Under no circumstances and under no legal theory, whether tort *
|
|
286
|
+
* (including negligence), contract, or otherwise, shall any *
|
|
287
|
+
* Contributor, or anyone who distributes Covered Software as *
|
|
288
|
+
* permitted above, be liable to You for any direct, indirect, *
|
|
289
|
+
* special, incidental, or consequential damages of any character *
|
|
290
|
+
* including, without limitation, damages for lost profits, loss of *
|
|
291
|
+
* goodwill, work stoppage, computer failure or malfunction, or any *
|
|
292
|
+
* and all other commercial damages or losses, even if such party *
|
|
293
|
+
* shall have been informed of the possibility of such damages. This *
|
|
294
|
+
* limitation of liability shall not apply to liability for death or *
|
|
295
|
+
* personal injury resulting from such party's negligence to the *
|
|
296
|
+
* extent applicable law prohibits such limitation. Some *
|
|
297
|
+
* jurisdictions do not allow the exclusion or limitation of *
|
|
298
|
+
* incidental or consequential damages, so this exclusion and *
|
|
299
|
+
* limitation may not apply to You. *
|
|
300
|
+
* *
|
|
301
|
+
************************************************************************
|
|
302
|
+
|
|
303
|
+
8. Litigation
|
|
304
|
+
-------------
|
|
305
|
+
|
|
306
|
+
Any litigation relating to this License may be brought only in the
|
|
307
|
+
courts of a jurisdiction where the defendant maintains its principal
|
|
308
|
+
place of business and such litigation shall be governed by laws of that
|
|
309
|
+
jurisdiction, without reference to its conflict-of-law provisions.
|
|
310
|
+
Nothing in this Section shall prevent a party's ability to bring
|
|
311
|
+
cross-claims or counter-claims.
|
|
312
|
+
|
|
313
|
+
9. Miscellaneous
|
|
314
|
+
----------------
|
|
315
|
+
|
|
316
|
+
This License represents the complete agreement concerning the subject
|
|
317
|
+
matter hereof. If any provision of this License is held to be
|
|
318
|
+
unenforceable, such provision shall be reformed only to the extent
|
|
319
|
+
necessary to make it enforceable. Any law or regulation which provides
|
|
320
|
+
that the language of a contract shall be construed against the drafter
|
|
321
|
+
shall not be used to construe this License against a Contributor.
|
|
322
|
+
|
|
323
|
+
10. Versions of the License
|
|
324
|
+
---------------------------
|
|
325
|
+
|
|
326
|
+
10.1. New Versions
|
|
327
|
+
|
|
328
|
+
Mozilla Foundation is the license steward. Except as provided in Section
|
|
329
|
+
10.3, no one other than the license steward has the right to modify or
|
|
330
|
+
publish new versions of this License. Each version will be given a
|
|
331
|
+
distinguishing version number.
|
|
332
|
+
|
|
333
|
+
10.2. Effect of New Versions
|
|
334
|
+
|
|
335
|
+
You may distribute the Covered Software under the terms of the version
|
|
336
|
+
of the License under which You originally received the Covered Software,
|
|
337
|
+
or under the terms of any subsequent version published by the license
|
|
338
|
+
steward.
|
|
339
|
+
|
|
340
|
+
10.3. Modified Versions
|
|
341
|
+
|
|
342
|
+
If you create software not governed by this License, and you want to
|
|
343
|
+
create a new license for such software, you may create and use a
|
|
344
|
+
modified version of this License if you rename the license and remove
|
|
345
|
+
any references to the name of the license steward (except to note that
|
|
346
|
+
such modified license differs from this License).
|
|
347
|
+
|
|
348
|
+
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
349
|
+
Licenses
|
|
350
|
+
|
|
351
|
+
If You choose to distribute Source Code Form that is Incompatible With
|
|
352
|
+
Secondary Licenses under the terms of this version of the License, the
|
|
353
|
+
notice described in Exhibit B of this License must be attached.
|
|
354
|
+
|
|
355
|
+
Exhibit A - Source Code Form License Notice
|
|
356
|
+
-------------------------------------------
|
|
357
|
+
|
|
358
|
+
This Source Code Form is subject to the terms of the Mozilla Public
|
|
359
|
+
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
360
|
+
file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
361
|
+
|
|
362
|
+
If it is not possible or desirable to put the notice in a particular
|
|
363
|
+
file, then You may include the notice in a location (such as a LICENSE
|
|
364
|
+
file in a relevant directory) where a recipient would be likely to look
|
|
365
|
+
for such a notice.
|
|
366
|
+
|
|
367
|
+
You may add additional accurate notices of copyright ownership.
|
|
368
|
+
|
|
369
|
+
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
370
|
+
---------------------------------------------------------
|
|
371
|
+
|
|
372
|
+
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
373
|
+
defined by the Mozilla Public License, v. 2.0.
|
package/README.md
ADDED
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
<img src="https://raw.githubusercontent.com/cube-drone/marqueemarkup/main/marquee-logo.png" alt="Marquee Markup" width="96" align="right">
|
|
2
|
+
|
|
3
|
+
# @cube-drone/marquee-react-renderer
|
|
4
|
+
|
|
5
|
+
The **interactive** renderer for [Marquee](https://github.com/cube-drone/marqueemarkup): a
|
|
6
|
+
React component that renders Marquee source (or a parsed AST) into React elements — and adds
|
|
7
|
+
the three things a string of HTML cannot do.
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
npm install @cube-drone/marquee-react-renderer @cube-drone/marquee-css
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { Marquee } from "@cube-drone/marquee-react-renderer";
|
|
15
|
+
import "@cube-drone/marquee-css/marquee.css";
|
|
16
|
+
|
|
17
|
+
<Marquee source="# hello [rainbow by=letter]world[/rainbow]" />
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
That's it. Motion, effects, fonts, emoji, layout — all of it, from the same stylesheet and
|
|
21
|
+
the same `mq-*` class contract the static renderer targets.
|
|
22
|
+
|
|
23
|
+
## What it adds over the static renderer
|
|
24
|
+
|
|
25
|
+
The spec's animation contract has four rules; the static HTML renderer can only keep two of
|
|
26
|
+
them, and explicitly defers the rest to "the interactive renderer". This is that renderer.
|
|
27
|
+
|
|
28
|
+
- **Effects start when they're seen, not when the page loads.** An `IntersectionObserver`
|
|
29
|
+
releases each effect the first time it scrolls into view. (A typewriter that finished
|
|
30
|
+
typing three screens above you is a typewriter you never saw.)
|
|
31
|
+
- **The reader can always skip.** One click stills every effect and shows all text, whole —
|
|
32
|
+
"animated text is a performance, never a hostage situation." Also available as
|
|
33
|
+
`handle.skip()` for a toolbar button or a keystroke.
|
|
34
|
+
- **Scroll sync for side-by-side editors.** The component knows which DOM element every AST
|
|
35
|
+
node became *and* which source offsets it came from, in both directions.
|
|
36
|
+
|
|
37
|
+
## Editor sync (the side-by-side pattern)
|
|
38
|
+
|
|
39
|
+
Give it `source` (not `doc`) and the parse carries source positions. Then:
|
|
40
|
+
|
|
41
|
+
```tsx
|
|
42
|
+
const view = useRef<MarqueeHandle>(null);
|
|
43
|
+
|
|
44
|
+
// editor cursor moved -> scroll the preview to it, centered
|
|
45
|
+
onCursorMove={(offset) => view.current?.scrollToSource(offset)}
|
|
46
|
+
|
|
47
|
+
<Marquee
|
|
48
|
+
ref={view}
|
|
49
|
+
source={text}
|
|
50
|
+
// reader clicked the preview -> move the editor's cursor there
|
|
51
|
+
onNodeClick={(node, span) => span && editor.setCursor(span.start)}
|
|
52
|
+
/>
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Every rendered element also carries `data-mq-start` / `data-mq-end` (its source extent), so a
|
|
56
|
+
host that would rather do its own DOM work has everything it needs without touching the
|
|
57
|
+
handle. Offsets are **UTF-16 code units over the normalized source** — the same units
|
|
58
|
+
JavaScript strings and CodeMirror speak. (See `@cube-drone/marquee-parser`'s
|
|
59
|
+
`parseWithPositions` for the three sharp edges: spans are *source* extents, so they can be
|
|
60
|
+
longer than the text they cover.)
|
|
61
|
+
|
|
62
|
+
## Why CSS animations and not an animation library
|
|
63
|
+
|
|
64
|
+
Because the three features above are not animation problems — they're animation *control*
|
|
65
|
+
problems, and CSS animations are already controllable: `animation-play-state` for the
|
|
66
|
+
visibility gate, `animation: none` for skip. JavaScript decides *when the clock runs*; it
|
|
67
|
+
never animates anything.
|
|
68
|
+
|
|
69
|
+
The deeper reason: Marquee's effect set is a **closed vocabulary**. A renderer doesn't get to
|
|
70
|
+
invent effects — only the spec does. An animation library would buy expressiveness the
|
|
71
|
+
language doesn't permit us to spend, at the cost of a dependency, a bundle, and a second
|
|
72
|
+
implementation of `[wave]` that could drift from the stylesheet every other renderer shares.
|
|
73
|
+
So: zero runtime dependencies beyond React, and the motion is the *same motion* the static
|
|
74
|
+
renderer produces.
|
|
75
|
+
|
|
76
|
+
Reduced-motion is honored by the stylesheet, not by this component: under
|
|
77
|
+
`prefers-reduced-motion`, there is simply nothing to gate.
|
|
78
|
+
|
|
79
|
+
## Props
|
|
80
|
+
|
|
81
|
+
| prop | type | default | contract |
|
|
82
|
+
|---|---|---|---|
|
|
83
|
+
| `source` | `string` | — | Marquee source. Parsed with positions, which is what enables editor sync |
|
|
84
|
+
| `doc` | `Node` | — | a pre-parsed AST instead (no positions, so no source sync) |
|
|
85
|
+
| `profile` | `Partial<Profile>` | bare web | embedder policy — schemes, media, emoji, turbolinks, custom vocabulary. **The same socket the static renderer uses**: write your policy once, both renderers honor it |
|
|
86
|
+
| `hooks` | `ReactHooks` | — | React-returning versions of the `turbolink` / `directive` / `span` rendering hooks. When given, no HTML string is ever injected (see Safety) |
|
|
87
|
+
| `animate` | `"visible" \| "immediate" \| "never"` | `"visible"` | when effects start |
|
|
88
|
+
| `skipOnClick` | `boolean` | `true` | a click anywhere stills everything |
|
|
89
|
+
| `onNodeClick` | `(node, span, event) => void` | — | reverse sync: which node did the reader click, and where did it come from |
|
|
90
|
+
| `className` | `string` | — | extra classes on the root |
|
|
91
|
+
|
|
92
|
+
## The handle (`ref`)
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
interface MarqueeHandle {
|
|
96
|
+
root: HTMLElement | null;
|
|
97
|
+
elementFor(node: Node): HTMLElement | null;
|
|
98
|
+
elementNear(offset: number): HTMLElement | null;
|
|
99
|
+
nodeAt(offset: number): Node | null; // deepest node CONTAINING the offset
|
|
100
|
+
nodeNear(offset: number): Node | null; // deepest node at or NEAREST it
|
|
101
|
+
scrollToNode(node: Node, options?: ScrollIntoViewOptions): boolean;
|
|
102
|
+
scrollToSource(offset: number, options?: ScrollIntoViewOptions): boolean;
|
|
103
|
+
skip(): void;
|
|
104
|
+
replay(): void;
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
`scrollToSource` centers by default (`block: "center"`), because the top edge of the viewport
|
|
109
|
+
is not where a human looks.
|
|
110
|
+
|
|
111
|
+
**`nodeAt` vs `nodeNear` matters more than it sounds like it does.** Containment has holes: a
|
|
112
|
+
span covers a construct's source extent, and the blank line *between* two blocks belongs to
|
|
113
|
+
no child — only to their container. So a cursor parked on a blank line is, strictly, inside
|
|
114
|
+
nothing smaller than the container, and `nodeAt` correctly answers "the section" (or, between
|
|
115
|
+
two top-level paragraphs, "the document"). Scrolling *there* centers the whole group, which
|
|
116
|
+
feels like the preview lurching away for no reason.
|
|
117
|
+
|
|
118
|
+
`nodeNear` is the editor-shaped answer: at each level it descends into the *nearest* child
|
|
119
|
+
rather than stopping at the container, so a cursor in the gap finds the block beside it.
|
|
120
|
+
`scrollToSource` and `elementNear` both use it. Both functions are also exported standalone
|
|
121
|
+
(`nodeAt`, `nodeNear`) for hosts doing their own DOM work.
|
|
122
|
+
|
|
123
|
+
One more thing bidirectional sync needs, learned the hard way: **guard the echo.** Moving the
|
|
124
|
+
editor's cursor in response to `onNodeClick` will fire the editor's own selection event,
|
|
125
|
+
which — if you wire it straight back to `scrollToSource` — re-centers the node the reader
|
|
126
|
+
just clicked, yanking it out from under them. A click should move the editor and *leave the
|
|
127
|
+
preview alone*. The demo shows the guard.
|
|
128
|
+
|
|
129
|
+
## Safety
|
|
130
|
+
|
|
131
|
+
The AST is the contract: this renderer builds **React elements**, never an HTML string, so
|
|
132
|
+
there is no `innerHTML` path for author bytes — not even a tempting one. React escapes
|
|
133
|
+
everything.
|
|
134
|
+
|
|
135
|
+
The one exception is embedder-trusted hook output: `Profile.turbolink` / `.directive` /
|
|
136
|
+
`.span` return HTML strings (that's the static renderer's socket), so those are injected as
|
|
137
|
+
trusted HTML — exactly the same trust boundary as a turbolink plugin, where author bytes only
|
|
138
|
+
ever arrive as a target string. Pass `hooks` instead and even that path disappears.
|
|
139
|
+
|
|
140
|
+
## The demo
|
|
141
|
+
|
|
142
|
+
```
|
|
143
|
+
npm run demo # in this package
|
|
144
|
+
npx serve ts/marquee-react-renderer/demo/dist # from the repo root
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
Builds `WRITING.mq` — the language's own tour — into a **side-by-side editor**: source on
|
|
148
|
+
the left, live preview on the right, cursor sync in both directions, and buttons for
|
|
149
|
+
skip/replay/animate-mode. It's the fastest way to see what this renderer adds, and it's the
|
|
150
|
+
honest prototype of the live-preview editor.
|
|
151
|
+
|
|
152
|
+
esbuild is the whole toolchain (one dev dependency, no config file), and it bundles the
|
|
153
|
+
repo's TypeScript *source* via the `marquee-src` export condition — what you see is the
|
|
154
|
+
working tree, not a stale `dist`. The demo assembles its own stylesheet from
|
|
155
|
+
`@cube-drone/marquee-css` + the composed plugins' skins + exactly the font faces the
|
|
156
|
+
document wears, because that assembly is a *host's* job, not a renderer's.
|
|
157
|
+
|
|
158
|
+
## Preact
|
|
159
|
+
|
|
160
|
+
React is a peer dependency (`>=18`), and this package uses no React internals — so
|
|
161
|
+
`preact/compat` aliasing works. One package, both ecosystems.
|
|
162
|
+
|
|
163
|
+
License: MPL-2.0.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { parse, type Node, type Span } from "@cube-drone/marquee-parser";
|
|
2
|
+
import { type Profile } from "@cube-drone/marquee-html-renderer";
|
|
3
|
+
import { type ReactHooks } from "./render.ts";
|
|
4
|
+
export interface MarqueeHandle {
|
|
5
|
+
/** The rendered root element. */
|
|
6
|
+
readonly root: HTMLElement | null;
|
|
7
|
+
/** The DOM element a node rendered to, if it is currently mounted. */
|
|
8
|
+
elementFor(node: Node): HTMLElement | null;
|
|
9
|
+
/** The element `scrollToSource(offset)` would scroll to: the nearest node
|
|
10
|
+
* to that offset that actually has an element (text nodes render as
|
|
11
|
+
* strings, so they have none). Handy for highlighting it too. */
|
|
12
|
+
elementNear(offset: number): HTMLElement | null;
|
|
13
|
+
/** The deepest node whose source span CONTAINS this offset (needs
|
|
14
|
+
* `source`). Exact, with holes: a cursor in the blank line between two
|
|
15
|
+
* paragraphs is contained by nothing smaller than their container. */
|
|
16
|
+
nodeAt(offset: number): Node | null;
|
|
17
|
+
/** The deepest node at or NEAREST this offset - the editor-shaped answer,
|
|
18
|
+
* and what `scrollToSource` uses. A cursor in the gap between two blocks
|
|
19
|
+
* finds the block beside it, not the container above it. */
|
|
20
|
+
nodeNear(offset: number): Node | null;
|
|
21
|
+
/** Scroll a node into view. Returns false if it isn't mounted. */
|
|
22
|
+
scrollToNode(node: Node, options?: ScrollIntoViewOptions): boolean;
|
|
23
|
+
/** Scroll to whatever the editor's cursor is sitting in: the side-by-side
|
|
24
|
+
* move. Centered by default, because "at the top edge" is not where a
|
|
25
|
+
* human looks. Returns false if the offset maps to nothing on screen. */
|
|
26
|
+
scrollToSource(offset: number, options?: ScrollIntoViewOptions): boolean;
|
|
27
|
+
/** Still every effect and show all text, whole - the skip gesture, fired
|
|
28
|
+
* programmatically (a toolbar button, a keystroke, a host policy). */
|
|
29
|
+
skip(): void;
|
|
30
|
+
/** Undo a skip and re-arm the visibility observer. */
|
|
31
|
+
replay(): void;
|
|
32
|
+
}
|
|
33
|
+
export interface MarqueeProps {
|
|
34
|
+
/** Marquee source. Parsed with positions, which is what enables the
|
|
35
|
+
* editor-sync half of the API. Ignored when `doc` is given. */
|
|
36
|
+
source?: string;
|
|
37
|
+
/** A pre-parsed document (no positions, so no source sync). */
|
|
38
|
+
doc?: Node;
|
|
39
|
+
/** Embedder policy: schemes, media, emoji, turbolinks, vocabulary.
|
|
40
|
+
* The SAME socket the static renderer uses - one policy, both renderers. */
|
|
41
|
+
profile?: Partial<Profile>;
|
|
42
|
+
/** React-returning versions of the rendering hooks. When given, the
|
|
43
|
+
* corresponding string-returning profile hook is not consulted (and no
|
|
44
|
+
* HTML string is ever injected). */
|
|
45
|
+
hooks?: ReactHooks;
|
|
46
|
+
/** `visible` (default): effects hold until scrolled into view.
|
|
47
|
+
* `immediate`: effects run from mount, like the static renderer.
|
|
48
|
+
* `never`: no motion at all (the reduced-motion posture, by choice). */
|
|
49
|
+
animate?: "visible" | "immediate" | "never";
|
|
50
|
+
/** A click anywhere in the document stills every effect (default true) -
|
|
51
|
+
* the spec's "animated text is a performance, never a hostage situation". */
|
|
52
|
+
skipOnClick?: boolean;
|
|
53
|
+
/** Extra classes on the root, beside `mq-doc`. */
|
|
54
|
+
className?: string;
|
|
55
|
+
/** Reverse sync: which node did the reader just click? Gives you the node
|
|
56
|
+
* and its source span, so the editor can move its cursor there. */
|
|
57
|
+
onNodeClick?: (node: Node, span: Span | null, event: React.MouseEvent) => void;
|
|
58
|
+
}
|
|
59
|
+
export declare const Marquee: import("react").ForwardRefExoticComponent<MarqueeProps & import("react").RefAttributes<MarqueeHandle>>;
|
|
60
|
+
/** Parse without positions - for callers who want to hold the AST
|
|
61
|
+
* themselves and pass it as `doc`. */
|
|
62
|
+
export { parse };
|