Sobre o projeto
# vue-dompurify-html
`vue-dompurify-html` é uma diretiva do Vue.js que oferece uma alternativa segura à diretiva integrada `v-html`. Ela usa a biblioteca DOMPurify para sanitizar o conteúdo HTML antes de ser renderizado, ajudando a evitar vulnerabilidades de cross-site scripting (XSS).
## Funcionalidades
- **Renderização segura de HTML**: limpa automaticamente strings HTML com DOMPurify antes da inserção no DOM.
- **Substituição pronta para uso**: pode ser usada como substituta direta da `v-html` em projetos Vue 2 e Vue 3.
- **Configurável**: aceita opções personalizadas de configuração do DOMPurify para ajustar as regras de sanitização.
- **Suporte a TypeScript**: inclui definições TypeScript para uma melhor experiência do desenvolvedor.
## Instalação
Instale o pacote via npm ou yarn:
npm install vue-dompurify-html
# ou
yarn add vue-dompurify-html
## Uso
### Vue 3
Registre a diretiva globalmente no arquivo de entrada da aplicação:
import { createApp } from 'vue'
import App from './App.vue'
import VueDOMPurifyHTML from 'vue-dompurify-html'
const app = createApp(App)
app.use(VueDOMPurifyHTML)
app.mount('#app')
Em seguida, use-a nos seus modelos:
template
div v-dompurify-html="htmlContent"
### Vue 2
No Vue 2, importe o pacote e registre-o como um plugin:
import Vue from 'vue'
import VueDOMPurifyHTML from 'vue-dompurify-html'
Vue.use(VueDOMPurifyHTML)
## Configuração
Você pode passar opções de configuração do DOMPurify diretamente para a diretiva:
div v-dompurify-html="{ content: htmlContent, options: { USE_PROFILES: { html: true } } }"
Como alternativa, você pode definir padrões globais ao registrar o plugin:
app.use(VueDOMPurifyHTML, {
default: {
USE_PROFILES: { html: true }
}
})
## Licença
Este projeto é licenciado sob a Licença MIT. Consulte o arquivo [LICENSE](LICENSE) para obter detalhes.
## Contribuindo
Contribuições são bem-vindas! Leia as [diretrizes de contribuição](CONTRIBUTING.md) antes de enviar um pull request.
## Agradecimentos
Este pacote é inspirado pela necessidade de uma forma mais segura de renderizar HTML em aplicações Vue e se baseia no excelente trabalho da equipe do DOMPurify.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.