# Wormhole Object

The Wormhole is not a component, it's an object that connects the <Portal>s to their <PortalTarget>s.

Usually, you will never need to use this object, but you can use this object to programmatically send content to a <PortalTarget>, check whether a target exists, and other stuff.

# Methods

# open()

The open method accepts one argument, an object with the following properties:

Wormhole.open({to, from, passengers})

Even if you use this method programmatically and there is not source <Portal>, you still have to provide from - every content sent through the wormhole needs a source.

Examples:

import { Wormhole } from 'portal-vue'

methods: {
  sendToPortalTarget() {
    const passengers = [this.$createElement('p', 'This will be displayed in the Target!')]
    Wormhole.open({
      to: 'destination',
      from: 'my-portal',
      passengers,
    })
  }
}

This is the programmatic equivalent of the following:

<portal to="destination" name="my-portal">
  <p>This will be displayed in the Target!</p>
</portal>

# close()

As the name suggests, this is the counterpart to open(). It's used to remove content from a <PortalTarget>.

It accepts two arguments, an object and an optional force flag.

Wormhole.close({ to, from }, force = false)

Why do you have to provide the from name (or use force)?

The close() method is also used by <Portal> components to remove the content from a <PortalTarget> when the <Portal> is being destroyed. But that should only remove the content if it still actually is the content from that <Portal>. If another <Portal> have overridden our content before the first one gets destroyed, we have to keep the content instead of removing it.

We can override this behaviour with the force argument.

Example:

methods: {
  clearPortalTarget() {
    Wormhole.close({
      to: 'destination',
      from: 'my-programmatic-portal'
    })

    // Variation with `force`
    Wormhole.close({
      to: 'destination',
    }, true)

    // if the `from` doesn't match the source the content
    // was sent from, close() will fail silently
    // IF the current content is from 'my-other-portal', then:
    Wormhole.close({
      to: 'destination',
      from: 'my-portal',
    })
    // => this will not remove any content, it will stay in the PortalTarget
  }
}

# hasSource() 2.0.0+

Wormhole.hasSource(from)

Returns true if there's a <Portal> with the given name active.

Example:

Wormhole.hasSource('origin')
// => true/false

# hasTarget() changed in 2.0.0

Wormhole.hasTarget(to)

Returns true if there's a <PortalTarget> with the given name active.

Example:

Wormhole.hasTarget('destination')
// => true/false

# hasContentFor() changed in 2.1.0

Wormhole.hasContentFor(to)

Returns true if there's a <PortalTarget> with a name of to and it currently has content to show.

Example:

Wormhole.hasContentFor('destination')
// => true/false