@intheroomglobal/embed
v1.5.2
Published
In The Room experience embed
Downloads
145
Readme
Speakeasy Embed
An easy to use script to embed Speakeasy experiences within a website.
Usage
Paste the following snippet into your page. Replace the link with a link to your own experience.
<convo>
<link href="https://unpkg.com/@intheroomglobal/embed/embed.min.css" rel="stylesheet" />
<a href="https://lite.intheroom.global/experience/{EXPERIENCE_ID}?lite-only=1" title="View accessible version of My Awesome Experience"><span>My Awesome Experience</span></a>
<script src="https://unpkg.com/@intheroomglobal/embed/embed.min.js"></script>
</convo>
To maximise your experience, add data-maximized
attribute to the convo
element.
To change the aspect ratio of the embed, add data-aspect-ratio
attribute to the convo
element, with a valid aspect ratio as the value, e.g. <convo data-aspect-ratio="16:9">...</convo>
.
To inline an experience, so when interacted with it does not go full screen, add data-inline
attribute to the convo
element. Inlined experiences cannot be maximized.