Saltar al contenido
npm ↗ GitHub ↗

Documentación

07/Estructura

Sidebar de documentación

Navegación lateral con grupos, enlace activo, selector de versión y tabla de contenidos que sigue el scroll.

Tabla de contenidos

Con data-cb-scrollspy el enlace de la sección visible se marca solo. Es la columna de la derecha en esta página.

HTML
<nav class="cb-toc" aria-label="En esta página" data-cb-scrollspy>
  <p class="cb-toc__title">En esta página</p>
  <a class="cb-toc__link" href="#sidebar">Sidebar</a>
  <a class="cb-toc__link" href="#tabla-de-contenidos">Tabla de contenidos</a>
</nav>

Clases y modificadores

ClaseDescripción
.cb-sidenavColumna de grupos. --sticky la fija al hacer scroll.
.cb-sidenav__versionFila del selector de versión.
.cb-sidenav__group, .cb-sidenav__title, .cb-sidenav__listGrupo, título y lista.
.cb-sidenav__linkEnlace con línea izquierda; aria-current="page" lo marca.
.cb-sidenav__badgeEtiqueta pequeña en color de acento.
.cb-toc, .cb-toc__linkTabla de contenidos de la página.

Atributos data-cb-*

AtributoDescripción
data-cb-scrollspyMarca el enlace cuya sección está en pantalla.
data-cb-version-selectAl cambiar el select navega a la URL del value.

JavaScript

EventoCuándo se dispara
cb:changeEn el nav con scrollspy cuando cambia la sección activa (detail.id).

Accesibilidad

  • La página actual usa aria-current="page"; la sección activa usa aria-current="true".
  • El select de versión necesita una etiqueta, aunque sea cb-sr-only.