Saltar al contenido

Code

Bloque de código con etiqueta de lenguaje y botón de copiar. El texto es el contenido del bloque. No aplica syntax highlighting por sí solo: mantiene el paquete liviano y sin dependencias.

Auxiliares · TaishoDS Core, en HTML plano.

Ejemplos

Un ejemplo por caso, funcionando. Cada ejemplo es el HTML de su vista previa: se copia tal cual y, con el CSS y el JS del Core cargados, se ve y funciona igual.

Comando de instalación

bash
npm i -D @taishods/core
html

Alternativas con pestañas

npm i -D @taishods/core
pnpm add -D @taishods/core
html

Cuándo usarlo

  • Se muestra un fragmento que el lector va a copiar y pegar.
  • Es un bloque de varias líneas: un comando, un archivo de config, un snippet.
  • Conviene decir en qué lenguaje está.
  • Hay alternativas del mismo código (CDN o npm): las pestañas van en el encabezado del bloque, no encima.

Cuándo no

  • Es un nombre de prop o de archivo dentro de una frase → inline-code.
  • Es una tecla o un atajo → kbd.

Cómo usarlo

  • El bloque debe poder copiarse: es la razón por la que existe el botón.
  • Se muestra el fragmento mínimo que se entiende solo.

Cómo no usarlo

  • No se pegan archivos enteros cuando alcanza con diez líneas.
  • No se usa para resaltar texto que no es código.

Relacionados

InlineCodeKbd

TaishoDS Core

Necesita el JS del Core: lo engancha por atributos data-ts-*.

El botón de copiar confirma la acción con un aviso breve, y eso lo hace el Core.

El Core lo engancha por estos atributos. Van en el marcado; no hace falta inicializar nada.

  • data-ts-copied-icon
  • data-ts-copied-label
  • data-ts-copy
  • data-ts-tabs
  • data-ts-tabs-panel
  • data-ts-tabs-tab
  • data-ts-value

Qué hace: Copia el texto al portapapeles y muestra el acuse durante 2 segundos: el nombre «Copiado» (data-ts-copied-label) y el ✓ (<template data-ts-copied-icon>). Después vuelve al reposo; pulsar de nuevo reinicia los 2 segundos.

Sin build, desde el CDN: taisho.code.css, además de taisho.base.css. También se carga:

  • taisho.button.css
  • taisho.icon.css
  • taisho.spinner.css

Para el funcionamiento general del Core, ver Comportamiento.

Accesibilidad

  • El bloque scrollable recibe tabindex="0"; el botón de copiar expone aria-label y confirma la acción por texto, no sólo por color: al copiar su nombre accesible pasa de «Copiar código» a «Copiado» (y el ícono a ✓) durante 2 s, así que un lector de pantalla anuncia el éxito.
  • Con pestañas en el encabezado, el contenido pasa a role="tabpanel" (sigue en el orden de tabulación) y se nombra por la pestaña activa; cada pestaña apunta al panel con aria-controls y las pestañas siguen el patrón de pestañas: flechas, Inicio y Fin cambian de pestaña.

Teclado

Además de lo que ya hace el navegador (Tab mueve el foco, Enter activa un botón).

Tecla Qué hace
→←/Home/EndSólo con pestañas en el encabezado: cambian a la pestaña siguiente, a la anterior, a la primera y a la última, igual que en Tabs.

Verificación

Qué se probó de verdad. Lo que no se probó lo dice: preferimos un «sin verificar» a una afirmación de más.

  • axe WCAG 2.2 A + AA en navegador real, en tema claro y oscuro, antes de cada versión.
  • teclado Mapa de teclas documentado arriba, contrastado contra el componente.
  • lector de pantalla Sin verificar con lector de pantalla. Conviene probarlo en la combinación de componentes propia, no sólo aquí, donde cada uno aparece solo y en su estado feliz.