@onirix/embed-sdk

Package Overview

Dependencies

Maintainers

Versions

Alerts

File Explorer

Advanced tools

License

Install Socket

Detect and block malicious and high-risk dependencies

Install

@onirix/embed-sdk

Onirix helper library for iframe event communication.

latest

npm

Version: 1.18.1

Version published: 6 months ago

Weekly downloads: 82

Maintainers: 3

Weekly downloads

Created: 4 years ago

Source

Onirix Embed SDK

Take control of your Onirix augmented reality experiences. Responds to user interaction and acts on the 3D content of the scene.

This library acts as a wrapper of window.postMessage for simplifying communication with Onirix AR experiences. Not only can you use it in the online code editor of Onirix Studio projects, you can also connect to your scene loaded in an iFrame.

Take Onirix experiences to the next level.

Full documentation available at Onirix Docs.

Install

npm install @onirix/embed-sdk

Or include the dependency within the HTML head tag:

<head>
    <script src="https://cdn.jsdelivr.net/npm/@onirix/embed-sdk@1.18.1/+esm">
</head>

Or as ESM modules:

import OnirixEmbedSDK from "https://cdn.jsdelivr.net/npm/@onirix/embed-sdk@1.18.1/+esm";

Usage

Just create an instance of our EmbedSDK and execute the connect method. From that moment on you will be able to subscribe to the events that occur in the scene and you will be able to execute actions on the elements of the experience.

import OnirixEmbedSDK from "https://cdn.jsdelivr.net/npm/@onirix/embed-sdk@1.18.1/+esm";
const embedSDK = new OnirixEmbedSDK();
await embedSDK.connect();

embedSDK.subscribe(OnirixEmbedSDK.Events.ELEMENT_CLICK, (params) => {
    console.log('somebody clicks me!', params);
});

embedSDK.enable(elementOid);

If you have embedded an Onirix Studio experience in your application through an iframe, you must pass the Html element of the iFrame to the EmbedSDK constructor.

import OnirixEmbedSDK from "https://cdn.jsdelivr.net/npm/@onirix/embed-sdk@1.18.1/+esm";
const iframeElement = document.getElementById("<iframe_element_id>");
const embedSDK = new OnirixEmbedSDK(iframeElement);
await embedSDK.connect();

Make sure that the iFrame is already loaded before instantiating the EmbedSDK.

See the complete list of events and actions in our documentation.

Author

👤 Onirix

Website: www.onirix.com
Twitter: @onirix
Github: @onirix-ar
LinkedIn: @onirixar

Keywords

Augmented reality

WebAR

FAQs

What is @onirix/embed-sdk?

Is @onirix/embed-sdk popular?

Is @onirix/embed-sdk well maintained?

Package last updated on 05 May 2025

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install