link

NOTE: This version of the documentation tracks unstable development happening on A-Frame’s master branch. If you wish to try it out, grab the unstable build. Otherwise, head to the documentation for the current 0.7.0 version

The link component connects between experiences and allows for traversing between VR web pages. When activated via an event, the link component sends the user to a different page, just like a normal web page redirect. To maintain VR across pages, the following conditions must apply:

  • The browser is up-to-date with the WebVR specification and implements the vrdisplayactivate event.
  • The destination web page listens to the window [vrdisplayactivate] event and enters VR.

A link in VR can be anything such as grabbing onto an object, placing something on our head, clicking something, even eating something! We provide a default implementation of links as a portal or window, using a 360° image thumbnail to preview the destination.

The UX of link traversal will continue to refine as we iterate and experiment, both in content and from the browser.

Controls

The default UX of the link component as a portal can be interacted with using a cursor or controllers. This is not provided directly in the A-Frame core, but there is a link-controls component in the A-Frame examples. This component shows tooltips and provides button mappings for peeking and entering portals.

Example

<a-scene>
<a-assets>
<img id="homeThumbnail" src="home.jpg">
</a-assets>
<a-entity link="href: index.html; title: My Homepage; image: #homeThumbnail"></a-entity>
</a-scene>

We also provide a link primitive with a different syntax:

<a-link href="index.html" title="My Homepage" image="#homeThumbnail"></a-link>

Properties

Property Description Default Value
color Background color of the portal. white
highlighted Boolean to toggle link highlight color. false
highlightedColor Border color when highlighted. ‘#24CAFF’
href Destiantion URL where the link points to. ‘’
on Event to listen to that triggers link traversal. ‘’
image 360° image used as scene preview in the portal. Can be a selector to an <img> element or a URL. ‘’
peekMode Whether the 360° image is fully expanded for preview. false
title Text displayed on the link. The href or page URL is used if not defined. ‘’
visualAspectEnabled Whether to enable the default visual appearance of a portal. Set to false if we want to implement our own pattern or form of link traversal. true

Methods

Sends the user to the page specified by the href property:

document.querySelector('a-link').navigate('destination.html');