CKTIS / JavaScript
HTMLElement.style.scrollBehavior — configurar el desplazamiento suave
Lee, establece o elimina la declaración CSS en línea `scroll-behavior` de un elemento y distínguela del valor CSS resuelto y de la opción de una llamada de desplazamiento.
Versión: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxis
element.style.scrollBehavior;
element.style.scrollBehavior = "smooth";
element.style.scrollBehavior = "auto";
element.style.scrollBehavior = "";HTMLElement.style.scrollBehavior es una propiedad del CSSOM disponible en el objeto style de una instancia de elemento HTML. No es una propiedad estática del constructor HTMLElement ni forma parte de ECMAScript. Usa element.style.scrollBehavior para leer o modificar la declaración CSS en línea de scroll-behavior.
Si no hay una declaración en línea, la lectura devuelve "", aunque una hoja de estilos establezca la propiedad. Asignar "" elimina solo esa declaración; asignar "auto" la establece explícitamente. En un elemento conectado al documento, usa getComputedStyle(element).scrollBehavior para consultar el valor resuelto tras aplicar la cascada.
Establecer esta propiedad no inicia el desplazamiento. Regula cómo se desplaza un contenedor cuando lo desencadena la navegación, por ejemplo mediante un enlace a un fragmento de la página, o una API de desplazamiento del CSSOM. No cambia el desplazamiento directo con rueda o gesto. En CSS, auto es el valor inicial e indica desplazamiento instantáneo; smooth solicita una animación cuya duración y curva de progresión elige el navegador. La propiedad no se hereda de forma predeterminada y el navegador puede ignorarla.
Para configurar el área de visualización de una página HTML, usa el elemento raíz (document.documentElement); una declaración en document.body no se propaga a esa área. En element.scrollTo({ top: 100, behavior: "auto" }), "auto" sigue lo indicado por CSS; "smooth" y "instant" eligen el comportamiento solo para esa llamada. "instant" no es un valor CSS válido de scroll-behavior. Evita forzar el desplazamiento suave cuando se cumpla prefers-reduced-motion: reduce.
Ejemplos
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Inline scroll behavior</title>
</head>
<body>
<script>
const element = document.createElement("div");
console.log(JSON.stringify(element.style.scrollBehavior));
element.style.scrollBehavior = "smooth";
console.log(JSON.stringify(element.style.getPropertyValue("scroll-behavior")));
element.style.scrollBehavior = "";
console.log(JSON.stringify(element.style.scrollBehavior));
</script>
</body>
</html>Resultado
"" "smooth" ""
El ejemplo usa un elemento desconectado del documento para leer, establecer y eliminar la declaración sin desplazar la página. `JSON.stringify()` hace visible la cadena vacía como `""`.
Lecciones relacionadas
- JavaScript · Lección 37 · Avanzado · Versión: 4