Installation
Choose your framework. The registry installs the component and its runtime dependency.
Installation unavailable
The preview is public, but its installable release is still being prepared.
The registry command writes the component to src/lib/components/ui/GlyphField.svelte and installs its dependencies.
The registry command writes the component to src/components/ui/GlyphField.tsx and installs its dependencies.
The registry command writes the component to src/components/ui/GlyphField.vue and installs its dependencies.
Basic usage
The shader fills its parent. Your layout decides whether that parent is a card, hero, or viewport.
Component API
Types below match the selected Svelte component.
Additional classes for the parent-sized root element.
- Type
string
Speed of the waves passing through the glyphs.
- Type
number- Default
0.6- Range / values
0–2
Spacing between glyphs in CSS pixels.
- Type
number- Default
8- Range / values
4–32
Brightness of the glyphs between pointer interactions.
- Type
number- Default
0.3- Range / values
0–1
Fraction of cells left empty.
- Type
number- Default
0.15- Range / values
0–0.9
Maximum shift of the grid opposite to the pointer, in CSS pixels.
- Type
number- Default
28- Range / values
0–100
Response rate as the grid eases after the pointer.
- Type
number- Default
9- Range / values
1–30
Width around the pointer path that lights up, in CSS pixels.
- Type
number- Default
36- Range / values
0–160
Time in seconds before the pointer trail disappears.
- Type
number- Default
0.7- Range / values
0.1–2
Brightness of the pointer trail relative to the resting glyphs.
- Type
number- Default
4- Range / values
0–10
Color behind the glyphs.
- Type
string- Default
"#16171D"
Color of the glyphs away from the pointer.
- Type
string- Default
"#9084FF"
Color of the glyphs along the pointer trail.
- Type
string- Default
"#9084FF"
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer parallax and the trail. Disabling resets the offset and clears the trail; the background animation continues.
- Type
boolean- Default
true- Range / values
true, false
Caps render resolution independently from the element size.
- Type
number- Default
2- Range / values
1–3
Scales GPU resolution without changing layout dimensions.
- Type
number- Default
1- Range / values
0.25–1
Runs after the shader is mounted successfully, including a WebGL fallback.
- Type
(backend: ShaderBackend) => void- Range / values
webgpu, webgl
Runs when automatic initialization changes the requested WebGPU backend to WebGL.
- Type
(backend: ShaderBackend, reason: string) => void- Range / values
webgl
Reports source-loading or renderer failures so the host application can decide how to recover.
- Type
(error: Error) => void
Exposes the imperative component lifecycle methods.
- Type
Component public instance- Range / values
pause, resume, reset, resize, destroy
Types below match the selected React component.
Additional classes for the parent-sized root element.
- Type
string
Speed of the waves passing through the glyphs.
- Type
number- Default
0.6- Range / values
0–2
Spacing between glyphs in CSS pixels.
- Type
number- Default
8- Range / values
4–32
Brightness of the glyphs between pointer interactions.
- Type
number- Default
0.3- Range / values
0–1
Fraction of cells left empty.
- Type
number- Default
0.15- Range / values
0–0.9
Maximum shift of the grid opposite to the pointer, in CSS pixels.
- Type
number- Default
28- Range / values
0–100
Response rate as the grid eases after the pointer.
- Type
number- Default
9- Range / values
1–30
Width around the pointer path that lights up, in CSS pixels.
- Type
number- Default
36- Range / values
0–160
Time in seconds before the pointer trail disappears.
- Type
number- Default
0.7- Range / values
0.1–2
Brightness of the pointer trail relative to the resting glyphs.
- Type
number- Default
4- Range / values
0–10
Color behind the glyphs.
- Type
string- Default
"#16171D"
Color of the glyphs away from the pointer.
- Type
string- Default
"#9084FF"
Color of the glyphs along the pointer trail.
- Type
string- Default
"#9084FF"
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer parallax and the trail. Disabling resets the offset and clears the trail; the background animation continues.
- Type
boolean- Default
true- Range / values
true, false
Caps render resolution independently from the element size.
- Type
number- Default
2- Range / values
1–3
Scales GPU resolution without changing layout dimensions.
- Type
number- Default
1- Range / values
0.25–1
Runs after the shader is mounted successfully, including a WebGL fallback.
- Type
(backend: ShaderBackend) => void- Range / values
webgpu, webgl
Runs when automatic initialization changes the requested WebGPU backend to WebGL.
- Type
(backend: ShaderBackend, reason: string) => void- Range / values
webgl
Reports source-loading or renderer failures so the host application can decide how to recover.
- Type
(error: Error) => void
Exposes the imperative component lifecycle methods.
- Type
GlyphFieldHandle- Range / values
pause, resume, reset, resize, destroy
Types below match the selected Vue component.
Additional classes for the parent-sized root element.
- Type
string
Speed of the waves passing through the glyphs.
- Type
number- Default
0.6- Range / values
0–2
Spacing between glyphs in CSS pixels.
- Type
number- Default
8- Range / values
4–32
Brightness of the glyphs between pointer interactions.
- Type
number- Default
0.3- Range / values
0–1
Fraction of cells left empty.
- Type
number- Default
0.15- Range / values
0–0.9
Maximum shift of the grid opposite to the pointer, in CSS pixels.
- Type
number- Default
28- Range / values
0–100
Response rate as the grid eases after the pointer.
- Type
number- Default
9- Range / values
1–30
Width around the pointer path that lights up, in CSS pixels.
- Type
number- Default
36- Range / values
0–160
Time in seconds before the pointer trail disappears.
- Type
number- Default
0.7- Range / values
0.1–2
Brightness of the pointer trail relative to the resting glyphs.
- Type
number- Default
4- Range / values
0–10
Color behind the glyphs.
- Type
string- Default
"#16171D"
Color of the glyphs away from the pointer.
- Type
string- Default
"#9084FF"
Color of the glyphs along the pointer trail.
- Type
string- Default
"#9084FF"
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer parallax and the trail. Disabling resets the offset and clears the trail; the background animation continues.
- Type
boolean- Default
true- Range / values
true, false
Caps render resolution independently from the element size.
- Type
number- Default
2- Range / values
1–3
Scales GPU resolution without changing layout dimensions.
- Type
number- Default
1- Range / values
0.25–1
Runs after the shader is mounted successfully, including a WebGL fallback.
- Type
(backend: ShaderBackend) => void- Range / values
webgpu, webgl
Runs when automatic initialization changes the requested WebGPU backend to WebGL.
- Type
(backend: ShaderBackend, reason: string) => void- Range / values
webgl
Reports source-loading or renderer failures so the host application can decide how to recover.
- Type
(error: Error) => void
Exposes the imperative component lifecycle methods.
- Type
Component public instance- Range / values
pause, resume, reset, resize, destroy