@microblink/blinkcard-core

This package provides the core BlinkCard functionality for browser-based card scanning. It exposes a low-level API for initializing and controlling the BlinkCard engine, managing sessions, and processing images. It can be used directly by end users for advanced or custom integrations, or as a dependency of higher-level packages such as @microblink/blinkcard.

Bundle size

Production consumer bundle sizes for @microblink/blinkcard-core:

| Entrypoint | Minified | Gzip | | ---------- | -------- | ------- | | root | 26.14 kB | 8.02 kB |

External packages and runtime assets such as workers, WASM, and models are excluded. Shared code is included in each entrypoint that loads it.

Generated automatically. Do not edit manually.

Overview

See the custom UI example for an end-to-end scan with an application-owned interface.

• Provides the main API for BlinkCard scanning and recognition in the browser.
• Handles initialization, licensing, and session management.
• Can be used directly by end users for advanced use cases.
• Used internally by @microblink/blinkcard.

Browser Support

This package supports image processing in these browser versions and newer:

• Chrome / Chromium 96 (desktop and Android)
• Edge 96
• Opera 84
• Firefox 114 (desktop and Android)
• Safari 16.4 (macOS)
• iOS Safari 16.4

These minimums come from the combination of Emscripten-generated WebAssembly, required baseline Wasm features, and the module Web Worker used by @microblink/blinkcard-core. This package does not include camera capture or UX components. If you use @microblink/blinkcard or the UX manager package, see the browser support section in those packages instead.

Installation

Install from npm using your preferred package manager:

npm install @microblink/blinkcard-core
# or
yarn add @microblink/blinkcard-core
# or
pnpm add @microblink/blinkcard-core

Usage

You can use @microblink/blinkcard-core directly in your project for custom integrations. See the example apps in the apps/examples directory in the GitHub repository for usage details.

Environment & Setup

• ESM-only: Use in browsers with a bundler (e.g., Vite) or via <script type="module">.
• Can also be used via esm.sh for direct HTTP imports.

License key

A valid license key is required. Request a free trial at Microblink Developer Hub.

Hosting resources

You must host the dist/resources directory from this package without modification. It contains:

• WebAssembly .wasm and .data files
• Emscripten JS glue code
• The @microblink/blinkcard-worker Web Worker script

Hosting requirements

• Must be served in a secure context.

• For multithreaded builds, your site must be cross-origin isolated:

  Cross-Origin-Embedder-Policy: require-corp
  Cross-Origin-Opener-Policy: same-origin

Development

To build the package locally:

1. Install dependencies in the monorepo root:

   pnpm install

2. Build the package:

   pnpm build

The output files will be available in the dist/ and types/ directories.