Sobre el proyecto
# vue-dompurify-html
`vue-dompurify-html` es una directiva de Vue.js que ofrece una alternativa segura a la directiva integrada `v-html`. Utiliza la biblioteca DOMPurify para sanitizar el contenido HTML antes de su renderizado, ayudando a prevenir vulnerabilidades de cross-site scripting (XSS).
## Características
- **Renderizado de HTML seguro**: Limpia automáticamente las cadenas HTML con DOMPurify antes de insertarlas en el DOM.
- **Reemplazo directo**: Puede usarse como sustituto directo de `v-html` en proyectos de Vue 2 y Vue 3.
- **Configurable**: Admite opciones personalizadas de configuración de DOMPurify para adaptar las reglas de sanitización.
- **Soporte TypeScript**: Incluye definiciones TypeScript para mejorar la experiencia del desarrollador.
## Instalación
Instale el paquete mediante npm o yarn:
```bash
npm install vue-dompurify-html
# or
yarn add vue-dompurify-html
```
## Uso
### Vue 3
Registre la directiva globalmente en el archivo de entrada de su aplicación:
```javascript
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')
```
Luego úsela en sus plantillas:
```html
<template>
<div v-dompurify-html="htmlContent"></div>
</template>
```
### Vue 2
Para Vue 2, importe el paquete y regístrelo como plugin:
```javascript
import Vue from 'vue'
import VueDOMPurifyHTML from 'vue-dompurify-html'
Vue.use(VueDOMPurifyHTML)
```
## Configuración
Puede pasar opciones de configuración de DOMPurify directamente a la directiva:
```html
<div v-dompurify-html="{ content: htmlContent, options: { USE_PROFILES: { html: true } } }"></div>
```
Alternativamente, puede establecer valores predeterminados globales al registrar el plugin:
```javascript
app.use(VueDOMPurifyHTML, {
default: {
USE_PROFILES: { html: true }
}
})
```
## Licencia
Este proyecto está licenciado bajo la MIT License. Consulte el archivo [LICENSE](LICENSE) para más detalles.
## Contribución
¡Las contribuciones son bienvenidas! Por favor lea las [pautas de contribución](CONTRIBUTING.md) antes de enviar un pull request.
## Agradecimientos
Este paquete se inspira en la necesidad de una forma más segura de renderizar HTML en aplicaciones Vue y se basa en el excelente trabajo del equipo de DOMPurify.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.