Saltar al contenido principal
Neural UIv2.0.0Documentación
Ver v1 GitHub

ScrollTop

Regresa al inicio de la página o de un panel desplazable al superar un umbral.

Categoría
Navegación
Import
@neural-ui/core/scroll-top
Selector
neu-scroll-top
import { NeuScrollTopComponent } from '@neural-ui/core/scroll-top';

Uso

Elige target="window" para observar el desplazamiento de la página o target="parent" para el elemento padre inmediato. Asigna a ese padre una altura limitada y overflow:auto. threshold es una distancia vertical en píxeles; el botón aparece al superarla. behavior elige auto o smooth. El chevron predeterminado está integrado y no necesita proveedor de iconos.

Ejemplos

Prueba la interacción y abre Código para ver la implementación completa.

Ejemplos

Desplaza el panel hacia abajo para mostrar el botón de regreso. La opción window observa la página en su lugar.

Capítulo 1

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 2

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 3

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 4

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 5

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 6

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 7

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 8

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 9

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 10

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 11

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 12

Lee esta sección y continúa con el siguiente capítulo.

Prueba y configura

Cambia las opciones, prueba el resultado y consulta el template actualizado. Código contiene el ejemplo ejecutable completo.

Prueba y configura

Desplaza el panel hacia abajo para mostrar el botón de regreso. La opción window observa la página en su lugar.

Capítulo 1

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 2

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 3

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 4

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 5

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 6

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 7

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 8

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 9

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 10

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 11

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 12

Lee esta sección y continúa con el siguiente capítulo.

Template generado con tus opciones actuales. Abre Código para consultar el ejemplo completo.

template.html
<neu-scroll-area
  maxHeight="16rem"
  [mask]="false"
  ariaLabel="Panel de lectura desplazable"
>
  <!-- Add your scrollable content here. -->
  <neu-scroll-top
    target="parent"
    behavior="smooth"
    [threshold]="100"
  [buttonAriaLabel]="'Volver al inicio'"
/>
</neu-scroll-area>

Datos y contenido

ScrollTop observa el desplazamiento del navegador y mueve su destino al activarse. No tiene Outputs. icon resuelve una clave de icono opcional aportada por la aplicación; neuScrollTopIcon sustituye el icono visual con contenido proyectado y conserva la etiqueta del botón nativo.

Accesibilidad y teclado

Traduce buttonAriaLabel para describir el destino. Tab accede al botón visible; Intro o Espacio lo activan. Los iconos decorativos del Template deben usar aria-hidden. El componente comprueba que existe un navegador y no accede a una ventana inexistente durante el renderizado en servidor.

Tecla
Acción
Tab Enfoca el botón cuando está visible y habilitado.
Enter Desplaza hasta el destino indicado por el botón.
Space Desplaza hasta el destino indicado por el botón.

API

Inputs y Outputs corresponden al paquete instalado. Los tipos con nombre enlazan a sus definiciones. Cada Template disponible tiene un ejemplo con Demo y Código.

Inputs

Configura el componente con [propiedad]="valor". Tu aplicación proporciona estos valores; el componente no debe reemplazar el estado que le pasas.

Nombre
Tipo
Por defecto
Uso en el template
Descripción
behaviorNeuScrollTopBehavior'smooth'[behavior]Usa desplazamiento inmediato auto o animado smooth.
buttonAriaLabelstring'Scroll to top'[buttonAriaLabel]Etiqueta de botón de regreso al inicio. Tradúcela para tu aplicación.
iconstring'chevron-up'[icon]Clave de icono opcional; chevron-up predeterminado está integrado.
targetNeuScrollTopTarget'window'[target]Observa window o el padre desplazable inmediato.
thresholdnumber400[threshold]Distancia vertical en píxeles que debe superarse para mostrar el botón.

Templates

ng-content proyecta contenido dentro del componente. Los inputs TemplateRef reciben un template; las directivas ng-template identifican templates con un contexto tipado. Una directiva compartida en el entrypoint no es necesariamente un slot de este componente.

Nombre
Mecanismo
Contrato
NeuScrollTopIconDirectiveVer ejemplo Directiva pública de templateng-template[neuScrollTopIcon]

Cada ejemplo muestra un template diferente. Alterna entre Demo y Código para consultar su implementación, imports y estado.

Icono de regreso personalizado

NeuScrollTopIconDirective

Icono de regreso personalizado

Desplaza el panel hacia abajo para mostrar el botón de regreso. La opción window observa la página en su lugar.

Capítulo 1

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 2

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 3

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 4

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 5

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 6

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 7

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 8

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 9

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 10

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 11

Lee esta sección y continúa con el siguiente capítulo.

Capítulo 12

Lee esta sección y continúa con el siguiente capítulo.

Public Types

Abre un tipo para consultar su definición y los campos de sus interfaces.

Estilos y tokens

Personaliza los tokens públicos disponibles y comprueba ambos temas. Las ilustraciones y el estado de los ejemplos no son Inputs de Core.

Tokens específicos

Este componente utiliza tokens compartidos del tema en lugar de tokens específicos.

Tokens compartidos utilizados

Sobrescríbelos en un contenedor local para afectar a este ejemplo. Una modificación en :root afecta a los demás componentes que utilizan el mismo token.

Token
Efecto aquí
Otros efectos
Valor / alternativa
--neu-primary Color de marca en controles activos y énfasis Compartido con otros consumidores de Core; limita el cambio a un ámbito. #007aff
--neu-primary-fg Contenido dibujado sobre el fondo primario Compartido con otros consumidores de Core; limita el cambio a un ámbito. #ffffff
--neu-primary-solid Fondo de las acciones de marca sólidas Compartido con otros consumidores de Core; limita el cambio a un ámbito. #006ee6
--neu-primary-solid-fg Contenido de las acciones de marca sólidas Compartido con otros consumidores de Core; limita el cambio a un ámbito. #ffffff
--neu-focus-ring-color Valor del tema heredado que utiliza este componente Compartido con otros consumidores de Core; limita el cambio a un ámbito. var(--neu-focus-color)
--neu-radius-full Radio de esquina Compartido con otros consumidores de Core; limita el cambio a un ámbito. 9999px
--neu-shadow-lg Elevación de la superficie o capa Compartido con otros consumidores de Core; limita el cambio a un ámbito. 0 10px 30px rgba(15, 23, 42, 0.1), 0 4px 8px rgba(15, 23, 42, 0.04)
--neu-space-4 Separación entre contenido y controles Compartido con otros consumidores de Core; limita el cambio a un ámbito. 1rem