Getting Started with Portal-Vue

What is PortalVue?

PortalVue is a set of two components that allow you to render a component's template (or a part of it) anywhere in the document - even outside the part controlled by your Vue App!

Alternative: VueSimplePortal

PortalVue offers quite a lot of functionality allowing for some creative use cases. However, for the most common use case (render .e.g a modal at the end of <body>), most of that isn't required.

So if you are just looking for a solution to that one problem, have a look at my new second portal project, @linusborg/vue-simple-portal

Setup

Install Package:

npm install --save portal-vue

# or with yarn
yarn add portal-vue
1
2
3
4

Add it to your application:

import PortalVue from 'portal-vue'

Vue.use(PortalVue)
1
2
3

For more detailed installation instructions, additional options and installation via CDN, see the Installation section of the documentation.

Usage

About the examples

The following examples contain live demos. When looking at them, keep in mind that for demo purposes, we move content around within one component, however in reality the <portal-target> can be positioned anywhere in your App.

Also, the code of the Examples uses the Single-File-Component Format (".vue" files). If you're not familiar with this, check out the official docs here.

The Basics

<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 anwhere in your App.
  The slot content of the above portal component will be rendered here.
  -->
</portal-target>
1
2
3
4
5
6
7
8
9
10
11
12
13
SOURCE

The content below this paragraph is rendered in the right/bottom (red) container by PortalVue

TARGET

Enabling/Disabling the Portal

<portal to="destination" :disabled="true">
  <p>
    This slot content will be rendered right here as long as the `disabled` prop
    evaluates to `true`,<br />
    and will be rendered at the defined destination as when it is set to `false`
    (which is the default).
  </p>
</portal>
1
2
3
4
5
6
7
8

Conditional rendering with v-if

<portal to="destination" v-if="usePortal">
  <ul>
    <li>
      When 'usePortal' evaluates to 'true', the portal's slot content will be
      rendered at the destination.
    </li>
    <li>
      When it evaluates to 'false', the content will be removed from the
      destination
    </li>
  </ul>
</portal>
1
2
3
4
5
6
7
8
9
10
11
12

Multiple Portals, one Target

The <portal-target> component has a multiple mode, which allows to render content from multiple <portal> components at the same time.

The order the content is rendered in can be adjusted through the order prop on the <portal> components:

<portal to="destination" :order="2">
  <p>some content</p>
</portal>
<portal to="destination" :order="1">
  <p>some other content</p>
</portal>

<portal-target name="destination" multiple />
1
2
3
4
5
6
7
8

Result

<div class="vue-portal-target">
  <p>some other content</p>
  <p>some content</p>
</div>
1
2
3
4

Live Example

Use Cases

Positioning Modals & Overlays

In older browsers, position: fixed works unreliably when the element with that property is nested in a node tree that has other position values.

But we normally need it to render components like modals, dialogs, notifications, snackbars and similar UI elements in a fixed position.

Also, z-indices can be a problem when trying to render things on top of each other somehwere in the DOM.

With PortalVue, you can render your modal/overlay/dropdown component to a <portal-target> that you can position as the very last in the page's body, making styling and positioning much easier and less error-prone.

Now you can position your components with position: absolute instead

<body>
  <div id="app" style="position: relative;">
    <div>
      <portal to="notification-outlet">
        <notification style="position: absolute; top: 20px; right: 20px;">
          This overlay can be positioned absolutely very easily.
        </notification>
      </portal>
    </div>
    <!-- rest of your app -->
  </div>

  <portal-target name="notification-outlet"></portal-target>
</body>
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Rendering dynamic widgets

If you use Vue for small bits and pieces on your website, but want to render something in a location at the other end of the page, PortalVue got you covered.

Tell us about your use case!

We're sure you will find use cases beyond the ones we mentioned. If you do, please let us know by opening an issue on Github and we will include it here.