asciify-engine 4.17.0 → 4.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -0
- package/dist/{characters-BgG9AZQl.d.cts → characters-BgECi5Lf.d.cts} +2 -2
- package/dist/{characters-BgG9AZQl.d.ts → characters-BgECi5Lf.d.ts} +2 -2
- package/dist/core.cjs +1 -1
- package/dist/core.d.cts +1 -1
- package/dist/core.d.ts +1 -1
- package/dist/core.js +1 -1
- package/dist/field.cjs +1 -1
- package/dist/field.d.cts +18 -5
- package/dist/field.d.ts +18 -5
- package/dist/field.js +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/kit.cjs +1 -1
- package/dist/kit.d.cts +267 -69
- package/dist/kit.d.ts +267 -69
- package/dist/kit.js +1 -1
- package/dist/studio.cjs +1 -1
- package/dist/studio.d.cts +1 -1
- package/dist/studio.d.ts +1 -1
- package/dist/studio.js +1 -1
- package/package.json +1 -1
- package/skills/asciify-engine/SKILL.md +14 -16
- package/skills/asciify-engine/references/applying-asciify.md +11 -13
- package/skills/asciify-engine/references/components.md +38 -42
- package/skills/asciify-engine/references/design-matching.md +1 -1
- package/skills/asciify-engine/references/glyph-field.md +2 -1
- package/skills/asciify-engine/references/kit.md +73 -66
- package/skills/asciify-engine/references/looks.md +1043 -0
- package/skills/asciify-engine/references/media-api.md +4 -6
- package/skills/asciify-engine/references/upgrading.md +1 -1
package/dist/kit.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { GlyphField, GlyphFieldOptions } from './field.js';
|
|
2
|
-
import { C as CHARACTER_SETS } from './characters-
|
|
2
|
+
import { C as CHARACTER_SETS } from './characters-BgECi5Lf.js';
|
|
3
3
|
|
|
4
4
|
/** Options every kit component takes. */
|
|
5
5
|
interface KitOptions {
|
|
@@ -270,30 +270,33 @@ declare function skeleton(element: HTMLElement, options?: SkeletonOptions): Skel
|
|
|
270
270
|
|
|
271
271
|
type PillTone = 'green' | 'amber' | 'red' | 'neutral' | 'new';
|
|
272
272
|
interface PillOptions extends KitOptions {
|
|
273
|
-
/** The tone of a pill without `data-tone`. `new` is a solid pill
|
|
273
|
+
/** The tone of a pill without `data-tone`. `new` is a solid pill led by a sparkle. Default `neutral`. */
|
|
274
274
|
tone?: PillTone;
|
|
275
|
-
/**
|
|
275
|
+
/**
|
|
276
|
+
* A live state: the indicator moves. Amber turns a half-filled dot like a spinner (syncing); any other tone breathes its dot.
|
|
277
|
+
* `data-live` on a pill wins. Default false. Neutral shows an open ring, and a pill turning red blinks its dot open twice.
|
|
278
|
+
*/
|
|
276
279
|
live?: boolean;
|
|
277
|
-
/** A
|
|
280
|
+
/** A one-cell glyph before the label, drawn over the pill's `[data-dot]` element (one is added when missing): a status dot, or a `new` pill's sparkle. Default true. */
|
|
278
281
|
indicator?: boolean;
|
|
279
|
-
/** A
|
|
282
|
+
/** A `new` pill's sparkle twinkles when the pointer enters it. Default true. */
|
|
280
283
|
sheen?: boolean;
|
|
281
284
|
/** Glyph hues to paint, as `[r, g, b]` 0–255, for the light and dark ground. */
|
|
282
285
|
tones?: Partial<Record<'light' | 'dark', Partial<Record<PillTone, [number, number, number]>>>>;
|
|
283
286
|
}
|
|
284
287
|
interface PillHandle extends KitHandle<PillOptions> {
|
|
285
|
-
/**
|
|
288
|
+
/** Twinkles the sparkle on one pill, or on every `new` pill. */
|
|
286
289
|
sheen(pill?: HTMLElement): void;
|
|
287
290
|
/** Sets a count pill (`data-count`) to `value`; only the changed digits roll. Without `pill`, the first count pill. */
|
|
288
291
|
count(value: number | string, pill?: HTMLElement): void;
|
|
289
292
|
/** Re-reads each pill's `data-tone` and `data-live`; tone changes ease over 240ms. `update()` does this too. */
|
|
290
293
|
refresh(): void;
|
|
291
294
|
}
|
|
292
|
-
/** Glyph hues painted into the source. The field normalises each hue and takes the glyph from its brightness. */
|
|
295
|
+
/** Glyph hues painted into the source. The field normalises each hue and takes the glyph from its brightness. `new` is the neutral sparkle. */
|
|
293
296
|
declare const PILL_TONES: Record<'light' | 'dark', Record<PillTone, [number, number, number]>>;
|
|
294
297
|
/**
|
|
295
|
-
* Pills and badges
|
|
296
|
-
* `new` pills and rolling digits on count pills. One element gets a field under its text; a list shares one field over their common
|
|
298
|
+
* Pills and badges whose characters stay inside them: a glyph dot in each status pill's tone that breathes while live, turns
|
|
299
|
+
* while syncing and blinks on failure, a sparkle on `new` pills and rolling digits on count pills. One element gets a field under its text; a list shares one field over their common
|
|
297
300
|
* container (one WebGL context for all), with each pill's labels lifted above it.
|
|
298
301
|
*/
|
|
299
302
|
declare function pill(target: HTMLElement | Iterable<HTMLElement>, options?: PillOptions): PillHandle;
|
|
@@ -303,7 +306,7 @@ interface TabsOptions extends KitOptions {
|
|
|
303
306
|
tabs?: string;
|
|
304
307
|
/** The tab shown first. Default: the one with `aria-selected="true"`, else 0. */
|
|
305
308
|
active?: number;
|
|
306
|
-
/** How long the indicator
|
|
309
|
+
/** How long the indicator glides to a new tab, in ms. Default 440. */
|
|
307
310
|
duration?: number;
|
|
308
311
|
/** How the kit shows panels named by `aria-controls`: `hidden` toggles the attribute, `attribute` toggles `data-active`, `none` leaves them. Default `hidden`. */
|
|
309
312
|
panels?: 'hidden' | 'attribute' | 'none';
|
|
@@ -313,11 +316,15 @@ interface TabsOptions extends KitOptions {
|
|
|
313
316
|
onChange?: (index: number, tab: HTMLElement) => void;
|
|
314
317
|
}
|
|
315
318
|
interface TabsHandle extends KitHandle<TabsOptions> {
|
|
316
|
-
/** Selects a tab; the indicator
|
|
319
|
+
/** Selects a tab; the indicator glides across to it. `focus` moves keyboard focus too. */
|
|
317
320
|
select(index: number, focus?: boolean): void;
|
|
318
321
|
readonly active: number;
|
|
319
322
|
}
|
|
320
|
-
/**
|
|
323
|
+
/**
|
|
324
|
+
* Segmented tabs with a gliding indicator. The pill itself is yours to style from `--tabs-x`, `--tabs-y`, `--tabs-w` and `--tabs-h`,
|
|
325
|
+
* which the kit sets on the tablist every frame, so its outline stays crisp; the field draws a row of characters along its foot
|
|
326
|
+
* that streaks dense toward the leading end in flight and settles into an even, tapered line as it lands.
|
|
327
|
+
*/
|
|
321
328
|
declare function tabs(tablist: HTMLElement, options?: TabsOptions): TabsHandle;
|
|
322
329
|
|
|
323
330
|
/** One update from an image provider. Either may be a Blob or a URL. */
|
|
@@ -521,6 +528,10 @@ interface CommandPaletteOptions extends KitOptions {
|
|
|
521
528
|
onRun?: (index: number, row: HTMLElement) => void;
|
|
522
529
|
/** Called after the palette opens or closes. */
|
|
523
530
|
onOpenChange?: (open: boolean) => void;
|
|
531
|
+
/** A highlight that glides behind the selected row. `false` when your rows style `aria-selected` themselves. Default true. */
|
|
532
|
+
highlight?: boolean;
|
|
533
|
+
/** Rows that carry the AI signature: a sweep of characters runs through their highlight while selected. Default `[data-ai]`. */
|
|
534
|
+
ai?: string;
|
|
524
535
|
}
|
|
525
536
|
interface CommandPaletteHandle extends KitHandle<CommandPaletteOptions> {
|
|
526
537
|
/** Condenses the palette out of the trigger. `focus` moves focus to the input (default true). */
|
|
@@ -528,7 +539,7 @@ interface CommandPaletteHandle extends KitHandle<CommandPaletteOptions> {
|
|
|
528
539
|
/** Dissolves the palette back into the trigger. */
|
|
529
540
|
close(): void;
|
|
530
541
|
toggle(): void;
|
|
531
|
-
/** Moves the selection; the
|
|
542
|
+
/** Moves the selection; the highlight glides to the row. */
|
|
532
543
|
select(index: number): void;
|
|
533
544
|
/** Runs a row as if it were clicked. */
|
|
534
545
|
run(index?: number): void;
|
|
@@ -536,8 +547,8 @@ interface CommandPaletteHandle extends KitHandle<CommandPaletteOptions> {
|
|
|
536
547
|
readonly selected: number;
|
|
537
548
|
}
|
|
538
549
|
/**
|
|
539
|
-
* A command palette that condenses out of its trigger in blocks of characters and dissolves back into it
|
|
540
|
-
* in
|
|
550
|
+
* A command palette that condenses out of its trigger in blocks of characters and dissolves back into it. A highlight glides
|
|
551
|
+
* between rows, rows that a search brings in resolve out of characters, and an AI row's highlight carries a sweep of characters.
|
|
541
552
|
*/
|
|
542
553
|
declare function commandPalette(panel: HTMLElement, options?: CommandPaletteOptions): CommandPaletteHandle;
|
|
543
554
|
|
|
@@ -602,15 +613,15 @@ declare function likeBurst(button: HTMLElement, options?: LikeBurstOptions): Lik
|
|
|
602
613
|
interface BlockChartOptions extends KitOptions {
|
|
603
614
|
/** The bars, left to right. */
|
|
604
615
|
values?: readonly number[];
|
|
605
|
-
/** A name per bar, read by screen readers and passed to `onHover`. */
|
|
616
|
+
/** A name per bar, read by screen readers and passed to `onHover`. `set()` matches old and new bars by label, so shared bars glide into place. */
|
|
606
617
|
labels?: readonly string[];
|
|
607
618
|
/** The value the top of the plot stands for. Default: the largest value plus 4%. */
|
|
608
619
|
max?: number;
|
|
609
|
-
/** How long
|
|
620
|
+
/** How long bars grow, glide and resize, in ms. Default 560. */
|
|
610
621
|
duration?: number;
|
|
611
622
|
/** Grow the bars in the first time the chart comes into view. `false` draws them in place at once, as in a view that is swapped in. Default true. */
|
|
612
623
|
intro?: boolean;
|
|
613
|
-
/** Ms between bars growing. Default 45 for up to 7 bars, else
|
|
624
|
+
/** Ms between bars growing. Default 45 for up to 7 bars, else 12. */
|
|
614
625
|
stagger?: number;
|
|
615
626
|
/** Formats values for the screen reader table. Default `toLocaleString()`. */
|
|
616
627
|
format?: (value: number) => string;
|
|
@@ -618,31 +629,31 @@ interface BlockChartOptions extends KitOptions {
|
|
|
618
629
|
onHover?: (index: number | null, value: number | null, label: string | null) => void;
|
|
619
630
|
}
|
|
620
631
|
interface BlockChartHandle extends KitHandle<BlockChartOptions> {
|
|
621
|
-
/** New values (and labels);
|
|
632
|
+
/** New values (and labels); bars with a matching label glide and resize, new ones grow in, dropped ones sink away. */
|
|
622
633
|
set(values: readonly number[], labels?: readonly string[]): void;
|
|
623
|
-
/** Lights one bar and
|
|
634
|
+
/** Lights one bar and fades the rest, or `null` for the resting emphasis on the last bar. */
|
|
624
635
|
highlight(index: number | null): void;
|
|
625
636
|
readonly active: number | null;
|
|
626
637
|
readonly values: readonly number[];
|
|
627
638
|
}
|
|
628
|
-
/** A bar chart drawn in columns of characters: bars grow in staggered, the last is
|
|
639
|
+
/** A bar chart drawn in columns of characters on a whole-cell grid: bars grow in staggered, the last is lit, hover lights one and fades the rest. */
|
|
629
640
|
declare function blockChart(element: HTMLElement, options?: BlockChartOptions): BlockChartHandle;
|
|
630
641
|
|
|
631
642
|
interface PageDissolveOptions extends KitOptions {
|
|
632
|
-
/** Where the
|
|
643
|
+
/** Where the wave starts: an element (such as the tab that was clicked) or a point in the container's CSS pixels. Default: top centre. */
|
|
633
644
|
origin?: HTMLElement | {
|
|
634
645
|
x: number;
|
|
635
646
|
y: number;
|
|
636
647
|
} | null;
|
|
637
|
-
/** Ms the old view takes to break up. Default
|
|
648
|
+
/** Ms the old view takes to break up from the origin outward. Default 300. */
|
|
638
649
|
dissolve?: number;
|
|
639
|
-
/** Ms the new view takes to condense. Default
|
|
650
|
+
/** Ms the new view takes to condense in behind it, from the same origin. Default 300. */
|
|
640
651
|
condense?: number;
|
|
641
652
|
}
|
|
642
653
|
interface PageDissolveHandle extends KitHandle<PageDissolveOptions> {
|
|
643
654
|
/**
|
|
644
|
-
* The view
|
|
645
|
-
*
|
|
655
|
+
* The crisp view hands over to its own characters, a wave from `origin` breaks it up, `render` swaps the content underneath and the
|
|
656
|
+
* new view condenses in behind the same wave, then hands back to crisp HTML. Swaps queue; each promise resolves once its view is crisp.
|
|
646
657
|
*/
|
|
647
658
|
swap(render: () => void | Promise<void>, origin?: HTMLElement | {
|
|
648
659
|
x: number;
|
|
@@ -650,7 +661,7 @@ interface PageDissolveHandle extends KitHandle<PageDissolveOptions> {
|
|
|
650
661
|
} | null): Promise<void>;
|
|
651
662
|
readonly busy: boolean;
|
|
652
663
|
}
|
|
653
|
-
/** A page or panel transition:
|
|
664
|
+
/** A page or panel transition: one wave of characters from where the user clicked carries the old view out and the next one in. */
|
|
654
665
|
declare function pageDissolve(container: HTMLElement, options?: PageDissolveOptions): PageDissolveHandle;
|
|
655
666
|
|
|
656
667
|
interface SwipeDeckOptions extends KitOptions {
|
|
@@ -727,13 +738,15 @@ interface ToastStackOptions extends KitOptions {
|
|
|
727
738
|
render?: (toast: Toast, id: number) => HTMLElement;
|
|
728
739
|
/** Accessible name of the list. Default `Notifications`. */
|
|
729
740
|
label?: string;
|
|
730
|
-
/**
|
|
741
|
+
/** @deprecated Ignored: toasts no longer draw anything round their edge at rest. */
|
|
731
742
|
glint?: boolean;
|
|
743
|
+
/** Drag a toast sideways to dismiss it; it breaks into characters that carry on the way it was thrown. Default true. */
|
|
744
|
+
swipe?: boolean;
|
|
732
745
|
}
|
|
733
746
|
interface ToastStackHandle extends KitHandle<ToastStackOptions> {
|
|
734
747
|
/** Adds a toast at the front, gathering out of scattered characters. Returns its id. */
|
|
735
748
|
push(toast: Toast): number;
|
|
736
|
-
/** Takes a toast out: it breaks into characters that drift
|
|
749
|
+
/** Takes a toast out: it breaks into characters that drift away while the stack closes up behind it. */
|
|
737
750
|
dismiss(id: number): void;
|
|
738
751
|
/** Dismisses every toast. */
|
|
739
752
|
clear(): void;
|
|
@@ -864,7 +877,7 @@ interface AccordionOptions extends KitOptions {
|
|
|
864
877
|
images: (string | AccordionImage)[];
|
|
865
878
|
/** The panel open at first. Default 0. */
|
|
866
879
|
open?: number;
|
|
867
|
-
/** Ms a panel takes to open. Default
|
|
880
|
+
/** Ms a panel takes to settle open; the panels move on one critically damped spring, so a change mid-move carries its speed. Default 420. */
|
|
868
881
|
duration?: number;
|
|
869
882
|
/** Accessible name of the group. Default `Images`. */
|
|
870
883
|
label?: string;
|
|
@@ -877,7 +890,8 @@ interface AccordionHandle extends KitHandle<AccordionOptions> {
|
|
|
877
890
|
}
|
|
878
891
|
/**
|
|
879
892
|
* A strip of image panels: the open one shows its photo, the closed ones the same photos in characters. Pointing at,
|
|
880
|
-
* pressing or focusing a panel opens it, and
|
|
893
|
+
* pressing or focusing a panel opens it. Width, photo and caption all follow one spring per panel, so the characters and the photo
|
|
894
|
+
* cross over without a gap and a change of mind mid-move carries on smoothly.
|
|
881
895
|
*/
|
|
882
896
|
declare function accordion(element: HTMLElement, options: AccordionOptions): AccordionHandle;
|
|
883
897
|
|
|
@@ -895,7 +909,7 @@ interface DropzoneOptions extends KitOptions {
|
|
|
895
909
|
onError?: (message: string, file: File) => void;
|
|
896
910
|
/** Largest file accepted, in bytes. Default 10 MB. */
|
|
897
911
|
maxBytes?: number;
|
|
898
|
-
/** Ms the image takes to develop in characters. Default
|
|
912
|
+
/** Ms the image takes to develop in characters. Default 900. */
|
|
899
913
|
develop?: number;
|
|
900
914
|
/** File name for `download()`. Default `<name>-ascii.png`. */
|
|
901
915
|
filename?: string;
|
|
@@ -914,8 +928,8 @@ interface DropzoneHandle extends KitHandle<DropzoneOptions> {
|
|
|
914
928
|
readonly state: DropState;
|
|
915
929
|
}
|
|
916
930
|
/**
|
|
917
|
-
* An image dropzone whose border is a quiet ring of characters that
|
|
918
|
-
* A dropped image
|
|
931
|
+
* An image dropzone whose border is a quiet ring of characters that comes alive while a file is dragged over.
|
|
932
|
+
* A dropped image opens out from the drop point in characters, in its own colours. Any element inside with `data-dropzone="pick"`, `"clear"`
|
|
919
933
|
* or `"download"` is wired to that action. Without content of your own it adds a title, hint and Choose file button.
|
|
920
934
|
*/
|
|
921
935
|
declare function dropzone(element: HTMLElement, options?: DropzoneOptions): DropzoneHandle;
|
|
@@ -942,7 +956,7 @@ interface PullRefreshOptions extends KitOptions {
|
|
|
942
956
|
onRefresh: () => unknown;
|
|
943
957
|
/** The element that moves down with the pull. Default the first child. */
|
|
944
958
|
content?: HTMLElement | null;
|
|
945
|
-
/** Pull distance in px that triggers a refresh on release. Default
|
|
959
|
+
/** Pull distance in px that triggers a refresh on release. Default 64. */
|
|
946
960
|
threshold?: number;
|
|
947
961
|
/** What a screen reader hears. */
|
|
948
962
|
messages?: {
|
|
@@ -961,13 +975,15 @@ interface PullRefreshHandle extends KitHandle<PullRefreshOptions> {
|
|
|
961
975
|
readonly state: PullState;
|
|
962
976
|
}
|
|
963
977
|
/**
|
|
964
|
-
* Pull to refresh: dragging the content down at the top
|
|
965
|
-
*
|
|
978
|
+
* Pull to refresh: dragging the content down at the top draws a small ring of characters round in the gap, closing it at the
|
|
979
|
+
* threshold with a small pop. Let go past it and the ring opens into a spinning arc while `onRefresh` runs, then draws a check and springs back.
|
|
966
980
|
*/
|
|
967
981
|
declare function pullRefresh(element: HTMLElement, options: PullRefreshOptions): PullRefreshHandle;
|
|
968
982
|
|
|
969
983
|
/** `true` follows the pointer with the preset's own response; the GPU presets also take a named hover. */
|
|
970
984
|
type BackgroundCursor = boolean | 'trail' | 'fluid' | 'lantern';
|
|
985
|
+
/** What the GPU presets draw in each cell: characters, or halftone dots sized by the tone. */
|
|
986
|
+
type BackgroundMark = 'glyph' | 'dot';
|
|
971
987
|
/** A named ramp from the engine's character sets, `'dots'`, or your own characters from empty to dense. */
|
|
972
988
|
type BackgroundCharset = keyof typeof CHARACTER_SETS | 'dots' | (string & {});
|
|
973
989
|
interface BackgroundOptions extends KitOptions {
|
|
@@ -988,8 +1004,13 @@ interface BackgroundOptions extends KitOptions {
|
|
|
988
1004
|
cellSize?: number;
|
|
989
1005
|
/** Characters from empty to dense, or a named set (`blocks`, `braille`, `dots`, ...). Default: the preset's own. */
|
|
990
1006
|
charset?: BackgroundCharset;
|
|
991
|
-
/**
|
|
1007
|
+
/**
|
|
1008
|
+
* Pointer response. `false` turns it off: the background never reacts to the pointer. `true` keeps the preset's own response;
|
|
1009
|
+
* the GPU presets also take a named hover. Default: on for the presets that answer the cursor.
|
|
1010
|
+
*/
|
|
992
1011
|
cursor?: BackgroundCursor;
|
|
1012
|
+
/** GPU presets: characters (`'glyph'`) or halftone dots (`'dot'`). Default: the preset's own; a `charset` asks for characters. */
|
|
1013
|
+
mark?: BackgroundMark;
|
|
993
1014
|
/** An element to keep clear: the field fades out around it so text over it stays readable. */
|
|
994
1015
|
clear?: HTMLElement | false;
|
|
995
1016
|
/** Canvas opacity, 0–1. Default 1 (`fluid` 0.7). */
|
|
@@ -1005,6 +1026,7 @@ interface BackgroundSettings {
|
|
|
1005
1026
|
cellSize: number;
|
|
1006
1027
|
charset: string | undefined;
|
|
1007
1028
|
cursor: BackgroundCursor;
|
|
1029
|
+
mark: BackgroundMark | undefined;
|
|
1008
1030
|
clear: HTMLElement | false;
|
|
1009
1031
|
dither: number;
|
|
1010
1032
|
accent: string | undefined;
|
|
@@ -1060,15 +1082,18 @@ interface BackgroundHandle extends KitHandle<BackgroundOptions> {
|
|
|
1060
1082
|
declare function backgroundCharset(charset: string | undefined): string | undefined;
|
|
1061
1083
|
/**
|
|
1062
1084
|
* An animated ASCII background under an element's content: any of the /backgrounds presets, drawn the same way as on the site.
|
|
1063
|
-
*
|
|
1085
|
+
* The curated presets drive the GPU glyph field, so they follow `setGlobalLook`; the deprecated canvas templates draw with a 2D canvas.
|
|
1064
1086
|
*/
|
|
1065
1087
|
declare function background(element: HTMLElement, options: BackgroundOptions): BackgroundHandle;
|
|
1066
1088
|
|
|
1067
|
-
/**
|
|
1068
|
-
|
|
1089
|
+
/**
|
|
1090
|
+
* A fine dot grid that swells in slow rolling waves, quiet in the middle; dots rise under the pointer. `cellSize` is the dot
|
|
1091
|
+
* spacing. `mark: 'glyph'` or a `charset` writes the waves in characters, and the page's global look does the same.
|
|
1092
|
+
*/
|
|
1093
|
+
declare const swell: BackgroundPreset;
|
|
1069
1094
|
|
|
1070
|
-
/**
|
|
1071
|
-
declare const
|
|
1095
|
+
/** Characters that drift slowly in broad lobes and stay clear around your content. `mark: 'dot'` draws them as a halftone. */
|
|
1096
|
+
declare const drift: BackgroundPreset;
|
|
1072
1097
|
|
|
1073
1098
|
/** A word becomes the background, drawn by the GPU with a soft wake. Set it with `text`; `look: { scene: 'orb' }` for the orb. */
|
|
1074
1099
|
declare const wordField: BackgroundPreset;
|
|
@@ -1076,70 +1101,151 @@ declare const wordField: BackgroundPreset;
|
|
|
1076
1101
|
/** Flowing folds with a soft wake behind the cursor: the original Asciify hero, driven through the GPU field. */
|
|
1077
1102
|
declare const fluid: BackgroundPreset;
|
|
1078
1103
|
|
|
1079
|
-
/**
|
|
1104
|
+
/** Light focused by moving water: fine bright lines that fold, part and meet again across the page. */
|
|
1105
|
+
declare const caustics: BackgroundPreset;
|
|
1106
|
+
|
|
1107
|
+
/** Survey lines over a slowly shifting terrain, one character wide at any size, every fifth an index line. */
|
|
1108
|
+
declare const contour: BackgroundPreset;
|
|
1109
|
+
|
|
1110
|
+
/** Three curtains of light fold slowly across the top of the page, sharp along their hems and soft above them. */
|
|
1080
1111
|
declare const aurora: BackgroundPreset;
|
|
1081
1112
|
|
|
1082
|
-
/**
|
|
1083
|
-
declare const
|
|
1113
|
+
/** Still water: drops land here and there and ring outward; the pointer drops its own as it moves. */
|
|
1114
|
+
declare const ripple: BackgroundPreset;
|
|
1084
1115
|
|
|
1085
|
-
/**
|
|
1086
|
-
declare const
|
|
1116
|
+
/** A corona breathes slowly round the middle of the page, its rays turning; the centre stays empty for a headline. */
|
|
1117
|
+
declare const halo: BackgroundPreset;
|
|
1087
1118
|
|
|
1088
|
-
/**
|
|
1089
|
-
declare const
|
|
1119
|
+
/** Two fine ring grids from slowly orbiting centres; where they cross, broad moiré bands open and close. */
|
|
1120
|
+
declare const interference: BackgroundPreset;
|
|
1090
1121
|
|
|
1091
|
-
/**
|
|
1122
|
+
/** Four soft lights on slow paths: a gradient mesh written in characters, the whole ramp from empty to dense. */
|
|
1123
|
+
declare const mesh: BackgroundPreset;
|
|
1124
|
+
|
|
1125
|
+
/** Streaks fall in three depths: far ones fine, faint and slow, near ones rare, bright and quick. */
|
|
1126
|
+
declare const cascade: BackgroundPreset;
|
|
1127
|
+
|
|
1128
|
+
/** Points wander in their own cells, and neighbours close enough are linked by fine lines that come and go. */
|
|
1129
|
+
declare const constellation: BackgroundPreset;
|
|
1130
|
+
|
|
1131
|
+
/**
|
|
1132
|
+
* The drifting ground drawn as dots, clear around your content. `cellSize` is the dot spacing.
|
|
1133
|
+
* @deprecated The same field as `drift`: use `drift` with `mark: 'dot'` (and `cellSize: 14` for this spacing).
|
|
1134
|
+
*/
|
|
1135
|
+
declare const halftone: BackgroundPreset;
|
|
1136
|
+
|
|
1137
|
+
/**
|
|
1138
|
+
* Circuit traces with signals running along them.
|
|
1139
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `constellation` is the closest current preset.
|
|
1140
|
+
*/
|
|
1141
|
+
declare const circuit: BackgroundPreset;
|
|
1142
|
+
|
|
1143
|
+
/**
|
|
1144
|
+
* Double helices scroll past with base-pair letters.
|
|
1145
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `halo` is the closest current preset.
|
|
1146
|
+
*/
|
|
1092
1147
|
declare const dna: BackgroundPreset;
|
|
1093
1148
|
|
|
1094
|
-
/**
|
|
1149
|
+
/**
|
|
1150
|
+
* Layered sand ridges with slow-moving light and fine grain.
|
|
1151
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `contour` is the closest current preset.
|
|
1152
|
+
*/
|
|
1095
1153
|
declare const dune: BackgroundPreset;
|
|
1096
1154
|
|
|
1097
|
-
/**
|
|
1155
|
+
/**
|
|
1156
|
+
* Cut-grain lines follow a slow, sculpted current.
|
|
1157
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `contour` is the closest current preset.
|
|
1158
|
+
*/
|
|
1098
1159
|
declare const etch: BackgroundPreset;
|
|
1099
1160
|
|
|
1100
|
-
/**
|
|
1161
|
+
/**
|
|
1162
|
+
* Quiet folded planes catch light along their edges.
|
|
1163
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `caustics` is the closest current preset.
|
|
1164
|
+
*/
|
|
1101
1165
|
declare const facet: BackgroundPreset;
|
|
1102
1166
|
|
|
1103
|
-
/**
|
|
1167
|
+
/**
|
|
1168
|
+
* A cellular flame rising from the bottom edge.
|
|
1169
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `aurora` is the closest current preset.
|
|
1170
|
+
*/
|
|
1104
1171
|
declare const fire: BackgroundPreset;
|
|
1105
1172
|
|
|
1106
|
-
/**
|
|
1173
|
+
/**
|
|
1174
|
+
* Scan bands roll down a character grid and glitch near the cursor.
|
|
1175
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `interference` is the closest current preset.
|
|
1176
|
+
*/
|
|
1107
1177
|
declare const grid: BackgroundPreset;
|
|
1108
1178
|
|
|
1109
|
-
/**
|
|
1179
|
+
/**
|
|
1180
|
+
* Two fine line fields overlap into broad, shifting bands.
|
|
1181
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `interference` is the closest current preset.
|
|
1182
|
+
*/
|
|
1110
1183
|
declare const moire: BackgroundPreset;
|
|
1111
1184
|
|
|
1112
|
-
/**
|
|
1185
|
+
/**
|
|
1186
|
+
* Every cell shimmers at its own frequencies.
|
|
1187
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1188
|
+
*/
|
|
1113
1189
|
declare const morph: BackgroundPreset;
|
|
1114
1190
|
|
|
1115
|
-
/**
|
|
1191
|
+
/**
|
|
1192
|
+
* A slow fractal noise field that warps around the cursor.
|
|
1193
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1194
|
+
*/
|
|
1116
1195
|
declare const noise: BackgroundPreset;
|
|
1117
1196
|
|
|
1118
|
-
/**
|
|
1197
|
+
/**
|
|
1198
|
+
* Rings of characters ripple out from the cursor.
|
|
1199
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `ripple` is the closest current preset.
|
|
1200
|
+
*/
|
|
1119
1201
|
declare const pulse: BackgroundPreset;
|
|
1120
1202
|
|
|
1121
|
-
/**
|
|
1203
|
+
/**
|
|
1204
|
+
* Columns of falling characters with bright heads.
|
|
1205
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `cascade` is the closest current preset.
|
|
1206
|
+
*/
|
|
1122
1207
|
declare const rain: BackgroundPreset;
|
|
1123
1208
|
|
|
1124
|
-
/**
|
|
1209
|
+
/**
|
|
1210
|
+
* Long ribbons that follow a slow flow field.
|
|
1211
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `aurora` is the closest current preset.
|
|
1212
|
+
*/
|
|
1125
1213
|
declare const silk: BackgroundPreset;
|
|
1126
1214
|
|
|
1127
|
-
/**
|
|
1215
|
+
/**
|
|
1216
|
+
* A sparse starfield that twinkles, drifts and leans toward the cursor.
|
|
1217
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `constellation` is the closest current preset.
|
|
1218
|
+
*/
|
|
1128
1219
|
declare const stars: BackgroundPreset;
|
|
1129
1220
|
|
|
1130
|
-
/**
|
|
1221
|
+
/**
|
|
1222
|
+
* A side-scrolling landscape drawn in density characters.
|
|
1223
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `contour` is the closest current preset.
|
|
1224
|
+
*/
|
|
1131
1225
|
declare const terrain: BackgroundPreset;
|
|
1132
1226
|
|
|
1133
|
-
/**
|
|
1227
|
+
/**
|
|
1228
|
+
* Tall folds of light drifting across a quiet ground.
|
|
1229
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `aurora` is the closest current preset.
|
|
1230
|
+
*/
|
|
1134
1231
|
declare const veil: BackgroundPreset;
|
|
1135
1232
|
|
|
1136
|
-
/**
|
|
1233
|
+
/**
|
|
1234
|
+
* A gravity well that spirals characters around the cursor.
|
|
1235
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `halo` is the closest current preset.
|
|
1236
|
+
*/
|
|
1137
1237
|
declare const voidWell: BackgroundPreset;
|
|
1138
1238
|
|
|
1139
|
-
/**
|
|
1239
|
+
/**
|
|
1240
|
+
* An interference field with a soft vortex at the cursor and a slow breath.
|
|
1241
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `swell` is the closest current preset.
|
|
1242
|
+
*/
|
|
1140
1243
|
declare const wave: BackgroundPreset;
|
|
1141
1244
|
|
|
1142
|
-
/**
|
|
1245
|
+
/**
|
|
1246
|
+
* Interlaced threads with a subtle change in tension.
|
|
1247
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `interference` is the closest current preset.
|
|
1248
|
+
*/
|
|
1143
1249
|
declare const weave: BackgroundPreset;
|
|
1144
1250
|
|
|
1145
1251
|
/** What a canvas template is drawn with each frame. */
|
|
@@ -1166,10 +1272,102 @@ type TemplateDraw = (ctx: CanvasRenderingContext2D, width: number, height: numbe
|
|
|
1166
1272
|
*/
|
|
1167
1273
|
declare function mountCanvas(context: BackgroundContext, draw: TemplateDraw, warmFrames?: number): BackgroundRun | null;
|
|
1168
1274
|
|
|
1275
|
+
/**
|
|
1276
|
+
* The Studio's 24 render styles as the glyph field draws them: the glyph-like styles are ramps, the halftone is the dot mark,
|
|
1277
|
+
* and the tile and print styles are field marks of the same name.
|
|
1278
|
+
*/
|
|
1279
|
+
declare const KIT_STYLES: {
|
|
1280
|
+
readonly ascii: {
|
|
1281
|
+
readonly mark: "glyph";
|
|
1282
|
+
readonly charset: " .:-=+*#%@";
|
|
1283
|
+
};
|
|
1284
|
+
readonly blocks: {
|
|
1285
|
+
readonly mark: "glyph";
|
|
1286
|
+
readonly charset: " ░▒▓█";
|
|
1287
|
+
};
|
|
1288
|
+
readonly braille: {
|
|
1289
|
+
readonly mark: "glyph";
|
|
1290
|
+
readonly charset: " ⠁⠃⠇⡇⣇⣧⣷⣿";
|
|
1291
|
+
};
|
|
1292
|
+
readonly dots: {
|
|
1293
|
+
readonly mark: "dot";
|
|
1294
|
+
};
|
|
1295
|
+
readonly lines: {
|
|
1296
|
+
readonly mark: "glyph";
|
|
1297
|
+
readonly charset: " -═╪╬";
|
|
1298
|
+
};
|
|
1299
|
+
readonly cross: {
|
|
1300
|
+
readonly mark: "glyph";
|
|
1301
|
+
readonly charset: " ·+xX#";
|
|
1302
|
+
};
|
|
1303
|
+
readonly diagonal: {
|
|
1304
|
+
readonly mark: "glyph";
|
|
1305
|
+
readonly charset: " /╱╳";
|
|
1306
|
+
};
|
|
1307
|
+
readonly diamond: {
|
|
1308
|
+
readonly mark: "glyph";
|
|
1309
|
+
readonly charset: " ·◇◈◆";
|
|
1310
|
+
};
|
|
1311
|
+
readonly mixed: {
|
|
1312
|
+
readonly mark: "glyph";
|
|
1313
|
+
readonly charset: " .:+/◇#@";
|
|
1314
|
+
};
|
|
1315
|
+
readonly pixel: {
|
|
1316
|
+
readonly mark: "pixel";
|
|
1317
|
+
};
|
|
1318
|
+
readonly mosaic: {
|
|
1319
|
+
readonly mark: "mosaic";
|
|
1320
|
+
};
|
|
1321
|
+
readonly lego: {
|
|
1322
|
+
readonly mark: "lego";
|
|
1323
|
+
};
|
|
1324
|
+
readonly voxel: {
|
|
1325
|
+
readonly mark: "voxel";
|
|
1326
|
+
};
|
|
1327
|
+
readonly disco: {
|
|
1328
|
+
readonly mark: "disco";
|
|
1329
|
+
};
|
|
1330
|
+
readonly dither: {
|
|
1331
|
+
readonly mark: "dither";
|
|
1332
|
+
};
|
|
1333
|
+
readonly hex: {
|
|
1334
|
+
readonly mark: "hex";
|
|
1335
|
+
};
|
|
1336
|
+
readonly led: {
|
|
1337
|
+
readonly mark: "led";
|
|
1338
|
+
};
|
|
1339
|
+
readonly cmyk: {
|
|
1340
|
+
readonly mark: "cmyk";
|
|
1341
|
+
};
|
|
1342
|
+
readonly stipple: {
|
|
1343
|
+
readonly mark: "stipple";
|
|
1344
|
+
};
|
|
1345
|
+
readonly engraving: {
|
|
1346
|
+
readonly mark: "engraving";
|
|
1347
|
+
};
|
|
1348
|
+
readonly crosshatch: {
|
|
1349
|
+
readonly mark: "crosshatch";
|
|
1350
|
+
};
|
|
1351
|
+
readonly woodblock: {
|
|
1352
|
+
readonly mark: "woodblock";
|
|
1353
|
+
};
|
|
1354
|
+
readonly risograph: {
|
|
1355
|
+
readonly mark: "risograph";
|
|
1356
|
+
};
|
|
1357
|
+
readonly pointillism: {
|
|
1358
|
+
readonly mark: "pointillism";
|
|
1359
|
+
};
|
|
1360
|
+
};
|
|
1361
|
+
type KitStyle = keyof typeof KIT_STYLES;
|
|
1169
1362
|
/** The page-wide look `setGlobalLook` lays over every glyph field. */
|
|
1170
1363
|
interface GlobalLook {
|
|
1171
1364
|
/** Characters for every glyph field that keeps none of letters of its own. Empty keeps each field's own. */
|
|
1172
1365
|
charset?: string;
|
|
1366
|
+
/**
|
|
1367
|
+
* One of the Studio's render styles (`KIT_STYLES`): what every such field draws in each cell. A glyph-like style brings its
|
|
1368
|
+
* ramp, which `charset` overrides; a tile or print style changes the mark and keeps each field's own charset for its blanks.
|
|
1369
|
+
*/
|
|
1370
|
+
style?: KitStyle;
|
|
1173
1371
|
}
|
|
1174
1372
|
/** Re-skins every glyph field on the page at once; `null` gives each field its own characters back. */
|
|
1175
1373
|
declare function setGlobalLook(next: GlobalLook | null): void;
|
|
@@ -1183,4 +1381,4 @@ declare function subscribeGlobalLook(listener: (look: GlobalLook | null) => void
|
|
|
1183
1381
|
declare function setFieldBudget(n: number): void;
|
|
1184
1382
|
declare const getFieldBudget: () => number;
|
|
1185
1383
|
|
|
1186
|
-
export { type AccordionHandle, type AccordionImage, type AccordionOptions, type ArtPanelHandle, type ArtPanelOptions, type AsciiVideoHandle, type AsciiVideoOptions, BEAM_PALETTES, type BackgroundCharset, type BackgroundContext, type BackgroundCursor, type BackgroundHandle, type BackgroundOptions, type BackgroundPreset, type BackgroundRun, type BackgroundSettings, type BeamHandle, type BeamMode, type BeamOptions, type BeamPalette, type BlockChartHandle, type BlockChartOptions, type Box, type ButtonLoadingHandle, type ButtonLoadingOptions, type ButtonState, type CodeInputHandle, type CodeInputOptions, type CodeState, type CommandPaletteHandle, type CommandPaletteOptions, type CompareHandle, type CompareOptions, type DecodeHandle, type DecodeOptions, type DisintegrateOptions, type DropState, type DroppedImage, type DropzoneHandle, type DropzoneOptions, type FieldBackgroundHandle, type FieldBackgroundOptions, type FieldPreset, type GenerateState, type GlobalLook, type ImageGenerateHandle, type ImageGenerateOptions, type ImageStream, type ImageUpdate, type KitHandle, type KitOptions, type LikeBurstHandle, type LikeBurstOptions, type LikeMark, type OdometerHandle, type OdometerOptions, type OrbState, PILL_TONES, type PageDissolveHandle, type PageDissolveOptions, type PaintFrame, type PillHandle, type PillOptions, type PillTone, type PricingGlowHandle, type PricingGlowOptions, type PullRefreshHandle, type PullRefreshOptions, type PullState, type SkeletonBlock, type SkeletonHandle, type SkeletonOptions, type SlideToConfirmHandle, type SlideToConfirmOptions, type StatusOrbHandle, type StatusOrbOptions, type StreamState, type StreamTextHandle, type StreamTextOptions, type Surface, type SurfaceConfig, type SwipeDeckHandle, type SwipeDeckOptions, type TabsHandle, type TabsOptions, type TemplateDraw, type TemplateFrame, type ThinkingHandle, type ThinkingOptions, type ThinkingState, type Toast, type ToastStackHandle, type ToastStackOptions, VOICE_PALETTES, type VoiceOrbHandle, type VoiceOrbOptions, type VoicePalette, type VoiceState, type WordmarkHandle, type WordmarkOptions, accordion, artPanel, asciiVideo, aurora, background, backgroundCharset, beam, beamPalette, blockChart, buttonLoading, caustics, circuit, codeInput, commandPalette, compare, contour, decode, disintegrate, dna, drift, dropzone, dune, etch, facet, fieldBackground, fire, fluid, getFieldBudget, getGlobalLook, grid, halftone, imageGenerate, likeBurst, moire, morph, mountCanvas, mountSurface, noise, odometer, pageDissolve, pill, pricingGlow, pullRefresh, pulse, rain, resolveColor, setFieldBudget, setGlobalLook, silk, skeleton, slideToConfirm, stars, statusOrb, streamText, subscribeGlobalLook, swipeDeck, tabs, terrain, thinking, toastStack, veil, voiceOrb, voidWell, wave, weave, wordField, wordmark };
|
|
1384
|
+
export { type AccordionHandle, type AccordionImage, type AccordionOptions, type ArtPanelHandle, type ArtPanelOptions, type AsciiVideoHandle, type AsciiVideoOptions, BEAM_PALETTES, type BackgroundCharset, type BackgroundContext, type BackgroundCursor, type BackgroundHandle, type BackgroundMark, type BackgroundOptions, type BackgroundPreset, type BackgroundRun, type BackgroundSettings, type BeamHandle, type BeamMode, type BeamOptions, type BeamPalette, type BlockChartHandle, type BlockChartOptions, type Box, type ButtonLoadingHandle, type ButtonLoadingOptions, type ButtonState, type CodeInputHandle, type CodeInputOptions, type CodeState, type CommandPaletteHandle, type CommandPaletteOptions, type CompareHandle, type CompareOptions, type DecodeHandle, type DecodeOptions, type DisintegrateOptions, type DropState, type DroppedImage, type DropzoneHandle, type DropzoneOptions, type FieldBackgroundHandle, type FieldBackgroundOptions, type FieldPreset, type GenerateState, type GlobalLook, type ImageGenerateHandle, type ImageGenerateOptions, type ImageStream, type ImageUpdate, KIT_STYLES, type KitHandle, type KitOptions, type KitStyle, type LikeBurstHandle, type LikeBurstOptions, type LikeMark, type OdometerHandle, type OdometerOptions, type OrbState, PILL_TONES, type PageDissolveHandle, type PageDissolveOptions, type PaintFrame, type PillHandle, type PillOptions, type PillTone, type PricingGlowHandle, type PricingGlowOptions, type PullRefreshHandle, type PullRefreshOptions, type PullState, type SkeletonBlock, type SkeletonHandle, type SkeletonOptions, type SlideToConfirmHandle, type SlideToConfirmOptions, type StatusOrbHandle, type StatusOrbOptions, type StreamState, type StreamTextHandle, type StreamTextOptions, type Surface, type SurfaceConfig, type SwipeDeckHandle, type SwipeDeckOptions, type TabsHandle, type TabsOptions, type TemplateDraw, type TemplateFrame, type ThinkingHandle, type ThinkingOptions, type ThinkingState, type Toast, type ToastStackHandle, type ToastStackOptions, VOICE_PALETTES, type VoiceOrbHandle, type VoiceOrbOptions, type VoicePalette, type VoiceState, type WordmarkHandle, type WordmarkOptions, accordion, artPanel, asciiVideo, aurora, background, backgroundCharset, beam, beamPalette, blockChart, buttonLoading, cascade, caustics, circuit, codeInput, commandPalette, compare, constellation, contour, decode, disintegrate, dna, drift, dropzone, dune, etch, facet, fieldBackground, fire, fluid, getFieldBudget, getGlobalLook, grid, halftone, halo, imageGenerate, interference, likeBurst, mesh, moire, morph, mountCanvas, mountSurface, noise, odometer, pageDissolve, pill, pricingGlow, pullRefresh, pulse, rain, resolveColor, ripple, setFieldBudget, setGlobalLook, silk, skeleton, slideToConfirm, stars, statusOrb, streamText, subscribeGlobalLook, swell, swipeDeck, tabs, terrain, thinking, toastStack, veil, voiceOrb, voidWell, wave, weave, wordField, wordmark };
|