इस प्रोजेक्ट के बारे में
# vue-dompurify-html
`vue-dompurify-html` एक Vue.js निर्देश है जो अंतर्निहित `v-html` निर्देश का सुरक्षित विकल्प प्रदान करता है। यह HTML सामग्री को रेंडर करने से पहले साफ करने के लिए DOMPurify लाइब्रेरी का उपयोग करता है, जिससे क्रॉस-साइट स्क्रिप्टिंग (XSS) कमजोरियों को रोकने में मदद मिलती है।
## विशेषताएँ
- **सुरक्षित HTML रेंडरिंग**: DOM में डालने से पहले DOMPurify के साथ HTML स्ट्रिंग्स को स्वचालित रूप से साफ करता है।
- **सीधा प्रतिस्थापन**: Vue 2 और Vue 3 प्रोजेक्ट्स में `v-html` के सीधे विकल्प के रूप में उपयोग किया जा सकता है।
- **कॉन्फ़िगर करने योग्य**: सैनिटाइज़ेशन नियमों को अनुकूलित करने के लिए कस्टम DOMPurify कॉन्फ़िगरेशन विकल्पों का समर्थन करता है।
- **TypeScript समर्थन**: बेहतर डेवलपर अनुभव के लिए TypeScript परिभाषाएँ शामिल हैं।
## इंस्टॉलेशन
npm या yarn के माध्यम से पैकेज इंस्टॉल करें:
```bash
npm install vue-dompurify-html
# या
yarn add vue-dompurify-html
```
## उपयोग
### Vue 3
अपनी एप्लिकेशन एंट्री फ़ाइल में निर्देश को ग्लोबली रजिस्टर करें:
```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')
```
फिर इसे अपने टेम्पलेट्स में उपयोग करें:
```html
<template>
<div v-dompurify-html="htmlContent"></div>
</template>
```
### Vue 2
Vue 2 के लिए, पैकेज को इम्पोर्ट करें और इसे प्लगइन के रूप में रजिस्टर करें:
```javascript
import Vue from 'vue'
import VueDOMPurifyHTML from 'vue-dompurify-html'
Vue.use(VueDOMPurifyHTML)
```
## कॉन्फ़िगरेशन
आप DOMPurify कॉन्फ़िगरेशन विकल्पों को सीधे निर्देश में पास कर सकते हैं:
```html
<div v-dompurify-html="{ content: htmlContent, options: { USE_PROFILES: { html: true } } }"></div>
```
वैकल्पिक रूप से, आप प्लगइन को रजिस्टर करते समय ग्लोबल डिफ़ॉल्ट सेट कर सकते हैं:
```javascript
app.use(VueDOMPurifyHTML, {
default: {
USE_PROFILES: { html: true }
}
})
```
## लाइसेंस
यह प्रोजेक्ट MIT लाइसेंस के अंतर्गत लाइसेंस प्राप्त है। विवरण के लिए [LICENSE](LICENSE) फ़ाइल देखें।
## योगदान
योगदान का स्वागत है! कृपया पुल रिक्वेस्ट सबमिट करने से पहले [योगदान दिशानिर्देश](CONTRIBUTING.md) पढ़ें।
## आभार
यह पैकेज Vue एप्लिकेशन्स में HTML रेंडर करने के लिए एक सुरक्षित तरीके की आवश्यकता से प्रेरित है और DOMPurify टीम के उत्कृष्ट कार्य पर आधारित है।
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.