Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 1.31 KB

README.md

File metadata and controls

53 lines (38 loc) · 1.31 KB

PortalVue

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

PortalVue Logo

Buy Me a Coffee at ko-fi.com

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

Looking for the version for Vue 2.*? Docs for PortalVue 2.*, compatible with Vue 2, are here

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

v3 does not yet have a nuxt module integration. PRs welcome.