Ir al contenido

Slime

Una capa verde con gotas que se estiran y caen.

La vista previa necesita JavaScript y WebGPU.

Categoría
Material
Función
attachSlime
Opciones
SlimeOptions
Paquete
@domfx/browser

Uso

attachSlime(target: Element, options: SlimeOptions): ColorEffectHandle

Devuelve una instancia de efecto de inmediato. Las importaciones son seguras durante el renderizado en servidor; llama a la función en el navegador después de montar los elementos. La guía de uso independiente incluye el HTML y CSS necesarios.

import { attachSlime } from '@domfx/browser';
import type { SlimeOptions } from '@domfx/browser';

// Ejecuta después del montaje; host contiene target y tiene position: relative.
const options: SlimeOptions = {
  host, clock: 'auto', intensity: 0.8,
  coatingDepth: 0.05,
  dripReach: 0.2,
  dripDensity: 0.56,
};
const effect = attachSlime(target, options);
// Llama también a effect.dispose() al desmontar el componente.
window.addEventListener('pagehide', () => effect.dispose(), { once: true });
await effect.ready;
if (effect.lifecycle !== 'active') {
  console.info(effect.reason, effect.reasonDetail);
}

Opciones del efecto

Opciones de creación: fracciones numéricas finitas y no negativas del border box sin transformar, sin incluir el margen de captura. Los márgenes transparentes cuentan. Se recalculan al capturar después de un cambio de tamaño; las traslaciones y escalas positivas admitidas solo cambian la colocación.

PropiedadTipo y unidadEjemplo
coatingDepth

Profundidad de la capa

number · fracción del lado local más corto0.05 = 5%
dripReach

Recorrido de las gotas

number · fracción de la altura física local0.2 = 20%
PropiedadTipo y rangoValor predeterminado
dripDensitynumber · 0–10.56

Aumenta dripDensity para añadir más gotas. Cero las desactiva; los valores superiores al predeterminado añaden más ubicaciones de emisión. No es un número exacto de gotas ni una tasa de emisión: no cambia su tamaño, recorrido o ritmo. Funciona con la apariencia predeterminada y con extensiones relativas; por sí sola no activa el modo relativo. Es una opción de creación: libera la instancia y crea otra para cambiarla.

Omitir ambas extensiones conserva la apariencia predeterminada. Proporcionar cualquiera activa el modo relativo: la opción que falte vale cero y desactiva ese componente. La intensidad escala la salida premultiplicada sin cambiar la geometría ni el detalle fino. Ambas extensiones en cero producen salida transparente. Cambiar una extensión requiere liberar la instancia y crear otra; no hay setters geométricos.

La profundidad limita la cobertura interior; el alcance limita el recorrido de la niebla, gotas o ceniza. Es una envolvente permitida, no una punta visible garantizada. Los granos, brillos y gotas conservan su tamaño local. El borde material puede sobresalir hasta 6 px CSS y las marcas móviles hasta 8 px CSS del recorrido; el margen reservado incluye ese soporte y la protección de muestreo.

Requiere cajas descendientes contenidas y pintura dentro del border box más 2 px CSS; no admite sombras, filtros, contornos ni pseudoelementos generados. Se comprueba todo el alfa capturado y el margen exterior. Los límites de píxeles, memoria y dispositivo siguen vigentes: una solicitud que no cabe deja el efecto no disponible sin recortar ni reducir la calidad. El contenido original sigue utilizable.

Opciones compartidas

Usa el tipo exportado AttachmentOptions. Solo host es obligatorio. Los efectos salvo Burned paper amplían este tipo con ColorAttachmentOptions.

PropiedadTipoPredeterminado
host

Contenedor del efecto: un elemento HTML ya presente en la página, con una posición CSS distinta de static. Debe contener el elemento objetivo en el mismo documento; no puede ser el propio objetivo.

HTMLElementObligatorio
clock

Usa manual para controlar el tiempo con tu código o GSAP; auto lo avanza automáticamente.

'manual' | 'auto''manual'
motion

respect suprime la salida con movimiento reducido. static siempre dibuja un efecto inmóvil en el tiempo cero, con cualquier preferencia.

'respect' | 'static''respect'
seed

Semilla aleatoria fija. Permite repetir el patrón con el mismo tiempo, ajustes y objetivo capturado. No determina la cantidad de aleatoriedad ni garantiza píxeles idénticos entre dispositivos.

number0
time

Tiempo inicial del efecto en segundos. Acepta valores negativos.

number0
intensity

Intensidad inicial del efecto. Los valores aceptados se limitan al intervalo de 0 a 1; la respuesta visual depende del efecto.

number1
color

Color decorativo principal opcional para todos los efectos excepto Burned paper. Acepta #RGB, #RRGGBB, rgb(...) y rgba(..., 1). Omitirlo conserva los colores originales del efecto; asignar undefined los restaura.

string | undefinedOmitido (colores originales)

Todos los valores numéricos deben ser finitos. time, seed, intensity y los controles solo de creación deben ser representables como float32. Los controles artísticos modificables, incluso al crearlos, aceptan cualquier número finito y se limitan a 0–1; los demás valores no válidos generan un error antes de aplicar el límite. Para cambiar una opción de creación distinta de time o intensity, libera la instancia y crea otra.

Solo un efecto puede usar un objetivo a la vez. Las relaciones de contenedor no válidas y los objetivos superpuestos generan un error síncrono. Libera el efecto existente antes de aplicar otro al mismo objetivo, a uno de sus ancestros o a uno de sus descendientes. Esta restricción se refiere al árbol del DOM, no a cualquier superposición visual.

Controles

En la apariencia predeterminada, cambia la geometría de la capa y las gotas. Con coatingDepth o dripReach, la intensidad solo cambia la fuerza visual; el alcance omitido vale cero.

Lee y modifica estas propiedades de la instancia de efecto. Los cambios pueden leerse de inmediato. Cuando la salida está disponible, se dibujan en el siguiente fotograma sin volver a capturar el elemento.

PropiedadTipo
time

Tiempo del efecto en segundos. Permite avanzar y retroceder, incluso a tiempos negativos.

number
intensity

Intensidad del efecto, limitada al intervalo de 0 a 1 después de validar el valor. No es un ajuste universal de altura ni de opacidad.

number
color

Color decorativo principal opcional. Todos los efectos excepto Burned paper lo admiten; asigna undefined para recuperar los colores originales.

string | undefined

Todos los valores numéricos deben ser finitos. time e intensity deben ser representables como float32. intensity y los controles específicos se limitan a 0–1; estos últimos aceptan cualquier número finito. Una asignación no válida genera un error y conserva el valor anterior. Usa un solo controlador por propiedad: asignaciones directas, una línea de tiempo u otro controlador de animación.

Consulta la sección sobre animación automática y control externo y la guía de GSAP. La referencia de la instancia de efecto documenta el estado, las actualizaciones de captura y la liberación de recursos.

Límites

El efecto sigue la forma visible capturada, incluidos los huecos y las regiones separadas. Una imagen opaca tiene una forma rectangular. La capa decorativa conserva intacto el contenido original.

Solo las opciones enumeradas son públicas. Todos los efectos salvo Burned paper permiten configurar un color decorativo principal; los degradados, la cantidad de partículas y el procesamiento del elemento completo no se pueden configurar. Mantén utilizable el contenido original cuando la salida no esté disponible. Para los límites de WebGPU, captura y composición, consulta compatibilidad con navegadores y solución de problemas.

Compara todos los efectos en la galería, uno junto a otro.