@fusion.dev/helix 0.220.0 → 0.221.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/api.json +1 -1
- package/custom-elements.json +1 -1
- package/dist/code-editor/root/code-editor-root.d.ts +2 -2
- package/dist/editor/index.d.ts +1 -0
- package/dist/editor/index.js +1 -0
- package/dist/editor/root/editor-root.css.d.ts +1 -0
- package/dist/editor/root/editor-root.css.js +2 -0
- package/dist/editor/root/editor-root.d.ts +62 -0
- package/dist/editor/root/editor-root.js +33 -0
- package/dist/element-events.generated.js +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/examples.json +1 -1
- package/lint.json +1 -1
- package/package.json +6 -6
- package/skills/helix/SKILL.md +2 -2
- package/types/jsx.d.ts +934 -6
- package/types/svelte.d.ts +1 -0
- package/types/vue.d.ts +157 -2
- package/types/words.d.ts +140 -0
package/types/jsx.d.ts
CHANGED
|
@@ -90,6 +90,7 @@ import type {
|
|
|
90
90
|
HelixDrilldown,
|
|
91
91
|
HelixDrilldownItem,
|
|
92
92
|
HelixEditEvent,
|
|
93
|
+
HelixEditor,
|
|
93
94
|
HelixEmpty,
|
|
94
95
|
HelixEndEvent,
|
|
95
96
|
HelixExpandEvent,
|
|
@@ -9094,7 +9095,7 @@ Here rather than on each control. */
|
|
|
9094
9095
|
/** The problems in the text, each underlined and listed under the editor. */
|
|
9095
9096
|
diagnostics?: (HelixCodeEditor["diagnostics"]) | undefined;
|
|
9096
9097
|
/** What draws the editor, such as `codeMirrorEngine()` from
|
|
9097
|
-
`@fusion.dev/helix-editor`. Absent, the editor is a plain text field. */
|
|
9098
|
+
`@fusion.dev/helix-code-editor`. Absent, the editor is a plain text field. */
|
|
9098
9099
|
engine?: (HelixCodeEditor["engine"]) | undefined;
|
|
9099
9100
|
|
|
9100
9101
|
/** The reader finished an edit and focus left the code, in the engine or the plain field. */
|
|
@@ -9302,7 +9303,7 @@ Here rather than on each control. */
|
|
|
9302
9303
|
/** The problems in the text, each underlined and listed under the editor. */
|
|
9303
9304
|
"prop:diagnostics"?: (HelixCodeEditor["diagnostics"]) | undefined;
|
|
9304
9305
|
/** What draws the editor, such as `codeMirrorEngine()` from
|
|
9305
|
-
`@fusion.dev/helix-editor`. Absent, the editor is a plain text field. */
|
|
9306
|
+
`@fusion.dev/helix-code-editor`. Absent, the editor is a plain text field. */
|
|
9306
9307
|
"prop:engine"?: (HelixCodeEditor["engine"]) | undefined;
|
|
9307
9308
|
/** The reader finished an edit and focus left the code, in the engine or the plain field. */
|
|
9308
9309
|
"on:change"?: ((e: HelixCodeEditorElementEvent) => void) | undefined;
|
|
@@ -17290,6 +17291,264 @@ shows the top page. */
|
|
|
17290
17291
|
textContent?: (string | number) | undefined;
|
|
17291
17292
|
};
|
|
17292
17293
|
|
|
17294
|
+
/** `HelixEditor` component event */
|
|
17295
|
+
export type HelixEditorElementEvent<E = Event> = TypedEvent<HelixEditor, E>;
|
|
17296
|
+
/** `helix-found` event type */
|
|
17297
|
+
export type HelixEditorHelixFoundElementEvent =
|
|
17298
|
+
HelixEditorElementEvent<HelixFoundEvent>;
|
|
17299
|
+
|
|
17300
|
+
export type HelixEditorProps = {
|
|
17301
|
+
/** Covers the container instead of growing with the document, for an editor
|
|
17302
|
+
that fills a pane, such as one side of a split view. The document scrolls
|
|
17303
|
+
inside the frame. The container needs a position, such as
|
|
17304
|
+
`position: relative`. */
|
|
17305
|
+
fill?: (HelixEditor["fill"]) | undefined;
|
|
17306
|
+
/** How the frame stands off the page. Unset, it is outlined. `plain` draws
|
|
17307
|
+
no edge or corners, for a document that fills a page or a pane of its own. */
|
|
17308
|
+
separation?: (HelixEditor["separation"]) | undefined;
|
|
17309
|
+
/** The block menu button's name. `{name}` is the block type at the selection. */
|
|
17310
|
+
"block-chosen-label"?: (HelixEditor["blockChosenLabel"]) | undefined;
|
|
17311
|
+
/** The block menu button's name. `{name}` is the block type at the selection. */
|
|
17312
|
+
blockChosenLabel?: (HelixEditor["blockChosenLabel"]) | undefined;
|
|
17313
|
+
/** The block menu's name, read by screen readers. */
|
|
17314
|
+
"block-label"?: (HelixEditor["blockLabel"]) | undefined;
|
|
17315
|
+
/** The block menu's name, read by screen readers. */
|
|
17316
|
+
blockLabel?: (HelixEditor["blockLabel"]) | undefined;
|
|
17317
|
+
/** The Bold button's label. */
|
|
17318
|
+
"bold-label"?: (HelixEditor["boldLabel"]) | undefined;
|
|
17319
|
+
/** The Bold button's label. */
|
|
17320
|
+
boldLabel?: (HelixEditor["boldLabel"]) | undefined;
|
|
17321
|
+
/** The Bulleted list button's label. */
|
|
17322
|
+
"bullet-list-label"?: (HelixEditor["bulletListLabel"]) | undefined;
|
|
17323
|
+
/** The Bulleted list button's label. */
|
|
17324
|
+
bulletListLabel?: (HelixEditor["bulletListLabel"]) | undefined;
|
|
17325
|
+
/** The Code block row's label in the block menu. */
|
|
17326
|
+
"code-block-label"?: (HelixEditor["codeBlockLabel"]) | undefined;
|
|
17327
|
+
/** The Code block row's label in the block menu. */
|
|
17328
|
+
codeBlockLabel?: (HelixEditor["codeBlockLabel"]) | undefined;
|
|
17329
|
+
/** The Code button's label. */
|
|
17330
|
+
"code-label"?: (HelixEditor["codeLabel"]) | undefined;
|
|
17331
|
+
/** The Code button's label. */
|
|
17332
|
+
codeLabel?: (HelixEditor["codeLabel"]) | undefined;
|
|
17333
|
+
/** The toolbar's name, read by screen readers. */
|
|
17334
|
+
"controls-label"?: (HelixEditor["controlsLabel"]) | undefined;
|
|
17335
|
+
/** The toolbar's name, read by screen readers. */
|
|
17336
|
+
controlsLabel?: (HelixEditor["controlsLabel"]) | undefined;
|
|
17337
|
+
/** The document's name where `label` is empty and the host has no `aria-label`. */
|
|
17338
|
+
"fallback-label"?: (HelixEditor["fallbackLabel"]) | undefined;
|
|
17339
|
+
/** The document's name where `label` is empty and the host has no `aria-label`. */
|
|
17340
|
+
fallbackLabel?: (HelixEditor["fallbackLabel"]) | undefined;
|
|
17341
|
+
/** The Find button's label, and the find bar's name. */
|
|
17342
|
+
"find-label"?: (HelixEditor["findLabel"]) | undefined;
|
|
17343
|
+
/** The Find button's label, and the find bar's name. */
|
|
17344
|
+
findLabel?: (HelixEditor["findLabel"]) | undefined;
|
|
17345
|
+
/** A heading's name in the block menu. `{level}` is its level, 1 to 3. */
|
|
17346
|
+
"heading-label"?: (HelixEditor["headingLabel"]) | undefined;
|
|
17347
|
+
/** A heading's name in the block menu. `{level}` is its level, 1 to 3. */
|
|
17348
|
+
headingLabel?: (HelixEditor["headingLabel"]) | undefined;
|
|
17349
|
+
/** The Italic button's label. */
|
|
17350
|
+
"italic-label"?: (HelixEditor["italicLabel"]) | undefined;
|
|
17351
|
+
/** The Italic button's label. */
|
|
17352
|
+
italicLabel?: (HelixEditor["italicLabel"]) | undefined;
|
|
17353
|
+
/** The document's name, read by screen readers. Name what it holds, such as
|
|
17354
|
+
"Release notes", so that several editors on one page can be told apart.
|
|
17355
|
+
Required. */
|
|
17356
|
+
label?: (HelixEditor["label"]) | undefined;
|
|
17357
|
+
/** The Apply button's label in the address bar. */
|
|
17358
|
+
"link-apply-label"?: (HelixEditor["linkApplyLabel"]) | undefined;
|
|
17359
|
+
/** The Apply button's label in the address bar. */
|
|
17360
|
+
linkApplyLabel?: (HelixEditor["linkApplyLabel"]) | undefined;
|
|
17361
|
+
/** The close button's label in the address bar. */
|
|
17362
|
+
"link-close-label"?: (HelixEditor["linkCloseLabel"]) | undefined;
|
|
17363
|
+
/** The close button's label in the address bar. */
|
|
17364
|
+
linkCloseLabel?: (HelixEditor["linkCloseLabel"]) | undefined;
|
|
17365
|
+
/** The name of the address bar's toolbar, read by screen readers. */
|
|
17366
|
+
"link-controls-label"?: (HelixEditor["linkControlsLabel"]) | undefined;
|
|
17367
|
+
/** The name of the address bar's toolbar, read by screen readers. */
|
|
17368
|
+
linkControlsLabel?: (HelixEditor["linkControlsLabel"]) | undefined;
|
|
17369
|
+
/** The address field's name, which it also shows while it is empty. */
|
|
17370
|
+
"link-field-label"?: (HelixEditor["linkFieldLabel"]) | undefined;
|
|
17371
|
+
/** The address field's name, which it also shows while it is empty. */
|
|
17372
|
+
linkFieldLabel?: (HelixEditor["linkFieldLabel"]) | undefined;
|
|
17373
|
+
/** The Link button's label, and the address bar's name. */
|
|
17374
|
+
"link-label"?: (HelixEditor["linkLabel"]) | undefined;
|
|
17375
|
+
/** The Link button's label, and the address bar's name. */
|
|
17376
|
+
linkLabel?: (HelixEditor["linkLabel"]) | undefined;
|
|
17377
|
+
/** The Remove button's label in the address bar. */
|
|
17378
|
+
"link-remove-label"?: (HelixEditor["linkRemoveLabel"]) | undefined;
|
|
17379
|
+
/** The Remove button's label in the address bar. */
|
|
17380
|
+
linkRemoveLabel?: (HelixEditor["linkRemoveLabel"]) | undefined;
|
|
17381
|
+
/** The Numbered list button's label. */
|
|
17382
|
+
"ordered-list-label"?: (HelixEditor["orderedListLabel"]) | undefined;
|
|
17383
|
+
/** The Numbered list button's label. */
|
|
17384
|
+
orderedListLabel?: (HelixEditor["orderedListLabel"]) | undefined;
|
|
17385
|
+
/** The Paragraph row's label in the block menu. */
|
|
17386
|
+
"paragraph-label"?: (HelixEditor["paragraphLabel"]) | undefined;
|
|
17387
|
+
/** The Paragraph row's label in the block menu. */
|
|
17388
|
+
paragraphLabel?: (HelixEditor["paragraphLabel"]) | undefined;
|
|
17389
|
+
/** The words shown in an empty document, such as "Write the release notes". */
|
|
17390
|
+
placeholder?: (HelixEditor["placeholder"]) | undefined;
|
|
17391
|
+
/** The Quote button's label. */
|
|
17392
|
+
"quote-label"?: (HelixEditor["quoteLabel"]) | undefined;
|
|
17393
|
+
/** The Quote button's label. */
|
|
17394
|
+
quoteLabel?: (HelixEditor["quoteLabel"]) | undefined;
|
|
17395
|
+
/** Shows the document and takes no edits, with no toolbar, for a document
|
|
17396
|
+
someone reads, or one an agent is writing. The attribute is `readonly`,
|
|
17397
|
+
the platform's spelling. */
|
|
17398
|
+
readonly?: (HelixEditor["readOnly"]) | undefined;
|
|
17399
|
+
/** Shows the document and takes no edits, with no toolbar, for a document
|
|
17400
|
+
someone reads, or one an agent is writing. The attribute is `readonly`,
|
|
17401
|
+
the platform's spelling. */
|
|
17402
|
+
readOnly?: (HelixEditor["readOnly"]) | undefined;
|
|
17403
|
+
/** The Redo button's label. */
|
|
17404
|
+
"redo-label"?: (HelixEditor["redoLabel"]) | undefined;
|
|
17405
|
+
/** The Redo button's label. */
|
|
17406
|
+
redoLabel?: (HelixEditor["redoLabel"]) | undefined;
|
|
17407
|
+
/** The Strikethrough button's label. */
|
|
17408
|
+
"strike-label"?: (HelixEditor["strikeLabel"]) | undefined;
|
|
17409
|
+
/** The Strikethrough button's label. */
|
|
17410
|
+
strikeLabel?: (HelixEditor["strikeLabel"]) | undefined;
|
|
17411
|
+
/** Which groups of tools the toolbar draws, as a list of `history`, `block`,
|
|
17412
|
+
`marks`, `link`, `lists`, and `quote`, or `none`. They are drawn in that
|
|
17413
|
+
order, whatever order the list is in. Absent is all six. */
|
|
17414
|
+
tools?: (HelixEditor["tools"]) | undefined;
|
|
17415
|
+
/** The Undo button's label. */
|
|
17416
|
+
"undo-label"?: (HelixEditor["undoLabel"]) | undefined;
|
|
17417
|
+
/** The Undo button's label. */
|
|
17418
|
+
undoLabel?: (HelixEditor["undoLabel"]) | undefined;
|
|
17419
|
+
|
|
17420
|
+
/** The find bar searched or moved among the matches, with `count` and the selected match's `index`, counting from 0, or -1 for none. */
|
|
17421
|
+
"onhelix-found"?: ((e: HelixEditorHelixFoundElementEvent) => void) | undefined;
|
|
17422
|
+
};
|
|
17423
|
+
|
|
17424
|
+
export type HelixEditorSolidJsProps = {
|
|
17425
|
+
/** Covers the container instead of growing with the document, for an editor
|
|
17426
|
+
that fills a pane, such as one side of a split view. The document scrolls
|
|
17427
|
+
inside the frame. The container needs a position, such as
|
|
17428
|
+
`position: relative`. */
|
|
17429
|
+
"prop:fill"?: (HelixEditor["fill"]) | undefined;
|
|
17430
|
+
/** How the frame stands off the page. Unset, it is outlined. `plain` draws
|
|
17431
|
+
no edge or corners, for a document that fills a page or a pane of its own. */
|
|
17432
|
+
"prop:separation"?: (HelixEditor["separation"]) | undefined;
|
|
17433
|
+
/** The block menu button's name. `{name}` is the block type at the selection. */
|
|
17434
|
+
"attr:block-chosen-label"?: (HelixEditor["blockChosenLabel"]) | undefined;
|
|
17435
|
+
/** The block menu button's name. `{name}` is the block type at the selection. */
|
|
17436
|
+
"prop:blockChosenLabel"?: (HelixEditor["blockChosenLabel"]) | undefined;
|
|
17437
|
+
/** The block menu's name, read by screen readers. */
|
|
17438
|
+
"attr:block-label"?: (HelixEditor["blockLabel"]) | undefined;
|
|
17439
|
+
/** The block menu's name, read by screen readers. */
|
|
17440
|
+
"prop:blockLabel"?: (HelixEditor["blockLabel"]) | undefined;
|
|
17441
|
+
/** The Bold button's label. */
|
|
17442
|
+
"attr:bold-label"?: (HelixEditor["boldLabel"]) | undefined;
|
|
17443
|
+
/** The Bold button's label. */
|
|
17444
|
+
"prop:boldLabel"?: (HelixEditor["boldLabel"]) | undefined;
|
|
17445
|
+
/** The Bulleted list button's label. */
|
|
17446
|
+
"attr:bullet-list-label"?: (HelixEditor["bulletListLabel"]) | undefined;
|
|
17447
|
+
/** The Bulleted list button's label. */
|
|
17448
|
+
"prop:bulletListLabel"?: (HelixEditor["bulletListLabel"]) | undefined;
|
|
17449
|
+
/** The Code block row's label in the block menu. */
|
|
17450
|
+
"attr:code-block-label"?: (HelixEditor["codeBlockLabel"]) | undefined;
|
|
17451
|
+
/** The Code block row's label in the block menu. */
|
|
17452
|
+
"prop:codeBlockLabel"?: (HelixEditor["codeBlockLabel"]) | undefined;
|
|
17453
|
+
/** The Code button's label. */
|
|
17454
|
+
"attr:code-label"?: (HelixEditor["codeLabel"]) | undefined;
|
|
17455
|
+
/** The Code button's label. */
|
|
17456
|
+
"prop:codeLabel"?: (HelixEditor["codeLabel"]) | undefined;
|
|
17457
|
+
/** The toolbar's name, read by screen readers. */
|
|
17458
|
+
"attr:controls-label"?: (HelixEditor["controlsLabel"]) | undefined;
|
|
17459
|
+
/** The toolbar's name, read by screen readers. */
|
|
17460
|
+
"prop:controlsLabel"?: (HelixEditor["controlsLabel"]) | undefined;
|
|
17461
|
+
/** The document's name where `label` is empty and the host has no `aria-label`. */
|
|
17462
|
+
"attr:fallback-label"?: (HelixEditor["fallbackLabel"]) | undefined;
|
|
17463
|
+
/** The document's name where `label` is empty and the host has no `aria-label`. */
|
|
17464
|
+
"prop:fallbackLabel"?: (HelixEditor["fallbackLabel"]) | undefined;
|
|
17465
|
+
/** The Find button's label, and the find bar's name. */
|
|
17466
|
+
"attr:find-label"?: (HelixEditor["findLabel"]) | undefined;
|
|
17467
|
+
/** The Find button's label, and the find bar's name. */
|
|
17468
|
+
"prop:findLabel"?: (HelixEditor["findLabel"]) | undefined;
|
|
17469
|
+
/** A heading's name in the block menu. `{level}` is its level, 1 to 3. */
|
|
17470
|
+
"attr:heading-label"?: (HelixEditor["headingLabel"]) | undefined;
|
|
17471
|
+
/** A heading's name in the block menu. `{level}` is its level, 1 to 3. */
|
|
17472
|
+
"prop:headingLabel"?: (HelixEditor["headingLabel"]) | undefined;
|
|
17473
|
+
/** The Italic button's label. */
|
|
17474
|
+
"attr:italic-label"?: (HelixEditor["italicLabel"]) | undefined;
|
|
17475
|
+
/** The Italic button's label. */
|
|
17476
|
+
"prop:italicLabel"?: (HelixEditor["italicLabel"]) | undefined;
|
|
17477
|
+
/** The document's name, read by screen readers. Name what it holds, such as
|
|
17478
|
+
"Release notes", so that several editors on one page can be told apart.
|
|
17479
|
+
Required. */
|
|
17480
|
+
"prop:label"?: (HelixEditor["label"]) | undefined;
|
|
17481
|
+
/** The Apply button's label in the address bar. */
|
|
17482
|
+
"attr:link-apply-label"?: (HelixEditor["linkApplyLabel"]) | undefined;
|
|
17483
|
+
/** The Apply button's label in the address bar. */
|
|
17484
|
+
"prop:linkApplyLabel"?: (HelixEditor["linkApplyLabel"]) | undefined;
|
|
17485
|
+
/** The close button's label in the address bar. */
|
|
17486
|
+
"attr:link-close-label"?: (HelixEditor["linkCloseLabel"]) | undefined;
|
|
17487
|
+
/** The close button's label in the address bar. */
|
|
17488
|
+
"prop:linkCloseLabel"?: (HelixEditor["linkCloseLabel"]) | undefined;
|
|
17489
|
+
/** The name of the address bar's toolbar, read by screen readers. */
|
|
17490
|
+
"attr:link-controls-label"?: (HelixEditor["linkControlsLabel"]) | undefined;
|
|
17491
|
+
/** The name of the address bar's toolbar, read by screen readers. */
|
|
17492
|
+
"prop:linkControlsLabel"?: (HelixEditor["linkControlsLabel"]) | undefined;
|
|
17493
|
+
/** The address field's name, which it also shows while it is empty. */
|
|
17494
|
+
"attr:link-field-label"?: (HelixEditor["linkFieldLabel"]) | undefined;
|
|
17495
|
+
/** The address field's name, which it also shows while it is empty. */
|
|
17496
|
+
"prop:linkFieldLabel"?: (HelixEditor["linkFieldLabel"]) | undefined;
|
|
17497
|
+
/** The Link button's label, and the address bar's name. */
|
|
17498
|
+
"attr:link-label"?: (HelixEditor["linkLabel"]) | undefined;
|
|
17499
|
+
/** The Link button's label, and the address bar's name. */
|
|
17500
|
+
"prop:linkLabel"?: (HelixEditor["linkLabel"]) | undefined;
|
|
17501
|
+
/** The Remove button's label in the address bar. */
|
|
17502
|
+
"attr:link-remove-label"?: (HelixEditor["linkRemoveLabel"]) | undefined;
|
|
17503
|
+
/** The Remove button's label in the address bar. */
|
|
17504
|
+
"prop:linkRemoveLabel"?: (HelixEditor["linkRemoveLabel"]) | undefined;
|
|
17505
|
+
/** The Numbered list button's label. */
|
|
17506
|
+
"attr:ordered-list-label"?: (HelixEditor["orderedListLabel"]) | undefined;
|
|
17507
|
+
/** The Numbered list button's label. */
|
|
17508
|
+
"prop:orderedListLabel"?: (HelixEditor["orderedListLabel"]) | undefined;
|
|
17509
|
+
/** The Paragraph row's label in the block menu. */
|
|
17510
|
+
"attr:paragraph-label"?: (HelixEditor["paragraphLabel"]) | undefined;
|
|
17511
|
+
/** The Paragraph row's label in the block menu. */
|
|
17512
|
+
"prop:paragraphLabel"?: (HelixEditor["paragraphLabel"]) | undefined;
|
|
17513
|
+
/** The words shown in an empty document, such as "Write the release notes". */
|
|
17514
|
+
"prop:placeholder"?: (HelixEditor["placeholder"]) | undefined;
|
|
17515
|
+
/** The Quote button's label. */
|
|
17516
|
+
"attr:quote-label"?: (HelixEditor["quoteLabel"]) | undefined;
|
|
17517
|
+
/** The Quote button's label. */
|
|
17518
|
+
"prop:quoteLabel"?: (HelixEditor["quoteLabel"]) | undefined;
|
|
17519
|
+
/** Shows the document and takes no edits, with no toolbar, for a document
|
|
17520
|
+
someone reads, or one an agent is writing. The attribute is `readonly`,
|
|
17521
|
+
the platform's spelling. */
|
|
17522
|
+
"bool:readonly"?: (HelixEditor["readOnly"]) | undefined;
|
|
17523
|
+
/** Shows the document and takes no edits, with no toolbar, for a document
|
|
17524
|
+
someone reads, or one an agent is writing. The attribute is `readonly`,
|
|
17525
|
+
the platform's spelling. */
|
|
17526
|
+
"prop:readOnly"?: (HelixEditor["readOnly"]) | undefined;
|
|
17527
|
+
/** The Redo button's label. */
|
|
17528
|
+
"attr:redo-label"?: (HelixEditor["redoLabel"]) | undefined;
|
|
17529
|
+
/** The Redo button's label. */
|
|
17530
|
+
"prop:redoLabel"?: (HelixEditor["redoLabel"]) | undefined;
|
|
17531
|
+
/** The Strikethrough button's label. */
|
|
17532
|
+
"attr:strike-label"?: (HelixEditor["strikeLabel"]) | undefined;
|
|
17533
|
+
/** The Strikethrough button's label. */
|
|
17534
|
+
"prop:strikeLabel"?: (HelixEditor["strikeLabel"]) | undefined;
|
|
17535
|
+
/** Which groups of tools the toolbar draws, as a list of `history`, `block`,
|
|
17536
|
+
`marks`, `link`, `lists`, and `quote`, or `none`. They are drawn in that
|
|
17537
|
+
order, whatever order the list is in. Absent is all six. */
|
|
17538
|
+
"prop:tools"?: (HelixEditor["tools"]) | undefined;
|
|
17539
|
+
/** The Undo button's label. */
|
|
17540
|
+
"attr:undo-label"?: (HelixEditor["undoLabel"]) | undefined;
|
|
17541
|
+
/** The Undo button's label. */
|
|
17542
|
+
"prop:undoLabel"?: (HelixEditor["undoLabel"]) | undefined;
|
|
17543
|
+
/** The find bar searched or moved among the matches, with `count` and the selected match's `index`, counting from 0, or -1 for none. */
|
|
17544
|
+
"on:helix-found"?: ((e: HelixEditorHelixFoundElementEvent) => void) | undefined;
|
|
17545
|
+
|
|
17546
|
+
/** Set the innerHTML of the element */
|
|
17547
|
+
innerHTML?: (string) | undefined;
|
|
17548
|
+
/** Set the textContent of the element */
|
|
17549
|
+
textContent?: (string | number) | undefined;
|
|
17550
|
+
};
|
|
17551
|
+
|
|
17293
17552
|
export type HelixEmptyProps = {
|
|
17294
17553
|
/** The heading as words, such as "No results", drawn as a heading when
|
|
17295
17554
|
nothing is slotted into `heading`.
|
|
@@ -54896,7 +55155,7 @@ export type CustomElements<F extends Framework = "other"> = {
|
|
|
54896
55155
|
* header, a find bar and a status line each a strip on the raised surface,
|
|
54897
55156
|
* one frame around them. It is 24rem tall unless `fill` is set or
|
|
54898
55157
|
* `--code-editor-block-size` says otherwise. An engine draws inside it:
|
|
54899
|
-
* `@fusion.dev/helix-editor` themes CodeMirror's gutter, caret, selection and
|
|
55158
|
+
* `@fusion.dev/helix-code-editor` themes CodeMirror's gutter, caret, selection and
|
|
54900
55159
|
* syntax from your tokens, and draws a problem's line number in its tone.
|
|
54901
55160
|
*
|
|
54902
55161
|
* Set `fill` for an editor that fills a pane, such as one side of a split
|
|
@@ -55002,7 +55261,7 @@ export type CustomElements<F extends Framework = "other"> = {
|
|
|
55002
55261
|
* Here rather than on each control.
|
|
55003
55262
|
* - `diagnostics`: The problems in the text, each underlined and listed under the editor. (property only)
|
|
55004
55263
|
* - `engine`: What draws the editor, such as `codeMirrorEngine()` from
|
|
55005
|
-
* `@fusion.dev/helix-editor`. Absent, the editor is a plain text field. (property only)
|
|
55264
|
+
* `@fusion.dev/helix-code-editor`. Absent, the editor is a plain text field. (property only)
|
|
55006
55265
|
* - `validity`: Whether the control meets its constraints, and why not. (property only) (readonly)
|
|
55007
55266
|
* - `validationMessage`: The message the browser would show for the control, or an empty string. (property only) (readonly)
|
|
55008
55267
|
* - `willValidate`: Whether the control is checked when its form is submitted. (property only) (readonly)
|
|
@@ -60205,6 +60464,331 @@ export type CustomElements<F extends Framework = "other"> = {
|
|
|
60205
60464
|
HelixDrilldownProps & BaseProps<HelixDrilldown, F> & BaseEvents<HelixDrilldown>
|
|
60206
60465
|
>;
|
|
60207
60466
|
|
|
60467
|
+
/**
|
|
60468
|
+
* Drawn as Code Editor is: the document on the page's ground, and the toolbar
|
|
60469
|
+
* a strip on the raised surface, one frame around them. The strip stays at the
|
|
60470
|
+
* top of the page while a long document scrolls under it, and the frame grows
|
|
60471
|
+
* with the document from `--editor-min-block-size`. Set `fill` for an editor
|
|
60472
|
+
* that fills a pane, where the document scrolls inside the frame.
|
|
60473
|
+
*
|
|
60474
|
+
* The document's headings, lists, quotes, code, and tables are drawn by the
|
|
60475
|
+
* base layer's `data-prose` rules, so it reads as your docs and chat replies
|
|
60476
|
+
* do. Write `data-prose` on the document so the base layer draws it before a
|
|
60477
|
+
* renderer connects, and `connectEditor` writes it too. Its lines keep to a
|
|
60478
|
+
* readable length, `--editor-measure`, centered in a wide frame.
|
|
60479
|
+
*
|
|
60480
|
+
* ## Attributes & Properties
|
|
60481
|
+
*
|
|
60482
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
60483
|
+
*
|
|
60484
|
+
* - `fill`: Covers the container instead of growing with the document, for an editor
|
|
60485
|
+
* that fills a pane, such as one side of a split view. The document scrolls
|
|
60486
|
+
* inside the frame. The container needs a position, such as
|
|
60487
|
+
* `position: relative`.
|
|
60488
|
+
* - `separation`: How the frame stands off the page. Unset, it is outlined. `plain` draws
|
|
60489
|
+
* no edge or corners, for a document that fills a page or a pane of its own.
|
|
60490
|
+
* - `block-chosen-label`/`blockChosenLabel`: The block menu button's name. `{name}` is the block type at the selection.
|
|
60491
|
+
* - `block-label`/`blockLabel`: The block menu's name, read by screen readers.
|
|
60492
|
+
* - `bold-label`/`boldLabel`: The Bold button's label.
|
|
60493
|
+
* - `bullet-list-label`/`bulletListLabel`: The Bulleted list button's label.
|
|
60494
|
+
* - `code-block-label`/`codeBlockLabel`: The Code block row's label in the block menu.
|
|
60495
|
+
* - `code-label`/`codeLabel`: The Code button's label.
|
|
60496
|
+
* - `controls-label`/`controlsLabel`: The toolbar's name, read by screen readers.
|
|
60497
|
+
* - `fallback-label`/`fallbackLabel`: The document's name where `label` is empty and the host has no `aria-label`.
|
|
60498
|
+
* - `find-label`/`findLabel`: The Find button's label, and the find bar's name.
|
|
60499
|
+
* - `heading-label`/`headingLabel`: A heading's name in the block menu. `{level}` is its level, 1 to 3.
|
|
60500
|
+
* - `italic-label`/`italicLabel`: The Italic button's label.
|
|
60501
|
+
* - `label`: The document's name, read by screen readers. Name what it holds, such as
|
|
60502
|
+
* "Release notes", so that several editors on one page can be told apart.
|
|
60503
|
+
* Required.
|
|
60504
|
+
* - `link-apply-label`/`linkApplyLabel`: The Apply button's label in the address bar.
|
|
60505
|
+
* - `link-close-label`/`linkCloseLabel`: The close button's label in the address bar.
|
|
60506
|
+
* - `link-controls-label`/`linkControlsLabel`: The name of the address bar's toolbar, read by screen readers.
|
|
60507
|
+
* - `link-field-label`/`linkFieldLabel`: The address field's name, which it also shows while it is empty.
|
|
60508
|
+
* - `link-label`/`linkLabel`: The Link button's label, and the address bar's name.
|
|
60509
|
+
* - `link-remove-label`/`linkRemoveLabel`: The Remove button's label in the address bar.
|
|
60510
|
+
* - `ordered-list-label`/`orderedListLabel`: The Numbered list button's label.
|
|
60511
|
+
* - `paragraph-label`/`paragraphLabel`: The Paragraph row's label in the block menu.
|
|
60512
|
+
* - `placeholder`: The words shown in an empty document, such as "Write the release notes".
|
|
60513
|
+
* - `quote-label`/`quoteLabel`: The Quote button's label.
|
|
60514
|
+
* - `readonly`/`readOnly`: Shows the document and takes no edits, with no toolbar, for a document
|
|
60515
|
+
* someone reads, or one an agent is writing. The attribute is `readonly`,
|
|
60516
|
+
* the platform's spelling.
|
|
60517
|
+
* - `redo-label`/`redoLabel`: The Redo button's label.
|
|
60518
|
+
* - `strike-label`/`strikeLabel`: The Strikethrough button's label.
|
|
60519
|
+
* - `tools`: Which groups of tools the toolbar draws, as a list of `history`, `block`,
|
|
60520
|
+
* `marks`, `link`, `lists`, and `quote`, or `none`. They are drawn in that
|
|
60521
|
+
* order, whatever order the list is in. Absent is all six.
|
|
60522
|
+
* - `undo-label`/`undoLabel`: The Undo button's label.
|
|
60523
|
+
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
60524
|
+
*
|
|
60525
|
+
* **Named `whenSettled` because `settled` is taken four times over**, by
|
|
60526
|
+
* Image, Splitter and both color controls, none of them about transitions. A
|
|
60527
|
+
* base class takes the name every subclass then cannot use.
|
|
60528
|
+
*
|
|
60529
|
+
* **The state it reports cannot be watched, which is why this exists.** A
|
|
60530
|
+
* custom state is deliberately not in the DOM, so there is no
|
|
60531
|
+
* `MutationObserver` equivalent for `ElementInternals.states`. Await this
|
|
60532
|
+
* instead.
|
|
60533
|
+
*
|
|
60534
|
+
* Separate from `updateComplete`, which resolves in the microtask checkpoint
|
|
60535
|
+
* the suppression is still active in. That is the distinction `readyToMove`
|
|
60536
|
+
* in `@fusion.dev/helix-testing` is written around.
|
|
60537
|
+
*
|
|
60538
|
+
* It never resolves where `requestAnimationFrame` never fires, which is a
|
|
60539
|
+
* server, a hidden tab, and happy-dom. Callers that must not hang there race
|
|
60540
|
+
* it against a timeout, as the happy-dom harness's `readyToMove` does. The
|
|
60541
|
+
* browser harness's awaits it alone: a browser always runs the frame, and a
|
|
60542
|
+
* timer beside it was a bet on how long one takes, which a busy run lost. (property only) (readonly)
|
|
60543
|
+
*
|
|
60544
|
+
* ## Events
|
|
60545
|
+
*
|
|
60546
|
+
* Events that will be emitted by the component.
|
|
60547
|
+
*
|
|
60548
|
+
* - `helix-found`: The find bar searched or moved among the matches, with `count` and the selected match's `index`, counting from 0, or -1 for none.
|
|
60549
|
+
*
|
|
60550
|
+
* ## Slots
|
|
60551
|
+
*
|
|
60552
|
+
* Areas where markup can be added to the component.
|
|
60553
|
+
*
|
|
60554
|
+
* - `(default)`: The element your renderer draws the document in.
|
|
60555
|
+
* - `actions`: Controls of your own at the end of the toolbar, such as Share or Comment.
|
|
60556
|
+
* - `bold-icon`: Replaces the glyph inside the Bold button.
|
|
60557
|
+
* - `bullet-list-icon`: Replaces the glyph inside the Bulleted list button.
|
|
60558
|
+
* - `code-icon`: Replaces the glyph inside the Code button.
|
|
60559
|
+
* - `find-icon`: Replaces the glyph inside the Find button.
|
|
60560
|
+
* - `footer`: Content under the document, such as a word count or whether it is saved.
|
|
60561
|
+
* - `italic-icon`: Replaces the glyph inside the Italic button.
|
|
60562
|
+
* - `link-icon`: Replaces the glyph inside the Link button.
|
|
60563
|
+
* - `ordered-list-icon`: Replaces the glyph inside the Numbered list button.
|
|
60564
|
+
* - `quote-icon`: Replaces the glyph inside the Quote button.
|
|
60565
|
+
* - `redo-icon`: Replaces the glyph inside the Redo button.
|
|
60566
|
+
* - `strike-icon`: Replaces the glyph inside the Strikethrough button.
|
|
60567
|
+
* - `undo-icon`: Replaces the glyph inside the Undo button.
|
|
60568
|
+
*
|
|
60569
|
+
* ## Methods
|
|
60570
|
+
*
|
|
60571
|
+
* Methods that can be called to access component functionality.
|
|
60572
|
+
*
|
|
60573
|
+
* - `attach(renderer: EditorRenderer) => EditorSink`: Hands the frame what draws the document. The frame sends it the settings
|
|
60574
|
+
* now and as they change, asks it to run the tools the reader presses, and
|
|
60575
|
+
* draws the toolbar from what it reports through the sink it gets back.
|
|
60576
|
+
* Attaching another renderer detaches this one.
|
|
60577
|
+
* - `run(tool: EditorTool, value?: string) => boolean`: Runs a tool at the selection, as its button does, and says whether it
|
|
60578
|
+
* ran: a block type, a mark, a list, a quote, a step through history, or a
|
|
60579
|
+
* link to `value`, where an empty `value` takes the link off. Nothing runs
|
|
60580
|
+
* while no renderer is attached, or while `readonly`.
|
|
60581
|
+
* - `focus(options?: FocusOptions) => void`: Puts focus in the document, with the selection where it was.
|
|
60582
|
+
* - `openLink() => void`: Opens the address bar with the address of the link at the selection, and puts focus in its field.
|
|
60583
|
+
*
|
|
60584
|
+
* ## CSS Custom Properties
|
|
60585
|
+
*
|
|
60586
|
+
* CSS variables available for styling the component.
|
|
60587
|
+
*
|
|
60588
|
+
* - `--editor-background-color`: The ground the document is drawn on. Defaults to the page's background.
|
|
60589
|
+
* - `--editor-border-color`: The frame's edge and the line under the toolbar.
|
|
60590
|
+
* - `--editor-header-background-color`: The fill of the toolbar's strip.
|
|
60591
|
+
* - `--editor-header-offset`: How far below the top of the page the toolbar stays while the document scrolls, such as the height of your own fixed header. `0` unless set.
|
|
60592
|
+
* - `--editor-measure`: The longest a line of the document runs, as a length: `72ch` unless set.
|
|
60593
|
+
* - `--editor-min-block-size`: The frame's least height, which it grows from with the document: `12rem` unless set. Ignored with `fill`.
|
|
60594
|
+
* - `--editor-padding`: The space around the document, inside the frame.
|
|
60595
|
+
* - `--editor-radius`: The frame's corner radius.
|
|
60596
|
+
*
|
|
60597
|
+
* ## CSS Parts
|
|
60598
|
+
*
|
|
60599
|
+
* Custom selectors for styling elements within the component.
|
|
60600
|
+
*
|
|
60601
|
+
* - `actions`: The `actions` slot, last in the toolbar.
|
|
60602
|
+
* - `block`: The button that opens the block menu, which names the block type at the selection.
|
|
60603
|
+
* - `block-button`: The block menu button's inner button.
|
|
60604
|
+
* - `block-live`: The block menu button's live region, which speaks while the button is pending.
|
|
60605
|
+
* - `block-menu`: The menu of block types.
|
|
60606
|
+
* - `block-menu-back`: The control that returns from a submenu.
|
|
60607
|
+
* - `block-menu-back-mark`: The glyph on the back control of a submenu.
|
|
60608
|
+
* - `block-menu-empty`: The text shown when the menu has no items.
|
|
60609
|
+
* - `block-menu-header`: The bar above a submenu, holding the way back and its name.
|
|
60610
|
+
* - `block-menu-live`: The block menu's live region, which repeats the empty and loading text for screen readers.
|
|
60611
|
+
* - `block-menu-loading`: The text shown while the items are loading.
|
|
60612
|
+
* - `block-menu-search-field`: The block menu's filter field, drawn with `filterable`.
|
|
60613
|
+
* - `block-menu-surface`: The floating panel the block menu is drawn on.
|
|
60614
|
+
* - `block-menu-title`: The name of the submenu that is showing.
|
|
60615
|
+
* - `block-name`: The name of the block type at the selection, in the block menu's button.
|
|
60616
|
+
* - `block-option`: One block type in the block menu, checked while the selection is in one.
|
|
60617
|
+
* - `block-option-end`: A block type's trailing column, which holds its shortcut.
|
|
60618
|
+
* - `block-option-item`: A block type's row.
|
|
60619
|
+
* - `block-option-mark`: The check beside the block type the selection is in.
|
|
60620
|
+
* - `block-option-shortcut`: A block type's key.
|
|
60621
|
+
* - `block-option-shortcut-kbd`: The key inside it.
|
|
60622
|
+
* - `block-option-shortcut-key`: One key of a block type's chord.
|
|
60623
|
+
* - `block-option-shortcut-separator`: The `+` between two keys of a block type's chord.
|
|
60624
|
+
* - `block-option-start`: A block type's leading column.
|
|
60625
|
+
* - `block-option-surface`: A block type's submenu panel, which a block type does not open.
|
|
60626
|
+
* - `block-spinner`: The ring the block menu button turns while it is pending.
|
|
60627
|
+
* - `block-text`: The box the block menu button's words sit in.
|
|
60628
|
+
* - `bold`: The Bold button. Pressed while the selection is bold.
|
|
60629
|
+
* - `bold-button`: The Bold button's inner button.
|
|
60630
|
+
* - `bold-live`: The Bold button's live region, which speaks while the button is pending.
|
|
60631
|
+
* - `bold-pressed`: The Bold button while the selection is bold, beside `bold`.
|
|
60632
|
+
* - `bold-spinner`: The ring the Bold button turns while it is pending.
|
|
60633
|
+
* - `bold-text`: The box the Bold button's icon sits in.
|
|
60634
|
+
* - `bullet-list`: The Bulleted list button. Pressed while the selection is in a bulleted list.
|
|
60635
|
+
* - `bullet-list-button`: The Bulleted list button's inner button.
|
|
60636
|
+
* - `bullet-list-live`: The Bulleted list button's live region, which speaks while the button is pending.
|
|
60637
|
+
* - `bullet-list-pressed`: The Bulleted list button while the selection is in a bulleted list, beside `bullet-list`.
|
|
60638
|
+
* - `bullet-list-spinner`: The ring the Bulleted list button turns while it is pending.
|
|
60639
|
+
* - `bullet-list-text`: The box the Bulleted list button's icon sits in.
|
|
60640
|
+
* - `code`: The Code button. Pressed while the selection is code.
|
|
60641
|
+
* - `code-button`: The Code button's inner button.
|
|
60642
|
+
* - `code-live`: The Code button's live region, which speaks while the button is pending.
|
|
60643
|
+
* - `code-pressed`: The Code button while the selection is code, beside `code`.
|
|
60644
|
+
* - `code-spinner`: The ring the Code button turns while it is pending.
|
|
60645
|
+
* - `code-text`: The box the Code button's icon sits in.
|
|
60646
|
+
* - `controls`: The toolbar: the tools, then your actions, one tab stop that the arrows move along.
|
|
60647
|
+
* - `controls-toolbar`: The box inside the toolbar that lays its buttons out.
|
|
60648
|
+
* - `divider`: The line between two groups of tools.
|
|
60649
|
+
* - `divider-content`: The content set into a divider, which the editor sets none into.
|
|
60650
|
+
* - `divider-line`: The line itself.
|
|
60651
|
+
* - `find`: The find bar under the toolbar, where the reader searches the document: a Find of its own.
|
|
60652
|
+
* - `find-actions`: The find bar's `actions` slot, which the editor fills with nothing.
|
|
60653
|
+
* - `find-bar`: The find bar's strip: the field, the count, the toolbar, and the replace row while it shows.
|
|
60654
|
+
* - `find-close`: The button that closes the find bar.
|
|
60655
|
+
* - `find-close-button`: The find bar's close button's inner button.
|
|
60656
|
+
* - `find-close-live`: The find bar's close button's live region, which speaks while the button is pending.
|
|
60657
|
+
* - `find-close-spinner`: The ring the find bar's close button turns while it is pending.
|
|
60658
|
+
* - `find-close-text`: The box the find bar's close button's icon sits in.
|
|
60659
|
+
* - `find-controls`: The find bar's toolbar of options and moves.
|
|
60660
|
+
* - `find-controls-toolbar`: The box inside the find bar's toolbar that lays its buttons out.
|
|
60661
|
+
* - `find-count`: Which match is selected, of how many.
|
|
60662
|
+
* - `find-field`: The field the search is typed in.
|
|
60663
|
+
* - `find-live`: The find bar's live region, which says the count as it changes.
|
|
60664
|
+
* - `find-match-case`: The option that finds only the same case. Pressed while it applies.
|
|
60665
|
+
* - `find-match-case-button`: The match case button's inner button.
|
|
60666
|
+
* - `find-match-case-live`: The match case button's live region, which speaks while the button is pending.
|
|
60667
|
+
* - `find-match-case-pressed`: The match case option while it applies, beside `find-match-case`.
|
|
60668
|
+
* - `find-match-case-spinner`: The ring the match case button turns while it is pending.
|
|
60669
|
+
* - `find-match-case-text`: The box the match case button's icon sits in.
|
|
60670
|
+
* - `find-next`: The button that selects the next match.
|
|
60671
|
+
* - `find-next-button`: The next match button's inner button.
|
|
60672
|
+
* - `find-next-live`: The next match button's live region, which speaks while the button is pending.
|
|
60673
|
+
* - `find-next-spinner`: The ring the next match button turns while it is pending.
|
|
60674
|
+
* - `find-next-text`: The box the next match button's icon sits in.
|
|
60675
|
+
* - `find-previous`: The button that selects the previous match.
|
|
60676
|
+
* - `find-previous-button`: The previous match button's inner button.
|
|
60677
|
+
* - `find-previous-live`: The previous match button's live region, which speaks while the button is pending.
|
|
60678
|
+
* - `find-previous-spinner`: The ring the previous match button turns while it is pending.
|
|
60679
|
+
* - `find-previous-text`: The box the previous match button's icon sits in.
|
|
60680
|
+
* - `find-regex`: The option that reads the search as a regular expression. Pressed while it applies.
|
|
60681
|
+
* - `find-regex-button`: The regular expression button's inner button.
|
|
60682
|
+
* - `find-regex-live`: The regular expression button's live region, which speaks while the button is pending.
|
|
60683
|
+
* - `find-regex-pressed`: The regular expression option while it applies, beside `find-regex`.
|
|
60684
|
+
* - `find-regex-spinner`: The ring the regular expression button turns while it is pending.
|
|
60685
|
+
* - `find-regex-text`: The box the regular expression button's icon sits in.
|
|
60686
|
+
* - `find-replace`: The button that replaces the selected match.
|
|
60687
|
+
* - `find-replace-all`: The button that replaces every match.
|
|
60688
|
+
* - `find-replace-all-button`: The Replace all button's inner button.
|
|
60689
|
+
* - `find-replace-all-live`: The Replace all button's live region, which speaks while the button is pending.
|
|
60690
|
+
* - `find-replace-all-spinner`: The ring the Replace all button turns while it is pending.
|
|
60691
|
+
* - `find-replace-all-text`: The box the Replace all button's words sits in.
|
|
60692
|
+
* - `find-replace-button`: The Replace button's inner button.
|
|
60693
|
+
* - `find-replace-field`: The field the replacement is typed in.
|
|
60694
|
+
* - `find-replace-live`: The Replace button's live region, which speaks while the button is pending.
|
|
60695
|
+
* - `find-replace-spinner`: The ring the Replace button turns while it is pending.
|
|
60696
|
+
* - `find-replace-text`: The box the Replace button's words sits in.
|
|
60697
|
+
* - `find-replace-toggle`: The button that shows the replace field under the find field. Expanded while it shows. Not drawn while `readonly`.
|
|
60698
|
+
* - `find-replace-toggle-button`: The find and replace button's inner button.
|
|
60699
|
+
* - `find-replace-toggle-live`: The find and replace button's live region, which speaks while the button is pending.
|
|
60700
|
+
* - `find-replace-toggle-spinner`: The ring the find and replace button turns while it is pending.
|
|
60701
|
+
* - `find-replace-toggle-text`: The box the find and replace button's icon sits in.
|
|
60702
|
+
* - `find-toggle`: The Find button in the toolbar, drawn where `tools` names `find`, which opens and closes the find bar. Expanded while it is open.
|
|
60703
|
+
* - `find-toggle-button`: The Find button's inner button.
|
|
60704
|
+
* - `find-toggle-live`: The Find button's live region, which speaks while the button is pending.
|
|
60705
|
+
* - `find-toggle-spinner`: The ring the Find button turns while it is pending.
|
|
60706
|
+
* - `find-toggle-text`: The box the Find button's icon sits in.
|
|
60707
|
+
* - `find-whole-word`: The option that finds only whole words. Pressed while it applies.
|
|
60708
|
+
* - `find-whole-word-button`: The whole word button's inner button.
|
|
60709
|
+
* - `find-whole-word-live`: The whole word button's live region, which speaks while the button is pending.
|
|
60710
|
+
* - `find-whole-word-pressed`: The whole word option while it applies, beside `find-whole-word`.
|
|
60711
|
+
* - `find-whole-word-spinner`: The ring the whole word button turns while it is pending.
|
|
60712
|
+
* - `find-whole-word-text`: The box the whole word button's icon sits in.
|
|
60713
|
+
* - `footer`: The `footer` slot, under the document.
|
|
60714
|
+
* - `header`: The strip above the document that holds the toolbar, and the address bar under it while it is open.
|
|
60715
|
+
* - `italic`: The Italic button. Pressed while the selection is italic.
|
|
60716
|
+
* - `italic-button`: The Italic button's inner button.
|
|
60717
|
+
* - `italic-live`: The Italic button's live region, which speaks while the button is pending.
|
|
60718
|
+
* - `italic-pressed`: The Italic button while the selection is italic, beside `italic`.
|
|
60719
|
+
* - `italic-spinner`: The ring the Italic button turns while it is pending.
|
|
60720
|
+
* - `italic-text`: The box the Italic button's icon sits in.
|
|
60721
|
+
* - `link`: The Link button, which opens the address bar. Pressed while the selection is in a link, and expanded while the bar is open.
|
|
60722
|
+
* - `link-apply`: The button that applies the address.
|
|
60723
|
+
* - `link-apply-button`: The Apply button's inner button.
|
|
60724
|
+
* - `link-apply-live`: The Apply button's live region, which speaks while the button is pending.
|
|
60725
|
+
* - `link-apply-spinner`: The ring the Apply button turns while it is pending.
|
|
60726
|
+
* - `link-apply-text`: The box the Apply button's icon sits in.
|
|
60727
|
+
* - `link-bar`: The bar under the toolbar where the reader writes a link's address.
|
|
60728
|
+
* - `link-button`: The Link button's inner button.
|
|
60729
|
+
* - `link-close`: The button that closes the address bar.
|
|
60730
|
+
* - `link-close-button`: The close button's inner button.
|
|
60731
|
+
* - `link-close-live`: The close button's live region, which speaks while the button is pending.
|
|
60732
|
+
* - `link-close-spinner`: The ring the close button turns while it is pending.
|
|
60733
|
+
* - `link-close-text`: The box the close button's icon sits in.
|
|
60734
|
+
* - `link-controls`: The toolbar at the end of the address bar: Apply, Remove, and Close.
|
|
60735
|
+
* - `link-controls-toolbar`: The box inside the address bar's toolbar that lays its buttons out.
|
|
60736
|
+
* - `link-field`: The field the address is written in.
|
|
60737
|
+
* - `link-live`: The Link button's live region, which speaks while the button is pending.
|
|
60738
|
+
* - `link-pressed`: The Link button while the selection is in a link, beside `link`.
|
|
60739
|
+
* - `link-remove`: The button that takes the link off. Disabled where the selection is in no link.
|
|
60740
|
+
* - `link-remove-button`: The Remove button's inner button.
|
|
60741
|
+
* - `link-remove-live`: The Remove button's live region, which speaks while the button is pending.
|
|
60742
|
+
* - `link-remove-spinner`: The ring the Remove button turns while it is pending.
|
|
60743
|
+
* - `link-remove-text`: The box the Remove button's icon sits in.
|
|
60744
|
+
* - `link-spinner`: The ring the Link button turns while it is pending.
|
|
60745
|
+
* - `link-text`: The box the Link button's icon sits in.
|
|
60746
|
+
* - `ordered-list`: The Numbered list button. Pressed while the selection is in a numbered list.
|
|
60747
|
+
* - `ordered-list-button`: The Numbered list button's inner button.
|
|
60748
|
+
* - `ordered-list-live`: The Numbered list button's live region, which speaks while the button is pending.
|
|
60749
|
+
* - `ordered-list-pressed`: The Numbered list button while the selection is in a numbered list, beside `ordered-list`.
|
|
60750
|
+
* - `ordered-list-spinner`: The ring the Numbered list button turns while it is pending.
|
|
60751
|
+
* - `ordered-list-text`: The box the Numbered list button's icon sits in.
|
|
60752
|
+
* - `quote`: The Quote button. Pressed while the selection is in a quote.
|
|
60753
|
+
* - `quote-button`: The Quote button's inner button.
|
|
60754
|
+
* - `quote-live`: The Quote button's live region, which speaks while the button is pending.
|
|
60755
|
+
* - `quote-pressed`: The Quote button while the selection is in a quote, beside `quote`.
|
|
60756
|
+
* - `quote-spinner`: The ring the Quote button turns while it is pending.
|
|
60757
|
+
* - `quote-text`: The box the Quote button's icon sits in.
|
|
60758
|
+
* - `redo`: The Redo button. Disabled while there is nothing to redo.
|
|
60759
|
+
* - `redo-button`: The Redo button's inner button.
|
|
60760
|
+
* - `redo-live`: The Redo button's live region, which speaks while the button is pending.
|
|
60761
|
+
* - `redo-spinner`: The ring the Redo button turns while it is pending.
|
|
60762
|
+
* - `redo-text`: The box the Redo button's icon sits in.
|
|
60763
|
+
* - `region`: The frame around the toolbar, the address bar, and the document.
|
|
60764
|
+
* - `strike`: The Strikethrough button. Pressed while the selection is struck through.
|
|
60765
|
+
* - `strike-button`: The Strikethrough button's inner button.
|
|
60766
|
+
* - `strike-live`: The Strikethrough button's live region, which speaks while the button is pending.
|
|
60767
|
+
* - `strike-pressed`: The Strikethrough button while the selection is struck through, beside `strike`.
|
|
60768
|
+
* - `strike-spinner`: The ring the Strikethrough button turns while it is pending.
|
|
60769
|
+
* - `strike-text`: The box the Strikethrough button's icon sits in.
|
|
60770
|
+
* - `tools`: A group of several tools, which a narrow toolbar wraps as one: Undo and Redo, the marks, or the lists and the quote.
|
|
60771
|
+
* - `undo`: The Undo button. Disabled while there is nothing to undo.
|
|
60772
|
+
* - `undo-button`: The Undo button's inner button.
|
|
60773
|
+
* - `undo-live`: The Undo button's live region, which speaks while the button is pending.
|
|
60774
|
+
* - `undo-spinner`: The ring the Undo button turns while it is pending.
|
|
60775
|
+
* - `undo-text`: The box the Undo button's icon sits in.
|
|
60776
|
+
* - `viewport`: The box the document is drawn in.
|
|
60777
|
+
*
|
|
60778
|
+
* ## CSS States
|
|
60779
|
+
*
|
|
60780
|
+
* These can be used to apply styling when a component is in a given state.
|
|
60781
|
+
*
|
|
60782
|
+
* - `connected`: A renderer draws the document.
|
|
60783
|
+
* - `document-focused`: Focus is in the document, where the reader types.
|
|
60784
|
+
* - `find-open`: The find bar is open.
|
|
60785
|
+
* - `link-open`: The address bar is open.
|
|
60786
|
+
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
60787
|
+
*/
|
|
60788
|
+
"helix-editor": Partial<
|
|
60789
|
+
HelixEditorProps & BaseProps<HelixEditor, F> & BaseEvents<HelixEditor>
|
|
60790
|
+
>;
|
|
60791
|
+
|
|
60208
60792
|
/**
|
|
60209
60793
|
* Centered with space around it. An empty view is the only thing on screen, and
|
|
60210
60794
|
* pressed against the top edge it looks broken.
|
|
@@ -89931,7 +90515,7 @@ export type CustomElementsSolidJs = {
|
|
|
89931
90515
|
* header, a find bar and a status line each a strip on the raised surface,
|
|
89932
90516
|
* one frame around them. It is 24rem tall unless `fill` is set or
|
|
89933
90517
|
* `--code-editor-block-size` says otherwise. An engine draws inside it:
|
|
89934
|
-
* `@fusion.dev/helix-editor` themes CodeMirror's gutter, caret, selection and
|
|
90518
|
+
* `@fusion.dev/helix-code-editor` themes CodeMirror's gutter, caret, selection and
|
|
89935
90519
|
* syntax from your tokens, and draws a problem's line number in its tone.
|
|
89936
90520
|
*
|
|
89937
90521
|
* Set `fill` for an editor that fills a pane, such as one side of a split
|
|
@@ -90037,7 +90621,7 @@ export type CustomElementsSolidJs = {
|
|
|
90037
90621
|
* Here rather than on each control.
|
|
90038
90622
|
* - `diagnostics`: The problems in the text, each underlined and listed under the editor. (property only)
|
|
90039
90623
|
* - `engine`: What draws the editor, such as `codeMirrorEngine()` from
|
|
90040
|
-
* `@fusion.dev/helix-editor`. Absent, the editor is a plain text field. (property only)
|
|
90624
|
+
* `@fusion.dev/helix-code-editor`. Absent, the editor is a plain text field. (property only)
|
|
90041
90625
|
* - `validity`: Whether the control meets its constraints, and why not. (property only) (readonly)
|
|
90042
90626
|
* - `validationMessage`: The message the browser would show for the control, or an empty string. (property only) (readonly)
|
|
90043
90627
|
* - `willValidate`: Whether the control is checked when its form is submitted. (property only) (readonly)
|
|
@@ -95297,6 +95881,334 @@ export type CustomElementsSolidJs = {
|
|
|
95297
95881
|
BaseEvents<HelixDrilldown>
|
|
95298
95882
|
>;
|
|
95299
95883
|
|
|
95884
|
+
/**
|
|
95885
|
+
* Drawn as Code Editor is: the document on the page's ground, and the toolbar
|
|
95886
|
+
* a strip on the raised surface, one frame around them. The strip stays at the
|
|
95887
|
+
* top of the page while a long document scrolls under it, and the frame grows
|
|
95888
|
+
* with the document from `--editor-min-block-size`. Set `fill` for an editor
|
|
95889
|
+
* that fills a pane, where the document scrolls inside the frame.
|
|
95890
|
+
*
|
|
95891
|
+
* The document's headings, lists, quotes, code, and tables are drawn by the
|
|
95892
|
+
* base layer's `data-prose` rules, so it reads as your docs and chat replies
|
|
95893
|
+
* do. Write `data-prose` on the document so the base layer draws it before a
|
|
95894
|
+
* renderer connects, and `connectEditor` writes it too. Its lines keep to a
|
|
95895
|
+
* readable length, `--editor-measure`, centered in a wide frame.
|
|
95896
|
+
*
|
|
95897
|
+
* ## Attributes & Properties
|
|
95898
|
+
*
|
|
95899
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
95900
|
+
*
|
|
95901
|
+
* - `fill`: Covers the container instead of growing with the document, for an editor
|
|
95902
|
+
* that fills a pane, such as one side of a split view. The document scrolls
|
|
95903
|
+
* inside the frame. The container needs a position, such as
|
|
95904
|
+
* `position: relative`.
|
|
95905
|
+
* - `separation`: How the frame stands off the page. Unset, it is outlined. `plain` draws
|
|
95906
|
+
* no edge or corners, for a document that fills a page or a pane of its own.
|
|
95907
|
+
* - `block-chosen-label`/`blockChosenLabel`: The block menu button's name. `{name}` is the block type at the selection.
|
|
95908
|
+
* - `block-label`/`blockLabel`: The block menu's name, read by screen readers.
|
|
95909
|
+
* - `bold-label`/`boldLabel`: The Bold button's label.
|
|
95910
|
+
* - `bullet-list-label`/`bulletListLabel`: The Bulleted list button's label.
|
|
95911
|
+
* - `code-block-label`/`codeBlockLabel`: The Code block row's label in the block menu.
|
|
95912
|
+
* - `code-label`/`codeLabel`: The Code button's label.
|
|
95913
|
+
* - `controls-label`/`controlsLabel`: The toolbar's name, read by screen readers.
|
|
95914
|
+
* - `fallback-label`/`fallbackLabel`: The document's name where `label` is empty and the host has no `aria-label`.
|
|
95915
|
+
* - `find-label`/`findLabel`: The Find button's label, and the find bar's name.
|
|
95916
|
+
* - `heading-label`/`headingLabel`: A heading's name in the block menu. `{level}` is its level, 1 to 3.
|
|
95917
|
+
* - `italic-label`/`italicLabel`: The Italic button's label.
|
|
95918
|
+
* - `label`: The document's name, read by screen readers. Name what it holds, such as
|
|
95919
|
+
* "Release notes", so that several editors on one page can be told apart.
|
|
95920
|
+
* Required.
|
|
95921
|
+
* - `link-apply-label`/`linkApplyLabel`: The Apply button's label in the address bar.
|
|
95922
|
+
* - `link-close-label`/`linkCloseLabel`: The close button's label in the address bar.
|
|
95923
|
+
* - `link-controls-label`/`linkControlsLabel`: The name of the address bar's toolbar, read by screen readers.
|
|
95924
|
+
* - `link-field-label`/`linkFieldLabel`: The address field's name, which it also shows while it is empty.
|
|
95925
|
+
* - `link-label`/`linkLabel`: The Link button's label, and the address bar's name.
|
|
95926
|
+
* - `link-remove-label`/`linkRemoveLabel`: The Remove button's label in the address bar.
|
|
95927
|
+
* - `ordered-list-label`/`orderedListLabel`: The Numbered list button's label.
|
|
95928
|
+
* - `paragraph-label`/`paragraphLabel`: The Paragraph row's label in the block menu.
|
|
95929
|
+
* - `placeholder`: The words shown in an empty document, such as "Write the release notes".
|
|
95930
|
+
* - `quote-label`/`quoteLabel`: The Quote button's label.
|
|
95931
|
+
* - `readonly`/`readOnly`: Shows the document and takes no edits, with no toolbar, for a document
|
|
95932
|
+
* someone reads, or one an agent is writing. The attribute is `readonly`,
|
|
95933
|
+
* the platform's spelling.
|
|
95934
|
+
* - `redo-label`/`redoLabel`: The Redo button's label.
|
|
95935
|
+
* - `strike-label`/`strikeLabel`: The Strikethrough button's label.
|
|
95936
|
+
* - `tools`: Which groups of tools the toolbar draws, as a list of `history`, `block`,
|
|
95937
|
+
* `marks`, `link`, `lists`, and `quote`, or `none`. They are drawn in that
|
|
95938
|
+
* order, whatever order the list is in. Absent is all six.
|
|
95939
|
+
* - `undo-label`/`undoLabel`: The Undo button's label.
|
|
95940
|
+
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
95941
|
+
*
|
|
95942
|
+
* **Named `whenSettled` because `settled` is taken four times over**, by
|
|
95943
|
+
* Image, Splitter and both color controls, none of them about transitions. A
|
|
95944
|
+
* base class takes the name every subclass then cannot use.
|
|
95945
|
+
*
|
|
95946
|
+
* **The state it reports cannot be watched, which is why this exists.** A
|
|
95947
|
+
* custom state is deliberately not in the DOM, so there is no
|
|
95948
|
+
* `MutationObserver` equivalent for `ElementInternals.states`. Await this
|
|
95949
|
+
* instead.
|
|
95950
|
+
*
|
|
95951
|
+
* Separate from `updateComplete`, which resolves in the microtask checkpoint
|
|
95952
|
+
* the suppression is still active in. That is the distinction `readyToMove`
|
|
95953
|
+
* in `@fusion.dev/helix-testing` is written around.
|
|
95954
|
+
*
|
|
95955
|
+
* It never resolves where `requestAnimationFrame` never fires, which is a
|
|
95956
|
+
* server, a hidden tab, and happy-dom. Callers that must not hang there race
|
|
95957
|
+
* it against a timeout, as the happy-dom harness's `readyToMove` does. The
|
|
95958
|
+
* browser harness's awaits it alone: a browser always runs the frame, and a
|
|
95959
|
+
* timer beside it was a bet on how long one takes, which a busy run lost. (property only) (readonly)
|
|
95960
|
+
*
|
|
95961
|
+
* ## Events
|
|
95962
|
+
*
|
|
95963
|
+
* Events that will be emitted by the component.
|
|
95964
|
+
*
|
|
95965
|
+
* - `helix-found`: The find bar searched or moved among the matches, with `count` and the selected match's `index`, counting from 0, or -1 for none.
|
|
95966
|
+
*
|
|
95967
|
+
* ## Slots
|
|
95968
|
+
*
|
|
95969
|
+
* Areas where markup can be added to the component.
|
|
95970
|
+
*
|
|
95971
|
+
* - `(default)`: The element your renderer draws the document in.
|
|
95972
|
+
* - `actions`: Controls of your own at the end of the toolbar, such as Share or Comment.
|
|
95973
|
+
* - `bold-icon`: Replaces the glyph inside the Bold button.
|
|
95974
|
+
* - `bullet-list-icon`: Replaces the glyph inside the Bulleted list button.
|
|
95975
|
+
* - `code-icon`: Replaces the glyph inside the Code button.
|
|
95976
|
+
* - `find-icon`: Replaces the glyph inside the Find button.
|
|
95977
|
+
* - `footer`: Content under the document, such as a word count or whether it is saved.
|
|
95978
|
+
* - `italic-icon`: Replaces the glyph inside the Italic button.
|
|
95979
|
+
* - `link-icon`: Replaces the glyph inside the Link button.
|
|
95980
|
+
* - `ordered-list-icon`: Replaces the glyph inside the Numbered list button.
|
|
95981
|
+
* - `quote-icon`: Replaces the glyph inside the Quote button.
|
|
95982
|
+
* - `redo-icon`: Replaces the glyph inside the Redo button.
|
|
95983
|
+
* - `strike-icon`: Replaces the glyph inside the Strikethrough button.
|
|
95984
|
+
* - `undo-icon`: Replaces the glyph inside the Undo button.
|
|
95985
|
+
*
|
|
95986
|
+
* ## Methods
|
|
95987
|
+
*
|
|
95988
|
+
* Methods that can be called to access component functionality.
|
|
95989
|
+
*
|
|
95990
|
+
* - `attach(renderer: EditorRenderer) => EditorSink`: Hands the frame what draws the document. The frame sends it the settings
|
|
95991
|
+
* now and as they change, asks it to run the tools the reader presses, and
|
|
95992
|
+
* draws the toolbar from what it reports through the sink it gets back.
|
|
95993
|
+
* Attaching another renderer detaches this one.
|
|
95994
|
+
* - `run(tool: EditorTool, value?: string) => boolean`: Runs a tool at the selection, as its button does, and says whether it
|
|
95995
|
+
* ran: a block type, a mark, a list, a quote, a step through history, or a
|
|
95996
|
+
* link to `value`, where an empty `value` takes the link off. Nothing runs
|
|
95997
|
+
* while no renderer is attached, or while `readonly`.
|
|
95998
|
+
* - `focus(options?: FocusOptions) => void`: Puts focus in the document, with the selection where it was.
|
|
95999
|
+
* - `openLink() => void`: Opens the address bar with the address of the link at the selection, and puts focus in its field.
|
|
96000
|
+
*
|
|
96001
|
+
* ## CSS Custom Properties
|
|
96002
|
+
*
|
|
96003
|
+
* CSS variables available for styling the component.
|
|
96004
|
+
*
|
|
96005
|
+
* - `--editor-background-color`: The ground the document is drawn on. Defaults to the page's background.
|
|
96006
|
+
* - `--editor-border-color`: The frame's edge and the line under the toolbar.
|
|
96007
|
+
* - `--editor-header-background-color`: The fill of the toolbar's strip.
|
|
96008
|
+
* - `--editor-header-offset`: How far below the top of the page the toolbar stays while the document scrolls, such as the height of your own fixed header. `0` unless set.
|
|
96009
|
+
* - `--editor-measure`: The longest a line of the document runs, as a length: `72ch` unless set.
|
|
96010
|
+
* - `--editor-min-block-size`: The frame's least height, which it grows from with the document: `12rem` unless set. Ignored with `fill`.
|
|
96011
|
+
* - `--editor-padding`: The space around the document, inside the frame.
|
|
96012
|
+
* - `--editor-radius`: The frame's corner radius.
|
|
96013
|
+
*
|
|
96014
|
+
* ## CSS Parts
|
|
96015
|
+
*
|
|
96016
|
+
* Custom selectors for styling elements within the component.
|
|
96017
|
+
*
|
|
96018
|
+
* - `actions`: The `actions` slot, last in the toolbar.
|
|
96019
|
+
* - `block`: The button that opens the block menu, which names the block type at the selection.
|
|
96020
|
+
* - `block-button`: The block menu button's inner button.
|
|
96021
|
+
* - `block-live`: The block menu button's live region, which speaks while the button is pending.
|
|
96022
|
+
* - `block-menu`: The menu of block types.
|
|
96023
|
+
* - `block-menu-back`: The control that returns from a submenu.
|
|
96024
|
+
* - `block-menu-back-mark`: The glyph on the back control of a submenu.
|
|
96025
|
+
* - `block-menu-empty`: The text shown when the menu has no items.
|
|
96026
|
+
* - `block-menu-header`: The bar above a submenu, holding the way back and its name.
|
|
96027
|
+
* - `block-menu-live`: The block menu's live region, which repeats the empty and loading text for screen readers.
|
|
96028
|
+
* - `block-menu-loading`: The text shown while the items are loading.
|
|
96029
|
+
* - `block-menu-search-field`: The block menu's filter field, drawn with `filterable`.
|
|
96030
|
+
* - `block-menu-surface`: The floating panel the block menu is drawn on.
|
|
96031
|
+
* - `block-menu-title`: The name of the submenu that is showing.
|
|
96032
|
+
* - `block-name`: The name of the block type at the selection, in the block menu's button.
|
|
96033
|
+
* - `block-option`: One block type in the block menu, checked while the selection is in one.
|
|
96034
|
+
* - `block-option-end`: A block type's trailing column, which holds its shortcut.
|
|
96035
|
+
* - `block-option-item`: A block type's row.
|
|
96036
|
+
* - `block-option-mark`: The check beside the block type the selection is in.
|
|
96037
|
+
* - `block-option-shortcut`: A block type's key.
|
|
96038
|
+
* - `block-option-shortcut-kbd`: The key inside it.
|
|
96039
|
+
* - `block-option-shortcut-key`: One key of a block type's chord.
|
|
96040
|
+
* - `block-option-shortcut-separator`: The `+` between two keys of a block type's chord.
|
|
96041
|
+
* - `block-option-start`: A block type's leading column.
|
|
96042
|
+
* - `block-option-surface`: A block type's submenu panel, which a block type does not open.
|
|
96043
|
+
* - `block-spinner`: The ring the block menu button turns while it is pending.
|
|
96044
|
+
* - `block-text`: The box the block menu button's words sit in.
|
|
96045
|
+
* - `bold`: The Bold button. Pressed while the selection is bold.
|
|
96046
|
+
* - `bold-button`: The Bold button's inner button.
|
|
96047
|
+
* - `bold-live`: The Bold button's live region, which speaks while the button is pending.
|
|
96048
|
+
* - `bold-pressed`: The Bold button while the selection is bold, beside `bold`.
|
|
96049
|
+
* - `bold-spinner`: The ring the Bold button turns while it is pending.
|
|
96050
|
+
* - `bold-text`: The box the Bold button's icon sits in.
|
|
96051
|
+
* - `bullet-list`: The Bulleted list button. Pressed while the selection is in a bulleted list.
|
|
96052
|
+
* - `bullet-list-button`: The Bulleted list button's inner button.
|
|
96053
|
+
* - `bullet-list-live`: The Bulleted list button's live region, which speaks while the button is pending.
|
|
96054
|
+
* - `bullet-list-pressed`: The Bulleted list button while the selection is in a bulleted list, beside `bullet-list`.
|
|
96055
|
+
* - `bullet-list-spinner`: The ring the Bulleted list button turns while it is pending.
|
|
96056
|
+
* - `bullet-list-text`: The box the Bulleted list button's icon sits in.
|
|
96057
|
+
* - `code`: The Code button. Pressed while the selection is code.
|
|
96058
|
+
* - `code-button`: The Code button's inner button.
|
|
96059
|
+
* - `code-live`: The Code button's live region, which speaks while the button is pending.
|
|
96060
|
+
* - `code-pressed`: The Code button while the selection is code, beside `code`.
|
|
96061
|
+
* - `code-spinner`: The ring the Code button turns while it is pending.
|
|
96062
|
+
* - `code-text`: The box the Code button's icon sits in.
|
|
96063
|
+
* - `controls`: The toolbar: the tools, then your actions, one tab stop that the arrows move along.
|
|
96064
|
+
* - `controls-toolbar`: The box inside the toolbar that lays its buttons out.
|
|
96065
|
+
* - `divider`: The line between two groups of tools.
|
|
96066
|
+
* - `divider-content`: The content set into a divider, which the editor sets none into.
|
|
96067
|
+
* - `divider-line`: The line itself.
|
|
96068
|
+
* - `find`: The find bar under the toolbar, where the reader searches the document: a Find of its own.
|
|
96069
|
+
* - `find-actions`: The find bar's `actions` slot, which the editor fills with nothing.
|
|
96070
|
+
* - `find-bar`: The find bar's strip: the field, the count, the toolbar, and the replace row while it shows.
|
|
96071
|
+
* - `find-close`: The button that closes the find bar.
|
|
96072
|
+
* - `find-close-button`: The find bar's close button's inner button.
|
|
96073
|
+
* - `find-close-live`: The find bar's close button's live region, which speaks while the button is pending.
|
|
96074
|
+
* - `find-close-spinner`: The ring the find bar's close button turns while it is pending.
|
|
96075
|
+
* - `find-close-text`: The box the find bar's close button's icon sits in.
|
|
96076
|
+
* - `find-controls`: The find bar's toolbar of options and moves.
|
|
96077
|
+
* - `find-controls-toolbar`: The box inside the find bar's toolbar that lays its buttons out.
|
|
96078
|
+
* - `find-count`: Which match is selected, of how many.
|
|
96079
|
+
* - `find-field`: The field the search is typed in.
|
|
96080
|
+
* - `find-live`: The find bar's live region, which says the count as it changes.
|
|
96081
|
+
* - `find-match-case`: The option that finds only the same case. Pressed while it applies.
|
|
96082
|
+
* - `find-match-case-button`: The match case button's inner button.
|
|
96083
|
+
* - `find-match-case-live`: The match case button's live region, which speaks while the button is pending.
|
|
96084
|
+
* - `find-match-case-pressed`: The match case option while it applies, beside `find-match-case`.
|
|
96085
|
+
* - `find-match-case-spinner`: The ring the match case button turns while it is pending.
|
|
96086
|
+
* - `find-match-case-text`: The box the match case button's icon sits in.
|
|
96087
|
+
* - `find-next`: The button that selects the next match.
|
|
96088
|
+
* - `find-next-button`: The next match button's inner button.
|
|
96089
|
+
* - `find-next-live`: The next match button's live region, which speaks while the button is pending.
|
|
96090
|
+
* - `find-next-spinner`: The ring the next match button turns while it is pending.
|
|
96091
|
+
* - `find-next-text`: The box the next match button's icon sits in.
|
|
96092
|
+
* - `find-previous`: The button that selects the previous match.
|
|
96093
|
+
* - `find-previous-button`: The previous match button's inner button.
|
|
96094
|
+
* - `find-previous-live`: The previous match button's live region, which speaks while the button is pending.
|
|
96095
|
+
* - `find-previous-spinner`: The ring the previous match button turns while it is pending.
|
|
96096
|
+
* - `find-previous-text`: The box the previous match button's icon sits in.
|
|
96097
|
+
* - `find-regex`: The option that reads the search as a regular expression. Pressed while it applies.
|
|
96098
|
+
* - `find-regex-button`: The regular expression button's inner button.
|
|
96099
|
+
* - `find-regex-live`: The regular expression button's live region, which speaks while the button is pending.
|
|
96100
|
+
* - `find-regex-pressed`: The regular expression option while it applies, beside `find-regex`.
|
|
96101
|
+
* - `find-regex-spinner`: The ring the regular expression button turns while it is pending.
|
|
96102
|
+
* - `find-regex-text`: The box the regular expression button's icon sits in.
|
|
96103
|
+
* - `find-replace`: The button that replaces the selected match.
|
|
96104
|
+
* - `find-replace-all`: The button that replaces every match.
|
|
96105
|
+
* - `find-replace-all-button`: The Replace all button's inner button.
|
|
96106
|
+
* - `find-replace-all-live`: The Replace all button's live region, which speaks while the button is pending.
|
|
96107
|
+
* - `find-replace-all-spinner`: The ring the Replace all button turns while it is pending.
|
|
96108
|
+
* - `find-replace-all-text`: The box the Replace all button's words sits in.
|
|
96109
|
+
* - `find-replace-button`: The Replace button's inner button.
|
|
96110
|
+
* - `find-replace-field`: The field the replacement is typed in.
|
|
96111
|
+
* - `find-replace-live`: The Replace button's live region, which speaks while the button is pending.
|
|
96112
|
+
* - `find-replace-spinner`: The ring the Replace button turns while it is pending.
|
|
96113
|
+
* - `find-replace-text`: The box the Replace button's words sits in.
|
|
96114
|
+
* - `find-replace-toggle`: The button that shows the replace field under the find field. Expanded while it shows. Not drawn while `readonly`.
|
|
96115
|
+
* - `find-replace-toggle-button`: The find and replace button's inner button.
|
|
96116
|
+
* - `find-replace-toggle-live`: The find and replace button's live region, which speaks while the button is pending.
|
|
96117
|
+
* - `find-replace-toggle-spinner`: The ring the find and replace button turns while it is pending.
|
|
96118
|
+
* - `find-replace-toggle-text`: The box the find and replace button's icon sits in.
|
|
96119
|
+
* - `find-toggle`: The Find button in the toolbar, drawn where `tools` names `find`, which opens and closes the find bar. Expanded while it is open.
|
|
96120
|
+
* - `find-toggle-button`: The Find button's inner button.
|
|
96121
|
+
* - `find-toggle-live`: The Find button's live region, which speaks while the button is pending.
|
|
96122
|
+
* - `find-toggle-spinner`: The ring the Find button turns while it is pending.
|
|
96123
|
+
* - `find-toggle-text`: The box the Find button's icon sits in.
|
|
96124
|
+
* - `find-whole-word`: The option that finds only whole words. Pressed while it applies.
|
|
96125
|
+
* - `find-whole-word-button`: The whole word button's inner button.
|
|
96126
|
+
* - `find-whole-word-live`: The whole word button's live region, which speaks while the button is pending.
|
|
96127
|
+
* - `find-whole-word-pressed`: The whole word option while it applies, beside `find-whole-word`.
|
|
96128
|
+
* - `find-whole-word-spinner`: The ring the whole word button turns while it is pending.
|
|
96129
|
+
* - `find-whole-word-text`: The box the whole word button's icon sits in.
|
|
96130
|
+
* - `footer`: The `footer` slot, under the document.
|
|
96131
|
+
* - `header`: The strip above the document that holds the toolbar, and the address bar under it while it is open.
|
|
96132
|
+
* - `italic`: The Italic button. Pressed while the selection is italic.
|
|
96133
|
+
* - `italic-button`: The Italic button's inner button.
|
|
96134
|
+
* - `italic-live`: The Italic button's live region, which speaks while the button is pending.
|
|
96135
|
+
* - `italic-pressed`: The Italic button while the selection is italic, beside `italic`.
|
|
96136
|
+
* - `italic-spinner`: The ring the Italic button turns while it is pending.
|
|
96137
|
+
* - `italic-text`: The box the Italic button's icon sits in.
|
|
96138
|
+
* - `link`: The Link button, which opens the address bar. Pressed while the selection is in a link, and expanded while the bar is open.
|
|
96139
|
+
* - `link-apply`: The button that applies the address.
|
|
96140
|
+
* - `link-apply-button`: The Apply button's inner button.
|
|
96141
|
+
* - `link-apply-live`: The Apply button's live region, which speaks while the button is pending.
|
|
96142
|
+
* - `link-apply-spinner`: The ring the Apply button turns while it is pending.
|
|
96143
|
+
* - `link-apply-text`: The box the Apply button's icon sits in.
|
|
96144
|
+
* - `link-bar`: The bar under the toolbar where the reader writes a link's address.
|
|
96145
|
+
* - `link-button`: The Link button's inner button.
|
|
96146
|
+
* - `link-close`: The button that closes the address bar.
|
|
96147
|
+
* - `link-close-button`: The close button's inner button.
|
|
96148
|
+
* - `link-close-live`: The close button's live region, which speaks while the button is pending.
|
|
96149
|
+
* - `link-close-spinner`: The ring the close button turns while it is pending.
|
|
96150
|
+
* - `link-close-text`: The box the close button's icon sits in.
|
|
96151
|
+
* - `link-controls`: The toolbar at the end of the address bar: Apply, Remove, and Close.
|
|
96152
|
+
* - `link-controls-toolbar`: The box inside the address bar's toolbar that lays its buttons out.
|
|
96153
|
+
* - `link-field`: The field the address is written in.
|
|
96154
|
+
* - `link-live`: The Link button's live region, which speaks while the button is pending.
|
|
96155
|
+
* - `link-pressed`: The Link button while the selection is in a link, beside `link`.
|
|
96156
|
+
* - `link-remove`: The button that takes the link off. Disabled where the selection is in no link.
|
|
96157
|
+
* - `link-remove-button`: The Remove button's inner button.
|
|
96158
|
+
* - `link-remove-live`: The Remove button's live region, which speaks while the button is pending.
|
|
96159
|
+
* - `link-remove-spinner`: The ring the Remove button turns while it is pending.
|
|
96160
|
+
* - `link-remove-text`: The box the Remove button's icon sits in.
|
|
96161
|
+
* - `link-spinner`: The ring the Link button turns while it is pending.
|
|
96162
|
+
* - `link-text`: The box the Link button's icon sits in.
|
|
96163
|
+
* - `ordered-list`: The Numbered list button. Pressed while the selection is in a numbered list.
|
|
96164
|
+
* - `ordered-list-button`: The Numbered list button's inner button.
|
|
96165
|
+
* - `ordered-list-live`: The Numbered list button's live region, which speaks while the button is pending.
|
|
96166
|
+
* - `ordered-list-pressed`: The Numbered list button while the selection is in a numbered list, beside `ordered-list`.
|
|
96167
|
+
* - `ordered-list-spinner`: The ring the Numbered list button turns while it is pending.
|
|
96168
|
+
* - `ordered-list-text`: The box the Numbered list button's icon sits in.
|
|
96169
|
+
* - `quote`: The Quote button. Pressed while the selection is in a quote.
|
|
96170
|
+
* - `quote-button`: The Quote button's inner button.
|
|
96171
|
+
* - `quote-live`: The Quote button's live region, which speaks while the button is pending.
|
|
96172
|
+
* - `quote-pressed`: The Quote button while the selection is in a quote, beside `quote`.
|
|
96173
|
+
* - `quote-spinner`: The ring the Quote button turns while it is pending.
|
|
96174
|
+
* - `quote-text`: The box the Quote button's icon sits in.
|
|
96175
|
+
* - `redo`: The Redo button. Disabled while there is nothing to redo.
|
|
96176
|
+
* - `redo-button`: The Redo button's inner button.
|
|
96177
|
+
* - `redo-live`: The Redo button's live region, which speaks while the button is pending.
|
|
96178
|
+
* - `redo-spinner`: The ring the Redo button turns while it is pending.
|
|
96179
|
+
* - `redo-text`: The box the Redo button's icon sits in.
|
|
96180
|
+
* - `region`: The frame around the toolbar, the address bar, and the document.
|
|
96181
|
+
* - `strike`: The Strikethrough button. Pressed while the selection is struck through.
|
|
96182
|
+
* - `strike-button`: The Strikethrough button's inner button.
|
|
96183
|
+
* - `strike-live`: The Strikethrough button's live region, which speaks while the button is pending.
|
|
96184
|
+
* - `strike-pressed`: The Strikethrough button while the selection is struck through, beside `strike`.
|
|
96185
|
+
* - `strike-spinner`: The ring the Strikethrough button turns while it is pending.
|
|
96186
|
+
* - `strike-text`: The box the Strikethrough button's icon sits in.
|
|
96187
|
+
* - `tools`: A group of several tools, which a narrow toolbar wraps as one: Undo and Redo, the marks, or the lists and the quote.
|
|
96188
|
+
* - `undo`: The Undo button. Disabled while there is nothing to undo.
|
|
96189
|
+
* - `undo-button`: The Undo button's inner button.
|
|
96190
|
+
* - `undo-live`: The Undo button's live region, which speaks while the button is pending.
|
|
96191
|
+
* - `undo-spinner`: The ring the Undo button turns while it is pending.
|
|
96192
|
+
* - `undo-text`: The box the Undo button's icon sits in.
|
|
96193
|
+
* - `viewport`: The box the document is drawn in.
|
|
96194
|
+
*
|
|
96195
|
+
* ## CSS States
|
|
96196
|
+
*
|
|
96197
|
+
* These can be used to apply styling when a component is in a given state.
|
|
96198
|
+
*
|
|
96199
|
+
* - `connected`: A renderer draws the document.
|
|
96200
|
+
* - `document-focused`: Focus is in the document, where the reader types.
|
|
96201
|
+
* - `find-open`: The find bar is open.
|
|
96202
|
+
* - `link-open`: The address bar is open.
|
|
96203
|
+
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
96204
|
+
*/
|
|
96205
|
+
"helix-editor": Partial<
|
|
96206
|
+
HelixEditorProps &
|
|
96207
|
+
HelixEditorSolidJsProps &
|
|
96208
|
+
BaseProps<HelixEditor, "solid"> &
|
|
96209
|
+
BaseEvents<HelixEditor>
|
|
96210
|
+
>;
|
|
96211
|
+
|
|
95300
96212
|
/**
|
|
95301
96213
|
* Centered with space around it. An empty view is the only thing on screen, and
|
|
95302
96214
|
* pressed against the top edge it looks broken.
|
|
@@ -120657,6 +121569,22 @@ export type CustomCssProperties = {
|
|
|
120657
121569
|
"--drilldown-title-font-weight"?: (string) | undefined;
|
|
120658
121570
|
/** How far a page slides as it arrives, along the line of text. */
|
|
120659
121571
|
"--drilldown-travel"?: (string) | undefined;
|
|
121572
|
+
/** The ground the document is drawn on. Defaults to the page's background. */
|
|
121573
|
+
"--editor-background-color"?: (string) | undefined;
|
|
121574
|
+
/** The frame's edge and the line under the toolbar. */
|
|
121575
|
+
"--editor-border-color"?: (string) | undefined;
|
|
121576
|
+
/** The fill of the toolbar's strip. */
|
|
121577
|
+
"--editor-header-background-color"?: (string) | undefined;
|
|
121578
|
+
/** How far below the top of the page the toolbar stays while the document scrolls, such as the height of your own fixed header. `0` unless set. */
|
|
121579
|
+
"--editor-header-offset"?: (string) | undefined;
|
|
121580
|
+
/** The longest a line of the document runs, as a length: `72ch` unless set. */
|
|
121581
|
+
"--editor-measure"?: (string) | undefined;
|
|
121582
|
+
/** The frame's least height, which it grows from with the document: `12rem` unless set. Ignored with `fill`. */
|
|
121583
|
+
"--editor-min-block-size"?: (string) | undefined;
|
|
121584
|
+
/** The space around the document, inside the frame. */
|
|
121585
|
+
"--editor-padding"?: (string) | undefined;
|
|
121586
|
+
/** The frame's corner radius. */
|
|
121587
|
+
"--editor-radius"?: (string) | undefined;
|
|
120660
121588
|
/** Space added above the actions. */
|
|
120661
121589
|
"--empty-actions-gap"?: (string) | undefined;
|
|
120662
121590
|
/** Space between the icon, the heading, the message and the actions. */
|