Los fragmentos de texto te permiten especificar un fragmento de texto en el fragmento de URL. Cuando se navega a una URL con un fragmento de texto de este tipo, el navegador puede destacarlo y llamar la atención del usuario.
Identificadores de fragmentos
Chrome 80 fue una versión importante. Contenía una serie de funciones muy esperadas, como módulos de ECMAScript en Web Workers, fusión nula, encadenamiento opcional y mucho más. Como de costumbre, el lanzamiento se anunció a través de una entrada de blog en el blog de Chromium. Puedes ver un extracto de la entrada de blog en la siguiente captura de pantalla.
id.Probablemente te estés preguntando qué significan todos los cuadros rojos. Son el resultado de ejecutar el siguiente fragmento en Herramientas para desarrolladores. Destaca todos los elementos que tienen un atributo id.
document.querySelectorAll('[id]').forEach((el) => {
el.style.border = 'solid 2px red';
});
Puedo colocar un vínculo directo a cualquier elemento destacado con un cuadro rojo gracias al
identificador de fragmento,
que luego uso en el hash de la
URL de la página. Supongamos que quiero crear un vínculo directo al cuadro Envíanos tus comentarios en nuestros foros de productos que se encuentra en el costado. Para ello, podría crear manualmente la URL https://blog.chromium.org/2019/12/chrome-80-content-indexing-es-modules.html#HTML1.
Como puedes ver en el panel Elementos de las Herramientas para desarrolladores, el elemento en cuestión tiene un atributo id con el valor HTML1.
id de un elemento.Si analizo esta URL con el constructor URL() de JavaScript, se revelan los diferentes componentes.
Observa la propiedad hash con el valor #HTML1.
new URL('https://blog.chromium.org/2019/12/chrome-80-content-indexing-es-modules.html#HTML1');
/* Creates a new `URL` object
URL {
hash: "#HTML1"
host: "blog.chromium.org"
hostname: "blog.chromium.org"
href: "https://blog.chromium.org/2019/12/chrome-80-content-indexing-es-modules.html#HTML1"
origin: "https://blog.chromium.org"
password: ""
pathname: "/2019/12/chrome-80-content-indexing-es-modules.html"
port: ""
protocol: "https:"
search: ""
searchParams: URLSearchParams {}
username: ""
}
*/
Sin embargo, el hecho de que haya tenido que abrir las Herramientas para desarrolladores para encontrar el id de un elemento dice mucho
sobre la probabilidad de que el autor de la entrada de blog haya querido vincular esta sección en particular de la página.
¿Qué sucede si quiero vincular a algo sin un id? Supongamos que quiero vincular al encabezado Módulos de ECMAScript en Web Workers. Como puedes ver en la siguiente captura de pantalla, el <h1> en cuestión no
tiene un atributo id, lo que significa que no hay forma de vincular a este encabezado. Este es el problema que
resuelven los fragmentos de texto.
id.Fragmentos de texto
La propuesta de fragmentos de texto agrega compatibilidad para especificar un fragmento de texto en el hash de la URL. Cuando se navega a una URL con un fragmento de texto de este tipo, el usuario-agente puede destacarlo y llamar la atención del usuario.
Compatibilidad del navegador
Por motivos de seguridad, la función requiere que los vínculos se abran en un contexto de noopener.
Por lo tanto, asegúrate de incluir rel="noopener" en el lenguaje de marcado de anclaje <a> o agrega noopener a la lista Window.open() de funciones de ventana.
start
En su forma más simple, la sintaxis de los fragmentos de texto es la siguiente: el símbolo de numeral # seguido de
:~:text= y, por último, start, que representa el texto
codificado por porcentaje
al que quiero vincular.
#:~:text=start
Por ejemplo, supongamos que quiero vincular al encabezado Módulos de ECMAScript en Web Workers en la entrada de blog que anuncia las funciones de Chrome 80. En este caso, la URL sería la siguiente:
El fragmento de texto se destaca de esta manera. Si haces clic en el vínculo en un navegador compatible, como Chrome, el fragmento de texto se destaca y se desplaza para que se vea:
start y end
Ahora, ¿qué pasa si quiero vincular a toda la sección titulada Módulos de ECMAScript en Web Workers, no solo su encabezado? Si se codifica con porcentaje todo el texto de la sección, la URL resultante sería demasiado larga.
Por suerte, existe una mejor manera. En lugar de todo el texto, puedo enmarcar una
parte específica del texto con la sintaxis start,end. Especifico un par de palabras codificadas por porcentaje al principio del fragmento de texto y un par de palabras codificadas por porcentaje al final del fragmento de texto, separadas por una coma.
Se ve de la siguiente manera:
Para start, tengo ECMAScript%20Modules%20in%20Web%20Workers, luego una coma, seguida
de ES%20Modules%20in%20Web%20Workers. como end. Cuando haces clic en un navegador compatible, como Chrome, se destaca toda la sección y se desplaza para que se vea:
Ahora, tal vez te preguntes por qué elegí start y end. En realidad, la URL un poco más corta
https://blog.chromium.org/2019/12/chrome-80-content-indexing-es-modules.html#:~:text=ECMAScript%20Modules,Web%20Workers.
con solo dos palabras a cada lado también habría funcionado. Compara start y end con los
valores anteriores.
Si voy un paso más allá y ahora uso solo una palabra para start y end, puedes
ver que tengo un problema. La URL
https://blog.chromium.org/2019/12/chrome-80-content-indexing-es-modules.html#:~:text=ECMAScript,Workers.
ahora es aún más corta, pero el fragmento de texto destacado ya no es el que se eligió originalmente. La
destacación se detiene en la primera aparición de la palabra Workers., lo que es correcto, pero no es lo que
quería destacar. El problema es que la sección elegida no se identifica de forma única con los
valores actuales de una palabra de start y end:
prefix- y -suffix
Una solución para obtener un vínculo único es usar valores lo suficientemente largos para start y end.
Sin embargo, en algunas situaciones, esto no es posible. Por cierto, ¿por qué elegí la entrada de blog de la versión de Chrome 80 como ejemplo? La respuesta es que, en esta versión, se introdujeron los fragmentos de texto:
Observa cómo en la captura de pantalla anterior aparece cuatro veces la palabra "text". La cuarta instancia está
escrita en una fuente de código verde. Si quisiera vincular a esta palabra en particular, establecería start en text. Como la palabra "text" es, bueno, solo una palabra, no puede haber un end. ¿Y ahora qué? La URL https://blog.chromium.org/2019/12/chrome-80-content-indexing-es-modules.html#:~:text=text coincide con la primera aparición de la palabra "Text" que ya está en el encabezado:
Por suerte, hay una solución. En casos como este, puedo especificar un prefix- y un -suffix. La
palabra antes de la fuente de código verde "text" es "the", y la palabra después es "parameter". Ninguna de las otras tres instancias de la palabra "text" tiene las mismas palabras circundantes. Con esta información, puedo modificar la URL anterior y agregar prefix- y -suffix. Al igual que los otros parámetros, estos también deben tener codificación porcentual y pueden contener más de una palabra.
https://blog.chromium.org/2019/12/chrome-80-content-indexing-es-modules.html#:~:text=the-,text,-parameter.
Para permitir que el analizador identifique claramente el prefix- y el -suffix, deben estar separados
del start y del end opcional con un guion -.
La sintaxis completa
A continuación, se muestra la sintaxis completa de los fragmentos de texto. (Los corchetes indican un parámetro opcional).
Los valores de todos los parámetros deben estar codificados en porcentaje. Esto es de gran importancia para los caracteres de guion -, signo de unión & y coma ,, de modo que no se interpreten como parte de la sintaxis de la directiva de texto.
#:~:text=[prefix-,]start[,end][,-suffix]
Cada uno de los elementos prefix-, start, end y -suffix solo puede coincidir con el texto dentro de un único elemento a nivel de bloque, pero los rangos completos de start,end pueden abarcar varios bloques. Por ejemplo,
:~:text=The quick,lazy dog no coincide en el siguiente ejemplo, ya que la cadena
inicial "The quick" no aparece dentro de un solo elemento de nivel de bloque sin interrupciones:
<div>
The
<div></div>
quick brown fox
</div>
<div>jumped over the lazy dog</div>
Sin embargo, sí coincide en este ejemplo:
<div>The quick brown fox</div>
<div>jumped over the lazy dog</div>
Cómo crear URLs de fragmentos de texto con una extensión de navegador
Crear URLs de fragmentos de texto de forma manual es tedioso, en especial cuando se trata de asegurarse de que sean únicas. Si realmente quieres hacerlo, la especificación tiene algunas sugerencias y enumera los pasos exactos para generar URLs de fragmentos de texto. Proporcionamos una extensión de navegador de código abierto llamada Link to Text Fragment que te permite vincular a cualquier texto seleccionándolo y, luego, haciendo clic en "Copiar vínculo al texto seleccionado" en el menú contextual. Esta extensión está disponible para los siguientes navegadores:
- Link to Text Fragment para Google Chrome
- Link to Text Fragment para Microsoft Edge
- Link to Text Fragment para Mozilla Firefox
- Vínculo al fragmento de texto para Apple Safari
Varios fragmentos de texto en una URL
Ten en cuenta que pueden aparecer varios fragmentos de texto en una URL. Los fragmentos de texto específicos deben estar separados por un carácter de signo de unión &. Este es un ejemplo de un vínculo con tres fragmentos de texto:
https://blog.chromium.org/2019/12/chrome-80-content-indexing-es-modules.html#:~:text=Text%20URL%20Fragments&text=text,-parameter&text=:~:text=On%20islands,%20birds%20can%20contribute%20as%20much%20as%2060%25%20of%20a%20cat's%20diet.
Cómo mezclar fragmentos de elementos y texto
Los fragmentos de elementos tradicionales se pueden combinar con fragmentos de texto. No hay ningún problema con tener ambos en la misma URL, por ejemplo, para proporcionar un resguardo significativo en caso de que cambie el texto original de la página, de modo que el fragmento de texto ya no coincida. La URL https://blog.chromium.org/2019/12/chrome-80-content-indexing-es-modules.html#HTML1:~:text=Give%20us%20feedback%20in%20our%20Product%20Forums. que vincula a la sección Envíanos tus comentarios en nuestros Foros de productos contiene un fragmento de elemento (HTML1) y un fragmento de texto (text=Give%20us%20feedback%20in%20our%20Product%20Forums.):
La directiva de fragmento
Hay un elemento de la sintaxis que aún no expliqué: la directiva de fragmento :~:. Para evitar
problemas de compatibilidad con los fragmentos de elementos de URL existentes, como se muestra, la
especificación de fragmentos de texto introduce la directiva
de fragmento. La directiva de fragmento es una parte del fragmento de URL delimitada por la secuencia de código
:~:. Está reservado para las instrucciones del usuario-agente, como text=, y se quita de la URL
durante la carga para que las secuencias de comandos del autor no puedan interactuar directamente con él. Las instrucciones del usuario-agente también se denominan directivas. Por lo tanto, en el caso concreto, text= se denomina directiva de texto.
Detección de atributos
Para detectar la compatibilidad, prueba la propiedad fragmentDirective de solo lectura en document. La directiva de fragmento es un mecanismo para que las URLs especifiquen instrucciones dirigidas al navegador en lugar del documento. Su objetivo es evitar la interacción directa con la secuencia de comandos del autor, de modo que se puedan agregar instrucciones futuras del usuario-agente sin temor a introducir cambios rotundos en el contenido existente. Un
ejemplo potencial de estas adiciones futuras podrían ser las sugerencias de traducción.
if ('fragmentDirective' in document) {
// Text Fragments is supported.
}
La detección de funciones está pensada principalmente para casos en los que los vínculos se generan de forma dinámica (por ejemplo, por motores de búsqueda) para evitar que se publiquen vínculos de fragmentos de texto en navegadores que no los admiten.
Cómo aplicar estilo a fragmentos de texto
De forma predeterminada, los navegadores aplican diseño a los fragmentos de texto de la misma manera que a
mark (por lo general,
negro sobre amarillo, los colores del sistema de CSS
para mark). La hoja de estilo del usuario-agente contiene CSS que se ve de la siguiente manera:
:root::target-text {
color: MarkText;
background: Mark;
}
Como puedes ver, el navegador expone un seudoselector ::target-text que puedes usar para personalizar el resaltado aplicado. Por ejemplo, puedes diseñar tus fragmentos de texto para que sean texto negro sobre un fondo rojo. Como siempre, asegúrate de
verificar el contraste de color
para que el estilo de anulación no cause problemas de accesibilidad y asegúrate de que el resaltado realmente
se destaque visualmente del resto del contenido.
:root::target-text {
color: black;
background-color: red;
}
Polyfill
La función de fragmentos de texto se puede rellenar hasta cierto punto. Proporcionamos un polyfill, que la extensión usa de forma interna, para los navegadores que no proporcionan compatibilidad integrada con los fragmentos de texto en los que la funcionalidad se implementa en JavaScript.
Generación de vínculos de fragmentos de texto programáticos
El polyfill contiene un archivo fragment-generation-utils.js que puedes importar y usar para generar vínculos de fragmentos de texto. Esto se describe en la muestra de código:
const { generateFragment } = await import('https://unpkg.com/text-fragments-polyfill/dist/fragment-generation-utils.js');
const result = generateFragment(window.getSelection());
if (result.status === 0) {
let url = `${location.origin}${location.pathname}${location.search}`;
const fragment = result.fragment;
const prefix = fragment.prefix ?
`${encodeURIComponent(fragment.prefix)}-,` :
'';
const suffix = fragment.suffix ?
`,-${encodeURIComponent(fragment.suffix)}` :
'';
const start = encodeURIComponent(fragment.textStart);
const end = fragment.textEnd ?
`,${encodeURIComponent(fragment.textEnd)}` :
'';
url += `#:~:text=${prefix}${start}${end}${suffix}`;
console.log(url);
}
Obtención de fragmentos de texto con fines de análisis
Muchos sitios usan el fragmento para el enrutamiento, por lo que los navegadores quitan los fragmentos de texto para no dañar esas páginas. Existe una necesidad reconocida de exponer vínculos de fragmentos de texto a páginas, por ejemplo, con fines de análisis, pero la solución propuesta aún no se implementó. Como solución alternativa por el momento, puedes usar el siguiente código para extraer información.
new URL(performance.getEntries().find(({ type }) => type === 'navigate').name).hash;
Seguridad
Las directivas de fragmentos de texto se invocan solo en navegaciones completas (que no son de la misma página) que son el resultado de una activación del usuario.
Además, las navegaciones que se originan en un origen diferente al de destino requieren que
la navegación se realice en un contexto
noopener, de modo
que se sepa que la página de destino está lo suficientemente aislada. Las directivas de fragmentos de texto solo se aplican al marco principal. Esto significa que no se busca texto dentro de los iframes y que la navegación por iframes no invoca un fragmento de texto.
Privacidad
Es importante que las implementaciones de la especificación de fragmentos de texto no filtren si se encontró un fragmento de texto en una página o no. Si bien los fragmentos de elementos están completamente bajo el control del autor de la página original, cualquier persona puede crear fragmentos de texto. ¿Recuerdas que en mi ejemplo no había forma de vincular al encabezado Módulos de ECMAScript en Web Workers, ya que el <h1> no tenía un id, pero cómo cualquier persona, incluyéndome, podría vincular a cualquier lugar creando cuidadosamente el fragmento de texto?
Imagina que tengo una red de publicidad maliciosa evil-ads.example.com. Imagina, además, que en uno de mis iframes de anuncios creé de forma dinámica un iframe oculto de origen cruzado para dating.example.com con una URL de fragmento de texto dating.example.com#:~:text=Log%20Out una vez que el usuario interactúa con el anuncio. Si se encuentra el texto "Cerrar sesión", sé que la víctima está conectada a dating.example.com, lo que podría usar para crear un perfil de usuario. Dado que una implementación ingenua de fragmentos de texto podría decidir que una coincidencia exitosa debería provocar un cambio de enfoque, en evil-ads.example.com podría escuchar el evento blur y, de esta manera, saber cuándo se produjo una coincidencia. En Chrome, implementamos los fragmentos de texto de tal manera que no se puede producir esa situación.
Otro ataque podría ser explotar el tráfico de red según la posición de desplazamiento. Supongamos que tengo acceso a
los registros de tráfico de red de mi víctima, como el administrador de la intranet de una empresa. Ahora imagina que
existiera un documento largo de recursos humanos Qué hacer si sufres de… y, luego, una lista de
afecciones como agotamiento, ansiedad, etc. Podría colocar un píxel de seguimiento junto a cada elemento de la
lista. Si luego determino que la carga del documento coincide temporalmente con la carga del píxel de seguimiento junto al elemento burn out, puedo determinar, como administrador de la intranet, que un empleado hizo clic en un vínculo de fragmento de texto con :~:text=burn%20out que el empleado puede haber asumido que era confidencial y no visible para nadie. Dado que este ejemplo es un tanto artificial y que su explotación requiere que se cumplan condiciones previas muy específicas, el equipo de seguridad de Chrome evaluó que el riesgo de implementar el desplazamiento en la navegación es manejable.
Otros usuarios-agentes pueden decidir mostrar un elemento de la IU de desplazamiento manual.
Para los sitios que quieran inhabilitar esta función, Chromium admite un valor de encabezado de política de documentos que pueden enviar para que los usuarios-agentes no procesen las URLs de fragmentos de texto.
Document-Policy: force-load-at-top
Inhabilitar fragmentos de texto
La forma más sencilla de inhabilitar la función es usar una extensión que pueda insertar encabezados de respuesta HTTP, por ejemplo, ModHeader (no es un producto de Google), para insertar un encabezado de respuesta (no de solicitud) de la siguiente manera:
Document-Policy: force-load-at-top
Otra forma más compleja de inhabilitar la función es usar el parámetro de configuración empresarial
ScrollToTextFragmentEnabled.
Para hacerlo en macOS, pega el siguiente comando en la terminal.
defaults write com.google.Chrome ScrollToTextFragmentEnabled -bool false
En Windows, sigue la documentación del sitio de asistencia de la Ayuda de Google Chrome Enterprise.
Fragmentos de texto en la búsqueda web
En algunas búsquedas, el motor de búsqueda de Google proporciona una respuesta rápida o un resumen con un fragmento de contenido de un sitio web relevante. Es más probable que estos fragmentos destacados aparezcan cuando una búsqueda se realiza en forma de pregunta. Cuando un usuario hace clic en un fragmento destacado, se lo dirige directamente al texto del fragmento destacado en la página web de origen. Esto funciona gracias a las URLs de fragmentos de texto creadas automáticamente.
Conclusión
La URL de fragmentos de texto es una función potente para vincular a texto arbitrario en páginas web. La comunidad académica puede usarlo para proporcionar vínculos de referencia o citas muy precisos. Los motores de búsqueda pueden usarlo para crear vínculos directos a los resultados de texto en las páginas. Los sitios de redes sociales pueden usarla para permitir que los usuarios compartan pasajes específicos de una página web en lugar de capturas de pantalla inaccesibles. Espero que comiences a usar las URLs de fragmentos de texto y que te resulten tan útiles como a mí. Asegúrate de instalar la extensión del navegador Link to Text Fragment.
Vínculos relacionados
- Borrador de especificaciones
- Revisión de TAG
- Entrada de Chrome Platform Status
- Error de seguimiento de Chrome
- Hilo de Intent to Ship
- Subproceso de WebKit-Dev
- Hilo de posición de los estándares de Mozilla
Agradecimientos
Nick Burris y David Bokan implementaron y especificaron los fragmentos de texto, con contribuciones de Grant Wang. Agradecemos a Joe Medley por la revisión exhaustiva de este documento.