Skip to content

Vannsl/vue-3-sanitize

Repository files navigation

vue-3-sanitize

HTML sanitizer for Vue.js 3 apps.

vue-next npm

You want to use v-html? You might need to sanitize the code. This plugin is built for Vue 3 apps. It is built upon on sanitize-html.

Install

yarn add vue-3-sanitize
# or
npm install --save vue-3-sanitize

Usage

Registration

Register the plugin

import Vue3Sanitize from "vue-3-sanitize";

// const app = createApp(YourVue3App);
app.use(Vue3Sanitize);

To override the default options of sanitize-html, pass them as an argument. It is not supported to merge them.

const overridenOptions = {
    allowedTags: ['img']
};
app.use(Vue3Sanitize, overridenOptions);

Template

<template>
  <p v-html="$sanitize(dirty)" />
</template>

Issues

If you find any bugs, please open an issue.

Contributing

  1. Fork it
  2. Create your feature branch: git checkout -b feature-or-bugfix
  3. Add your changes: git add files
  4. Commit your changes: git commit -m "Add some feature"
  5. Push to the branch: git push origin feature-or-bugfix
  6. Submit a forked pull request

License

See License File.