Issuetracker SDK for Web

Drop-in issue reporter for web apps. Capture a screenshot, annotate it, and file an issue directly into a pre-configured Issuetracker project.

Install

npm install @issuetracker/sdk-web

Or via CDN (pin to a semver range so you get patches but not breaking changes):

<script src="https://cdn.jsdelivr.net/npm/@issuetracker/sdk-web@^0.5"></script>

Quickstart

import { Issuetracker } from '@issuetracker/sdk-web';

Issuetracker.configure({ apiKey: 'it_...' });

Default trigger: Ctrl/Cmd + Alt + T. The floating widget is hidden by default — enable with showFloatingWidget: true.

Full documentation

API reference, triggers, TERMINATED behavior, crash reporting, identity flow, breadcrumbs, and troubleshooting — see docs.issuetracker.no/sdk/web.

Requirements

All evergreen browsers (Chrome / Safari / Firefox / Edge, last 2 versions).

Versioning

Semver. Pre-1.0 the minor bumps for breaking changes; the patch for bug fixes and additive features. Pin to ^0.5 to stay on a known compatible line.

Upgrading

The SDK is entirely client-side — upgrading never requires changes to your API key, configure() options, triggers, or any backend. Bump the version and redeploy your app.

npm

• If your range already allows the new version (e.g. ^0.5.x), run npm update @issuetracker/sdk-web (or pnpm up / yarn up) to move your lockfile forward — a plain npm install won't bump an already-locked version.
• If you pinned an exact version or installed from a git URL, change the dependency to ^0.5.9 and reinstall.

Then rebuild and redeploy — the fix ships in your client bundle.

CDN

• @^0.5 or @latest URLs pick up new patches automatically (edge caches may take a few hours; a cache purge forces it).
• Exact-pinned URLs (@0.5.7) must be changed to the new version.

If you added a manual html2canvas install/import in earlier versions to work around screenshots failing, you can remove it — 0.5.8 onward bundles html2canvas itself. See the CHANGELOG for the full history of fixes and per-version notes.

Releasing (maintainers)

1. Bump version in package.json.
2. Commit: release: x.y.z.
3. Tag and push: git tag x.y.z && git push --tags.

The publish.yml workflow verifies the tag matches package.json, runs typecheck + tests + build, then publishes to npm with provenance via GitHub OIDC.

License

MIT