Simple Background Remover

Remove image backgrounds in the browser using ONNX models and onnxruntime-web. Fast, easy, and privacy-friendly—no server upload required!

Features

- Runs entirely in the browser (no server needed)
- ONNX model for high-quality background removal
- Progress callback for UI feedback
- Supports HTMLImageElement and base64 input
- Caches model in IndexedDB for fast repeated use

Installation

$3

``bash
npm install simple-background-remover onnxruntime-web
`

$3

`html


`

Usage

$3

`html



`

$3

`js
import SimpleBackgroundRemover from 'simple-background-remover';
// or: const SimpleBackgroundRemover = require('simple-background-remover');
import 'onnxruntime-web'; // Make sure ort is loaded globally

const remover = new SimpleBackgroundRemover();
remover.removeBackground(imageElement, {
onProgress: (percent, message) => console.log(percent, message),
return: 'base64', // or 'image'
}).then(result => {
// result is a base64 string or HTMLImageElement
});
`

API

$3


- options.modelUrl (string): Custom ONNX model URL (default: RMBG 1.4)
- options.modelCacheKey (string): Cache key for IndexedDB (default: 'rmbg_model_v1.4')

$3

- imageOrBase64: HTMLImageElement or base64 data URL string
- opts.return: 'image' (default) or 'base64'
- opts.onProgress: function(percent, message) — progress callback
- Returns: Promise

#### Example
`js
const result = await remover.removeBackground(imageElement, {
return: 'base64',
onProgress: (percent, message) => console.log(percent, message),
});
`

$3


The progress callback receives two arguments:
- percent (number): Progress percentage (0-100)
- message (string): Status message

Browser Support

- Modern browsers with IndexedDB and WebAssembly
- Not supported in Node.js (browser only)

Model

- Default: RMBG-1.4
- You can use your own ONNX model by passing a custom modelUrl`.

Contributing

Pull requests and issues are welcome! Please open an issue to discuss your idea or bug.

License

MIT