Ir al contenido

Referencia de la API

Opciones, propiedades y métodos compartidos por todos los efectos.

Los 21 efectos aceptan opciones de creación compartidas y devuelven una instancia (EffectHandle). Comienza por la referencia de un efecto para conocer su importación, aspecto y opciones compatibles.

Importa una función de efecto desde @domfx/browser. Llámala en el navegador después de montar el elemento objetivo y el contenedor del efecto (host). El contenedor debe contener el objetivo y tener una posición CSS distinta de static. Puedes importar el paquete durante el renderizado en el servidor (SSR); aplicar efectos y capturar su apariencia requieren elementos del DOM en el navegador.

import { attachFrost } from '@domfx/browser';
import type { AttachmentOptions } from '@domfx/browser';

const options: AttachmentOptions = {
host,
clock: 'manual',
intensity: 0.8,
};
const effect = attachFrost(target, options);

// Libera también el efecto al desmontar el componente.
window.addEventListener('pagehide', () => effect.dispose(), { once: true });
await effect.ready;
if (effect.lifecycle === 'active') {
effect.time = 2;
}

Cada función recibe (target: Element, options) y devuelve de inmediato un EffectHandle. Consulta la guía de uso independiente para una configuración completa.

Elige el contenedor del objetivo, el control de animación, el comportamiento con movimiento reducido y los valores iniciales en la referencia de opciones compartidas.

flameReach de Fire es una opción de creación que fija el alcance relativo a la altura del objetivo. Omítela para usar la apariencia predeterminada.

Los 21 efectos tienen opciones relativas propias que se fijan al crear la instancia. El recorrido direccional usa la altura física del objetivo; la profundidad interior y el recorrido radial usan el lado más corto del border box sin transformar. Los márgenes transparentes cuentan; el margen de captura no. Proporcionar una extensión activa la intensidad como fuerza independiente. Consulta cada referencia del efecto para ver sus campos, valores cero de las parejas y límites de soporte. Omitir todas las extensiones conserva la apariencia predeterminada.

Asigna tiempo e intensidad directamente o mediante GSAP. El tiempo se mide en segundos; la intensidad varía entre 0 y 1 y cambia el aspecto de cada efecto.

Consulta la finalización de la configuración, el estado del efecto y el estado de captura. Que termine la configuración no garantiza una salida visible.

Pausar, reanudar, actualizar la captura, reintentar y liberar tienen el mismo contrato para todos los efectos.

Importa estas funciones desde @domfx/browser. Cada referencia comienza con una vista previa interactiva, seguida de sus opciones exactas.

EfectoFunciónCategoría
ElectricityattachElectricityEnergía
FrostattachFrostMaterial
FireattachFireEnergía
DitherattachDitherPatrón
SlimeattachSlimeMaterial
Kinetic bloomattachKineticEnergía
Burned paperattachBurnedPaperMaterial
HalftoneattachHalftonePatrón
StippleattachStipplePatrón
ScanlinesattachScanlinesPatrón
CrosshatchattachCrosshatchPatrón
Diamond latticeattachDiamondsPatrón
Contour echoesattachContourEchoesPatrón
EngravingattachEngravingPatrón
Woven meshattachWovenMeshPatrón
HexagonsattachHexagonsPatrón
InterferenceattachInterferencePatrón
ShardsattachShardsPatrón
CircuitsattachCircuitsPatrón
Star shimmerattachStarShimmerPatrón
Brush fringeattachBrushFringePatrón

Usa gsap.to() y llamadas habituales a los métodos de una línea de tiempo sobre una instancia de efecto. La referencia de GSAP explica los enlaces opcionales que conservan valores iniciales fijos y gestionan la limpieza.

PaqueteResponsabilidad
@domfx/coreTipos de efecto compartidos, independientes de DOM, GPU y frameworks. Se instala automáticamente.
@domfx/browserCaptura el objetivo y dibuja su efecto decorativo. La aplicación no necesita un plugin de shaders.
@domfx/gsapEnlace opcional con una línea de tiempo de GSAP que proporcionas. Los efectos independientes no cargan GSAP.

Para depurar localmente, consulta los registros experimentales de efectos.