Orshot Embed SDKs

Official SDKs to freely embed Orshot Studio into your web application.

• Core SDK: Framework-agnostic vanilla JS/TS library.
• React SDK: Components and Hooks for React.
• Vue SDK: Components for Vue 3.

Documentation

Full documentation is available at orshot.com/docs.

Features

• ⚛️ Framework Ready: Native wrappers for React and Vue (more coming).
• 🛡️ Type Safe: Full TypeScript support with typed event payloads.
• 🔌 Plug & Play: Simple drop-in component.
• 🚀 Scalable: Built on a solid event-driven core.

Quick Start

React

Full documentation: @orshot/embed-react

npm install @orshot/embed-react

import { OrshotEmbed } from "@orshot/embed-react";

function App() {
  return (
    <OrshotEmbed
      embedId="your-embed-id"
      onTemplateCreate={(data) => console.log("Saved!", data)}
    />
  );
}

Vue 3

Full documentation: @orshot/embed-vue

npm install @orshot/embed-vue

<script setup>
import { OrshotEmbed } from "@orshot/embed-vue";
</script>

<template>
  <OrshotEmbed
    embedId="your-embed-id"
    @template:create="(data) => console.log('Saved!', data)"
  />
</template>

Contributing

This repository is managed with pnpm workspaces and turbo.

1. Install dependencies: pnpm install
2. Run dev mode: pnpm dev
3. Build all: pnpm build

License

MIT © Orshot