The Highreel on your page, or over it
highreel-player plays the story where you put it, waiting on its cover for a tap. Highreel.open(link) plays it over the whole page, from your own button.
On the page
<script src="https://highreel.app/embed/v1.js" async></script>
<highreel-player link="EACH_PERSONS_LINK"></highreel-player>The player takes a phone's shape, 9:16, the full width of its container up to 420 pixels, with rounded corners. It waits on the person's cover until they tap it: a frame loads whether anyone is looking or not, so the story, its music and the open that Analytics counts all start with that tap, not when the page loads.
Until the story is ready it shows a soft grey box the size it will be, so nothing on your page jumps when it arrives. For a wrong link, or a Highreel that isn't published, it hides; it also hides if nothing has loaded after 15 seconds.
Layouts
| layout | What it looks like |
|---|---|
| phone (default) | 9:16, up to 420 pixels wide. Fits beside other things on the page. |
| wide | 16:9 across its container, with the layout people see on a computer: the look's backdrop, arrows and Pause. Narrower than 640 pixels it takes a phone's shape again. |
<highreel-player link="EACH_PERSONS_LINK" layout="wide"></highreel-player>Over the page
Highreel.open(link) opens the person's Highreel over your whole page and plays it at once, since they just asked for it. Use it from your own button, a menu item or a notification:
<script src="https://highreel.app/embed/v1.js" async></script>
<button type="button" onclick="Highreel.open(this.dataset.link)"
data-link="EACH_PERSONS_LINK">See your year</button>- On a phone it fills the screen, like opening the link; on a computer the Highreel's own computer layout fills it.
- A close button sits at the top right, and Escape closes it too, from your page or from inside the story.
- While it's open your page can't scroll and is out of reach of the keyboard and screen readers; when it closes, focus goes back to whatever opened it.
- The banner uses the same overlay when it's pressed.
Highreel.open only takes a person's link, like the elements: anything else logs a warning and opens nothing.
Events
| Event | Where | When |
|---|---|---|
| highreel:ready | the player | The story has loaded and is showing its cover. |
| highreel:missing | the player | There's no such Highreel: the element hides. |
| highreel:open | the document | Highreel.open put the story over the page. |
| highreel:close | the document | The story over the page was closed. |
None of them carries anything about the person. Opens from your site show in the business's Analytics as "On your website".
Your Content Security Policy
If your site sends a Content-Security-Policy header, allow Highreel's script and its frames:
script-src https://highreel.app
frame-src https://highreel.appAdd them to the lists you already have; nothing else is needed. The script adds no inline styles and writes no HTML from strings, so a policy without unsafe-inline, or with Trusted Types, takes it as it is. The frames send no referrer, so your page's address never reaches Highreel.
Without the script
A plain iframe plays the Highreel too. Give it the permissions the script would: autoplay lets a song play once the person taps, web-share and clipboard-write make Share and Copy link work, and fullscreen lets it fill the screen. Don't sandbox it, or saving a slide as an image stops working.
<iframe src="https://highreel.app/r/TOKEN?via=site&wait=1"
title="Your Highreel"
allow="autoplay; fullscreen; web-share; clipboard-write"
referrerpolicy="no-referrer"
style="width: 100%; max-width: 420px; aspect-ratio: 9 / 16; border: 0; border-radius: 22px"></iframe>TOKEN is the 12 characters after /r/ in the person's link. via=site counts the open as "On your website"; wait=1 holds the cover for a tap. Links inside the story open in a new tab, never inside your frame.
Questions
Does the music play inside the frame?
Yes. A Highreel with a song starts it with the person's tap, as it does on its own page; phones only allow sound after a tap. The frame needs autoplay in its allow list, which the script sets for you.
Can I start the player without a tap?
The player always waits for a tap, so a story below the fold isn't over before anyone scrolls to it. Highreel.open plays at once, because the person just asked for it.
Do saving and sharing work inside my site?
Yes. Save image and Share work in the frame, as long as it isn't sandboxed and has web-share and clipboard-write in its allow list.