/portal-vue

A Portal Component for Vuejs, for rendering DOM outside of a component, anywhere in the document.

Primary LanguageJavaScriptMIT LicenseMIT

PortalVue

A Portal Component for Vuejs, to render DOM outside of a component, anywhere in the document.

BETA For upcoming v2.0

This is the current stable develop branch with v1.5. We are about to release a new major version, which you can check out now, as it's in beta! See the next branch or visit https://portal-vue-next-preview.netlify.com/

PortalVue Logo

Install with npm install portal-vue

For more detailed documentation and additional Information, please visit the docs

Installation

npm i portal-vue

# or

yarn add portal-vue
import PortalVue from 'portal-vue'
Vue.use(PortalVue)

Usage

<portal to="destination">
  <p>This slot content will be rendered wherever the <portal-target> with name 'destination'
    is  located.</p>
</portal>

<portal-target name="destination">
  <!--
  This component can be located anywhere in your App.
  The slot content of the above portal component will be rendered here.
  -->
</portal-target>

Nuxt module

Add portal-vue/nuxt to modules section of nuxt.config.js

{
  modules: ['portal-vue/nuxt']
}