CKTIS / JavaScript
Escape de texto em HTML
Ao gerar HTML, codifica o texto simples de acordo com a posição em que o vais inserir. Se escreveres diretamente num elemento comum do DOM, usa `textContent` com a cadeia original.
Versão: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxe
const escapeHtmlText = (text) => text.replaceAll('&', '&').replaceAll('<', '<').replaceAll('>', '>');
// Use escaped text only in the ordinary text position of trusted HTML markup.
const markup = `<p>${escapeHtmlText(text)}</p>`;
// If writing directly to an ordinary DOM element, use the original string instead.
element.textContent = text;O escape em contexto de texto HTML é a codificação de saída para texto simples inserido no código-fonte HTML, por exemplo no conteúdo de um elemento p. Um < não codificado pode iniciar uma etiqueta e & pode iniciar uma referência de caráter. O analisador converte < num < literal no texto, sem interpretar o caráter descodificado como o início de uma etiqueta.
Ao encadear chamadas a replaceAll, substitui & por & antes de substituir < por <, para não codificares os & introduzidos pelas substituições posteriores. O exemplo também substitui > por >, mas aqui é opcional; também não é preciso codificar as aspas neste contexto. Codifica o texto original uma única vez, ao inseri-lo, e não o faças manualmente se o motor de modelos já o fizer.
Para definir o texto de um elemento comum do DOM, atribui a cadeia original a textContent. Não uses innerHTML para esse efeito, pois interpreta a marcação. Não reutilizes esta função para atributos, URL, JavaScript ou CSS: esses contextos têm regras diferentes. Se precisares de preservar parte da marcação de HTML não fiável, sanitiza o HTML em vez de o codificares como texto.
Exemplos
function escapeHtmlText(text) {
return text.replaceAll('&', '&')
.replaceAll('<', '<')
.replaceAll('>', '>');
}
const text = 'A & B <em>demo</em> <';
console.log(`<p>${escapeHtmlText(text)}</p>`);Resultado
<p>A & B <em>demo</em> &lt;</p>
A consola apresenta o código-fonte HTML, não o texto apresentado na página. A análise do código produz um parágrafo sem elementos `em`, e o `<` final mantém-se como texto literal.
Lições relacionadas
- JavaScript · Lição 28 · Avançado · Versão: 4