asciify-engine 4.18.0 → 4.20.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 +16 -0
- package/dist/field.cjs +1 -1
- package/dist/field.d.cts +7 -3
- package/dist/field.d.ts +7 -3
- package/dist/field.js +1 -1
- package/dist/kit.cjs +1 -1
- package/dist/kit.d.cts +127 -35
- package/dist/kit.d.ts +127 -35
- package/dist/kit.js +1 -1
- package/dist/studio.cjs +1 -1
- package/dist/studio.js +1 -1
- package/package.json +1 -1
- package/skills/asciify-engine/SKILL.md +10 -13
- package/skills/asciify-engine/references/applying-asciify.md +11 -13
- package/skills/asciify-engine/references/components.md +3 -3
- package/skills/asciify-engine/references/design-matching.md +2 -2
- package/skills/asciify-engine/references/glyph-field.md +1 -1
- package/skills/asciify-engine/references/kit.md +32 -44
- package/skills/asciify-engine/references/looks.md +908 -19
- package/skills/asciify-engine/references/media-api.md +4 -6
- package/skills/asciify-engine/references/upgrading.md +1 -1
package/dist/kit.d.cts
CHANGED
|
@@ -982,6 +982,8 @@ declare function pullRefresh(element: HTMLElement, options: PullRefreshOptions):
|
|
|
982
982
|
|
|
983
983
|
/** `true` follows the pointer with the preset's own response; the GPU presets also take a named hover. */
|
|
984
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';
|
|
985
987
|
/** A named ramp from the engine's character sets, `'dots'`, or your own characters from empty to dense. */
|
|
986
988
|
type BackgroundCharset = keyof typeof CHARACTER_SETS | 'dots' | (string & {});
|
|
987
989
|
interface BackgroundOptions extends KitOptions {
|
|
@@ -1002,8 +1004,13 @@ interface BackgroundOptions extends KitOptions {
|
|
|
1002
1004
|
cellSize?: number;
|
|
1003
1005
|
/** Characters from empty to dense, or a named set (`blocks`, `braille`, `dots`, ...). Default: the preset's own. */
|
|
1004
1006
|
charset?: BackgroundCharset;
|
|
1005
|
-
/**
|
|
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
|
+
*/
|
|
1006
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;
|
|
1007
1014
|
/** An element to keep clear: the field fades out around it so text over it stays readable. */
|
|
1008
1015
|
clear?: HTMLElement | false;
|
|
1009
1016
|
/** Canvas opacity, 0–1. Default 1 (`fluid` 0.7). */
|
|
@@ -1019,6 +1026,7 @@ interface BackgroundSettings {
|
|
|
1019
1026
|
cellSize: number;
|
|
1020
1027
|
charset: string | undefined;
|
|
1021
1028
|
cursor: BackgroundCursor;
|
|
1029
|
+
mark: BackgroundMark | undefined;
|
|
1022
1030
|
clear: HTMLElement | false;
|
|
1023
1031
|
dither: number;
|
|
1024
1032
|
accent: string | undefined;
|
|
@@ -1074,89 +1082,173 @@ interface BackgroundHandle extends KitHandle<BackgroundOptions> {
|
|
|
1074
1082
|
declare function backgroundCharset(charset: string | undefined): string | undefined;
|
|
1075
1083
|
/**
|
|
1076
1084
|
* An animated ASCII background under an element's content: any of the /backgrounds presets, drawn the same way as on the site.
|
|
1077
|
-
*
|
|
1085
|
+
* The curated presets drive the GPU glyph field, so they follow `setGlobalLook`; the deprecated canvas templates draw with a 2D canvas.
|
|
1078
1086
|
*/
|
|
1079
1087
|
declare function background(element: HTMLElement, options: BackgroundOptions): BackgroundHandle;
|
|
1080
1088
|
|
|
1081
|
-
/**
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
declare const halftone: BackgroundPreset;
|
|
1086
|
-
|
|
1087
|
-
/** A fine dot grid that swells in slow rolling waves, quiet in the middle; dots rise under the pointer. `cellSize` is the dot spacing. */
|
|
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
|
+
*/
|
|
1088
1093
|
declare const swell: BackgroundPreset;
|
|
1089
1094
|
|
|
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;
|
|
1097
|
+
|
|
1090
1098
|
/** A word becomes the background, drawn by the GPU with a soft wake. Set it with `text`; `look: { scene: 'orb' }` for the orb. */
|
|
1091
1099
|
declare const wordField: BackgroundPreset;
|
|
1092
1100
|
|
|
1093
1101
|
/** Flowing folds with a soft wake behind the cursor: the original Asciify hero, driven through the GPU field. */
|
|
1094
1102
|
declare const fluid: BackgroundPreset;
|
|
1095
1103
|
|
|
1096
|
-
/**
|
|
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
|
+
/** Still water: drops land here and there and ring outward; the pointer drops its own as it moves. */
|
|
1111
|
+
declare const ripple: BackgroundPreset;
|
|
1112
|
+
|
|
1113
|
+
/** A corona breathes slowly round the middle of the page, shaped to the stage (wide on desktop, tall on a phone); the centre stays empty. */
|
|
1114
|
+
declare const halo: BackgroundPreset;
|
|
1115
|
+
|
|
1116
|
+
/** Two fine ring grids from slowly orbiting centres; where they cross, broad moiré bands open and close. */
|
|
1117
|
+
declare const interference: BackgroundPreset;
|
|
1118
|
+
|
|
1119
|
+
/** Four soft lights on slow paths: a gradient mesh written in characters, the whole ramp from empty to dense. */
|
|
1120
|
+
declare const mesh: BackgroundPreset;
|
|
1121
|
+
|
|
1122
|
+
/** Streaks fall in three depths: far ones fine, faint and slow, near ones rare, bright and quick. */
|
|
1123
|
+
declare const cascade: BackgroundPreset;
|
|
1124
|
+
|
|
1125
|
+
/** Points wander in their own cells, and neighbours close enough are linked by fine lines that come and go. */
|
|
1126
|
+
declare const constellation: BackgroundPreset;
|
|
1127
|
+
|
|
1128
|
+
/**
|
|
1129
|
+
* Curtains of light at three depths hang from the top in vertical rays, the nearest tallest and brightest, folding slowly.
|
|
1130
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1131
|
+
*/
|
|
1097
1132
|
declare const aurora: BackgroundPreset;
|
|
1098
1133
|
|
|
1099
|
-
/**
|
|
1100
|
-
|
|
1134
|
+
/**
|
|
1135
|
+
* The drifting ground drawn as dots, clear around your content. `cellSize` is the dot spacing.
|
|
1136
|
+
* @deprecated The same field as `drift`: use `drift` with `mark: 'dot'` (and `cellSize: 14` for this spacing).
|
|
1137
|
+
*/
|
|
1138
|
+
declare const halftone: BackgroundPreset;
|
|
1101
1139
|
|
|
1102
|
-
/**
|
|
1140
|
+
/**
|
|
1141
|
+
* Circuit traces with signals running along them.
|
|
1142
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `constellation` is the closest current preset.
|
|
1143
|
+
*/
|
|
1103
1144
|
declare const circuit: BackgroundPreset;
|
|
1104
1145
|
|
|
1105
|
-
/**
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1146
|
+
/**
|
|
1147
|
+
* Double helices scroll past with base-pair letters.
|
|
1148
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `halo` is the closest current preset.
|
|
1149
|
+
*/
|
|
1109
1150
|
declare const dna: BackgroundPreset;
|
|
1110
1151
|
|
|
1111
|
-
/**
|
|
1152
|
+
/**
|
|
1153
|
+
* Layered sand ridges with slow-moving light and fine grain.
|
|
1154
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `contour` is the closest current preset.
|
|
1155
|
+
*/
|
|
1112
1156
|
declare const dune: BackgroundPreset;
|
|
1113
1157
|
|
|
1114
|
-
/**
|
|
1158
|
+
/**
|
|
1159
|
+
* Cut-grain lines follow a slow, sculpted current.
|
|
1160
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `contour` is the closest current preset.
|
|
1161
|
+
*/
|
|
1115
1162
|
declare const etch: BackgroundPreset;
|
|
1116
1163
|
|
|
1117
|
-
/**
|
|
1164
|
+
/**
|
|
1165
|
+
* Quiet folded planes catch light along their edges.
|
|
1166
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `caustics` is the closest current preset.
|
|
1167
|
+
*/
|
|
1118
1168
|
declare const facet: BackgroundPreset;
|
|
1119
1169
|
|
|
1120
|
-
/**
|
|
1170
|
+
/**
|
|
1171
|
+
* A cellular flame rising from the bottom edge.
|
|
1172
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1173
|
+
*/
|
|
1121
1174
|
declare const fire: BackgroundPreset;
|
|
1122
1175
|
|
|
1123
|
-
/**
|
|
1176
|
+
/**
|
|
1177
|
+
* Scan bands roll down a character grid and glitch near the cursor.
|
|
1178
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `interference` is the closest current preset.
|
|
1179
|
+
*/
|
|
1124
1180
|
declare const grid: BackgroundPreset;
|
|
1125
1181
|
|
|
1126
|
-
/**
|
|
1182
|
+
/**
|
|
1183
|
+
* Two fine line fields overlap into broad, shifting bands.
|
|
1184
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `interference` is the closest current preset.
|
|
1185
|
+
*/
|
|
1127
1186
|
declare const moire: BackgroundPreset;
|
|
1128
1187
|
|
|
1129
|
-
/**
|
|
1188
|
+
/**
|
|
1189
|
+
* Every cell shimmers at its own frequencies.
|
|
1190
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1191
|
+
*/
|
|
1130
1192
|
declare const morph: BackgroundPreset;
|
|
1131
1193
|
|
|
1132
|
-
/**
|
|
1194
|
+
/**
|
|
1195
|
+
* A slow fractal noise field that warps around the cursor.
|
|
1196
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1197
|
+
*/
|
|
1133
1198
|
declare const noise: BackgroundPreset;
|
|
1134
1199
|
|
|
1135
|
-
/**
|
|
1200
|
+
/**
|
|
1201
|
+
* Rings of characters ripple out from the cursor.
|
|
1202
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `ripple` is the closest current preset.
|
|
1203
|
+
*/
|
|
1136
1204
|
declare const pulse: BackgroundPreset;
|
|
1137
1205
|
|
|
1138
|
-
/**
|
|
1206
|
+
/**
|
|
1207
|
+
* Columns of falling characters with bright heads.
|
|
1208
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `cascade` is the closest current preset.
|
|
1209
|
+
*/
|
|
1139
1210
|
declare const rain: BackgroundPreset;
|
|
1140
1211
|
|
|
1141
|
-
/**
|
|
1212
|
+
/**
|
|
1213
|
+
* Long ribbons that follow a slow flow field.
|
|
1214
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1215
|
+
*/
|
|
1142
1216
|
declare const silk: BackgroundPreset;
|
|
1143
1217
|
|
|
1144
|
-
/**
|
|
1218
|
+
/**
|
|
1219
|
+
* A sparse starfield that twinkles, drifts and leans toward the cursor.
|
|
1220
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `constellation` is the closest current preset.
|
|
1221
|
+
*/
|
|
1145
1222
|
declare const stars: BackgroundPreset;
|
|
1146
1223
|
|
|
1147
|
-
/**
|
|
1224
|
+
/**
|
|
1225
|
+
* A side-scrolling landscape drawn in density characters.
|
|
1226
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `contour` is the closest current preset.
|
|
1227
|
+
*/
|
|
1148
1228
|
declare const terrain: BackgroundPreset;
|
|
1149
1229
|
|
|
1150
|
-
/**
|
|
1230
|
+
/**
|
|
1231
|
+
* Tall folds of light drifting across a quiet ground.
|
|
1232
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1233
|
+
*/
|
|
1151
1234
|
declare const veil: BackgroundPreset;
|
|
1152
1235
|
|
|
1153
|
-
/**
|
|
1236
|
+
/**
|
|
1237
|
+
* A gravity well that spirals characters around the cursor.
|
|
1238
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `halo` is the closest current preset.
|
|
1239
|
+
*/
|
|
1154
1240
|
declare const voidWell: BackgroundPreset;
|
|
1155
1241
|
|
|
1156
|
-
/**
|
|
1242
|
+
/**
|
|
1243
|
+
* An interference field with a soft vortex at the cursor and a slow breath.
|
|
1244
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `swell` is the closest current preset.
|
|
1245
|
+
*/
|
|
1157
1246
|
declare const wave: BackgroundPreset;
|
|
1158
1247
|
|
|
1159
|
-
/**
|
|
1248
|
+
/**
|
|
1249
|
+
* Interlaced threads with a subtle change in tension.
|
|
1250
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `interference` is the closest current preset.
|
|
1251
|
+
*/
|
|
1160
1252
|
declare const weave: BackgroundPreset;
|
|
1161
1253
|
|
|
1162
1254
|
/** What a canvas template is drawn with each frame. */
|
|
@@ -1292,4 +1384,4 @@ declare function subscribeGlobalLook(listener: (look: GlobalLook | null) => void
|
|
|
1292
1384
|
declare function setFieldBudget(n: number): void;
|
|
1293
1385
|
declare const getFieldBudget: () => number;
|
|
1294
1386
|
|
|
1295
|
-
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, 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, 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, swell, swipeDeck, tabs, terrain, thinking, toastStack, veil, voiceOrb, voidWell, wave, weave, wordField, wordmark };
|
|
1387
|
+
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 };
|
package/dist/kit.d.ts
CHANGED
|
@@ -982,6 +982,8 @@ declare function pullRefresh(element: HTMLElement, options: PullRefreshOptions):
|
|
|
982
982
|
|
|
983
983
|
/** `true` follows the pointer with the preset's own response; the GPU presets also take a named hover. */
|
|
984
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';
|
|
985
987
|
/** A named ramp from the engine's character sets, `'dots'`, or your own characters from empty to dense. */
|
|
986
988
|
type BackgroundCharset = keyof typeof CHARACTER_SETS | 'dots' | (string & {});
|
|
987
989
|
interface BackgroundOptions extends KitOptions {
|
|
@@ -1002,8 +1004,13 @@ interface BackgroundOptions extends KitOptions {
|
|
|
1002
1004
|
cellSize?: number;
|
|
1003
1005
|
/** Characters from empty to dense, or a named set (`blocks`, `braille`, `dots`, ...). Default: the preset's own. */
|
|
1004
1006
|
charset?: BackgroundCharset;
|
|
1005
|
-
/**
|
|
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
|
+
*/
|
|
1006
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;
|
|
1007
1014
|
/** An element to keep clear: the field fades out around it so text over it stays readable. */
|
|
1008
1015
|
clear?: HTMLElement | false;
|
|
1009
1016
|
/** Canvas opacity, 0–1. Default 1 (`fluid` 0.7). */
|
|
@@ -1019,6 +1026,7 @@ interface BackgroundSettings {
|
|
|
1019
1026
|
cellSize: number;
|
|
1020
1027
|
charset: string | undefined;
|
|
1021
1028
|
cursor: BackgroundCursor;
|
|
1029
|
+
mark: BackgroundMark | undefined;
|
|
1022
1030
|
clear: HTMLElement | false;
|
|
1023
1031
|
dither: number;
|
|
1024
1032
|
accent: string | undefined;
|
|
@@ -1074,89 +1082,173 @@ interface BackgroundHandle extends KitHandle<BackgroundOptions> {
|
|
|
1074
1082
|
declare function backgroundCharset(charset: string | undefined): string | undefined;
|
|
1075
1083
|
/**
|
|
1076
1084
|
* An animated ASCII background under an element's content: any of the /backgrounds presets, drawn the same way as on the site.
|
|
1077
|
-
*
|
|
1085
|
+
* The curated presets drive the GPU glyph field, so they follow `setGlobalLook`; the deprecated canvas templates draw with a 2D canvas.
|
|
1078
1086
|
*/
|
|
1079
1087
|
declare function background(element: HTMLElement, options: BackgroundOptions): BackgroundHandle;
|
|
1080
1088
|
|
|
1081
|
-
/**
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
declare const halftone: BackgroundPreset;
|
|
1086
|
-
|
|
1087
|
-
/** A fine dot grid that swells in slow rolling waves, quiet in the middle; dots rise under the pointer. `cellSize` is the dot spacing. */
|
|
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
|
+
*/
|
|
1088
1093
|
declare const swell: BackgroundPreset;
|
|
1089
1094
|
|
|
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;
|
|
1097
|
+
|
|
1090
1098
|
/** A word becomes the background, drawn by the GPU with a soft wake. Set it with `text`; `look: { scene: 'orb' }` for the orb. */
|
|
1091
1099
|
declare const wordField: BackgroundPreset;
|
|
1092
1100
|
|
|
1093
1101
|
/** Flowing folds with a soft wake behind the cursor: the original Asciify hero, driven through the GPU field. */
|
|
1094
1102
|
declare const fluid: BackgroundPreset;
|
|
1095
1103
|
|
|
1096
|
-
/**
|
|
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
|
+
/** Still water: drops land here and there and ring outward; the pointer drops its own as it moves. */
|
|
1111
|
+
declare const ripple: BackgroundPreset;
|
|
1112
|
+
|
|
1113
|
+
/** A corona breathes slowly round the middle of the page, shaped to the stage (wide on desktop, tall on a phone); the centre stays empty. */
|
|
1114
|
+
declare const halo: BackgroundPreset;
|
|
1115
|
+
|
|
1116
|
+
/** Two fine ring grids from slowly orbiting centres; where they cross, broad moiré bands open and close. */
|
|
1117
|
+
declare const interference: BackgroundPreset;
|
|
1118
|
+
|
|
1119
|
+
/** Four soft lights on slow paths: a gradient mesh written in characters, the whole ramp from empty to dense. */
|
|
1120
|
+
declare const mesh: BackgroundPreset;
|
|
1121
|
+
|
|
1122
|
+
/** Streaks fall in three depths: far ones fine, faint and slow, near ones rare, bright and quick. */
|
|
1123
|
+
declare const cascade: BackgroundPreset;
|
|
1124
|
+
|
|
1125
|
+
/** Points wander in their own cells, and neighbours close enough are linked by fine lines that come and go. */
|
|
1126
|
+
declare const constellation: BackgroundPreset;
|
|
1127
|
+
|
|
1128
|
+
/**
|
|
1129
|
+
* Curtains of light at three depths hang from the top in vertical rays, the nearest tallest and brightest, folding slowly.
|
|
1130
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1131
|
+
*/
|
|
1097
1132
|
declare const aurora: BackgroundPreset;
|
|
1098
1133
|
|
|
1099
|
-
/**
|
|
1100
|
-
|
|
1134
|
+
/**
|
|
1135
|
+
* The drifting ground drawn as dots, clear around your content. `cellSize` is the dot spacing.
|
|
1136
|
+
* @deprecated The same field as `drift`: use `drift` with `mark: 'dot'` (and `cellSize: 14` for this spacing).
|
|
1137
|
+
*/
|
|
1138
|
+
declare const halftone: BackgroundPreset;
|
|
1101
1139
|
|
|
1102
|
-
/**
|
|
1140
|
+
/**
|
|
1141
|
+
* Circuit traces with signals running along them.
|
|
1142
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `constellation` is the closest current preset.
|
|
1143
|
+
*/
|
|
1103
1144
|
declare const circuit: BackgroundPreset;
|
|
1104
1145
|
|
|
1105
|
-
/**
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1146
|
+
/**
|
|
1147
|
+
* Double helices scroll past with base-pair letters.
|
|
1148
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `halo` is the closest current preset.
|
|
1149
|
+
*/
|
|
1109
1150
|
declare const dna: BackgroundPreset;
|
|
1110
1151
|
|
|
1111
|
-
/**
|
|
1152
|
+
/**
|
|
1153
|
+
* Layered sand ridges with slow-moving light and fine grain.
|
|
1154
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `contour` is the closest current preset.
|
|
1155
|
+
*/
|
|
1112
1156
|
declare const dune: BackgroundPreset;
|
|
1113
1157
|
|
|
1114
|
-
/**
|
|
1158
|
+
/**
|
|
1159
|
+
* Cut-grain lines follow a slow, sculpted current.
|
|
1160
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `contour` is the closest current preset.
|
|
1161
|
+
*/
|
|
1115
1162
|
declare const etch: BackgroundPreset;
|
|
1116
1163
|
|
|
1117
|
-
/**
|
|
1164
|
+
/**
|
|
1165
|
+
* Quiet folded planes catch light along their edges.
|
|
1166
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `caustics` is the closest current preset.
|
|
1167
|
+
*/
|
|
1118
1168
|
declare const facet: BackgroundPreset;
|
|
1119
1169
|
|
|
1120
|
-
/**
|
|
1170
|
+
/**
|
|
1171
|
+
* A cellular flame rising from the bottom edge.
|
|
1172
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1173
|
+
*/
|
|
1121
1174
|
declare const fire: BackgroundPreset;
|
|
1122
1175
|
|
|
1123
|
-
/**
|
|
1176
|
+
/**
|
|
1177
|
+
* Scan bands roll down a character grid and glitch near the cursor.
|
|
1178
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `interference` is the closest current preset.
|
|
1179
|
+
*/
|
|
1124
1180
|
declare const grid: BackgroundPreset;
|
|
1125
1181
|
|
|
1126
|
-
/**
|
|
1182
|
+
/**
|
|
1183
|
+
* Two fine line fields overlap into broad, shifting bands.
|
|
1184
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `interference` is the closest current preset.
|
|
1185
|
+
*/
|
|
1127
1186
|
declare const moire: BackgroundPreset;
|
|
1128
1187
|
|
|
1129
|
-
/**
|
|
1188
|
+
/**
|
|
1189
|
+
* Every cell shimmers at its own frequencies.
|
|
1190
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1191
|
+
*/
|
|
1130
1192
|
declare const morph: BackgroundPreset;
|
|
1131
1193
|
|
|
1132
|
-
/**
|
|
1194
|
+
/**
|
|
1195
|
+
* A slow fractal noise field that warps around the cursor.
|
|
1196
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1197
|
+
*/
|
|
1133
1198
|
declare const noise: BackgroundPreset;
|
|
1134
1199
|
|
|
1135
|
-
/**
|
|
1200
|
+
/**
|
|
1201
|
+
* Rings of characters ripple out from the cursor.
|
|
1202
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `ripple` is the closest current preset.
|
|
1203
|
+
*/
|
|
1136
1204
|
declare const pulse: BackgroundPreset;
|
|
1137
1205
|
|
|
1138
|
-
/**
|
|
1206
|
+
/**
|
|
1207
|
+
* Columns of falling characters with bright heads.
|
|
1208
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `cascade` is the closest current preset.
|
|
1209
|
+
*/
|
|
1139
1210
|
declare const rain: BackgroundPreset;
|
|
1140
1211
|
|
|
1141
|
-
/**
|
|
1212
|
+
/**
|
|
1213
|
+
* Long ribbons that follow a slow flow field.
|
|
1214
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1215
|
+
*/
|
|
1142
1216
|
declare const silk: BackgroundPreset;
|
|
1143
1217
|
|
|
1144
|
-
/**
|
|
1218
|
+
/**
|
|
1219
|
+
* A sparse starfield that twinkles, drifts and leans toward the cursor.
|
|
1220
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `constellation` is the closest current preset.
|
|
1221
|
+
*/
|
|
1145
1222
|
declare const stars: BackgroundPreset;
|
|
1146
1223
|
|
|
1147
|
-
/**
|
|
1224
|
+
/**
|
|
1225
|
+
* A side-scrolling landscape drawn in density characters.
|
|
1226
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `contour` is the closest current preset.
|
|
1227
|
+
*/
|
|
1148
1228
|
declare const terrain: BackgroundPreset;
|
|
1149
1229
|
|
|
1150
|
-
/**
|
|
1230
|
+
/**
|
|
1231
|
+
* Tall folds of light drifting across a quiet ground.
|
|
1232
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `mesh` is the closest current preset.
|
|
1233
|
+
*/
|
|
1151
1234
|
declare const veil: BackgroundPreset;
|
|
1152
1235
|
|
|
1153
|
-
/**
|
|
1236
|
+
/**
|
|
1237
|
+
* A gravity well that spirals characters around the cursor.
|
|
1238
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `halo` is the closest current preset.
|
|
1239
|
+
*/
|
|
1154
1240
|
declare const voidWell: BackgroundPreset;
|
|
1155
1241
|
|
|
1156
|
-
/**
|
|
1242
|
+
/**
|
|
1243
|
+
* An interference field with a soft vortex at the cursor and a slow breath.
|
|
1244
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `swell` is the closest current preset.
|
|
1245
|
+
*/
|
|
1157
1246
|
declare const wave: BackgroundPreset;
|
|
1158
1247
|
|
|
1159
|
-
/**
|
|
1248
|
+
/**
|
|
1249
|
+
* Interlaced threads with a subtle change in tension.
|
|
1250
|
+
* @deprecated Retired from the curated set; kept so existing code still runs. `interference` is the closest current preset.
|
|
1251
|
+
*/
|
|
1160
1252
|
declare const weave: BackgroundPreset;
|
|
1161
1253
|
|
|
1162
1254
|
/** What a canvas template is drawn with each frame. */
|
|
@@ -1292,4 +1384,4 @@ declare function subscribeGlobalLook(listener: (look: GlobalLook | null) => void
|
|
|
1292
1384
|
declare function setFieldBudget(n: number): void;
|
|
1293
1385
|
declare const getFieldBudget: () => number;
|
|
1294
1386
|
|
|
1295
|
-
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, 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, 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, swell, swipeDeck, tabs, terrain, thinking, toastStack, veil, voiceOrb, voidWell, wave, weave, wordField, wordmark };
|
|
1387
|
+
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 };
|