Installation

The TaskOn Embed SDK supports multiple installation and usage options.

Install via package manager

We recommend installing via a package manager for TypeScript support and version management.

npm

npm install @taskon/embed

yarn

yarn add @taskon/embed

pnpm

pnpm add @taskon/embed

Use via CDN

If you're not using a bundler/build tool, you can import via CDN:

<!-- ES Module -->
<script type="module">
  import { TaskOnEmbed } from "https://unpkg.com/@taskon/embed@latest/dist/embed.js";
  // Your code
</script>

<!-- Or use the IIFE version -->
<script src="https://unpkg.com/@taskon/embed@latest/dist/embed.iife.js"></script>
<script>
  const { TaskOnEmbed } = window.TaskonEmbed;
  // Your code
</script>

Versions

Latest stable

npm install @taskon/embed@latest

Specific version

npm install @taskon/embed@0.1.0

Beta channel

npm install @taskon/embed@beta

Build outputs

After installation, the package contains the following files:

@taskon/embed/
├── dist/
│   ├── embed.js          # ES module build
│   ├── embed.iife.js     # IIFE build (use directly in browser)
│   └── index.d.ts        # TypeScript typings
├── package.json
└── README.md

TypeScript support

The SDK ships with full type definitions. No extra @types packages are required.

import { TaskOnEmbed, type TaskOnEmbedConfig } from "@taskon/embed";

const config: TaskOnEmbedConfig = {
  clientId: "your-client-id",
  baseUrl: "https://taskon.xyz",
  containerElement: "#container",
};

Browser compatibility

TaskOn Embed SDK supports modern browsers:

Browser	Minimum Version
Chrome	60+
Firefox	55+
Safari	12+
Edge	79+

Bundle size

Version	Original Size	Gzip Compressed
ES Module	16.16 KB	4.36 KB
IIFE	11.36 KB	3.67 KB

Verify installation

After installation, you can quickly verify:

import { TaskOnEmbed } from "@taskon/embed";

console.log(TaskOnEmbed); // You should see the constructor

Next steps

After installation, continue to configure your first TaskOn Embed instance.