@nexbasira/embed
v0.1.1
Published
Browser embed widget for the NexBasira field/operator session UX.
Maintainers
Readme
@nexbasira/embed
Browser embed widget for the NexBasira field / operator session UX.
Install
CDN (recommended for simple integrations):
<script src="https://cdn.nexbasira.com/embed/latest.js"></script>
<script>
const widget = NexBasira.embed({
container: "#nb-inspection",
sessionUrl: "<server-minted field-join URL>",
onSessionComplete: (id) => console.log("done", id),
});
</script>Or via npm:
npm install @nexbasira/embedimport { embed } from "@nexbasira/embed";
const widget = embed({
container: document.getElementById("cvp")!,
sessionUrl,
onWhiteboardSaved: (ev) => console.log("whiteboard", ev.id),
});Imperative controls
requestSnapshot(), openWhiteboard(), closeWhiteboard(),
switchCamera(), mute(), unmute(), endSession(), destroy().
Lifecycle callbacks
onReady, onSessionJoined, onSessionComplete, onEvidenceAdded,
onWhiteboardOpened, onWhiteboardSaved, onParticipantJoined,
onParticipantLeft, onError.
Security
- The widget mounts an iframe pointing at a server-minted session
URL. Never embed an API secret in browser code; mint the URL with
@nexbasira/nodeon your backend. - Incoming
postMessageevents are filtered byexpectedOrigin(defaults to the origin parsed out ofsessionUrl).
