https://github.com/atlj/react-native-background-remover
A React Native lib that removes background from images
https://github.com/atlj/react-native-background-remover
background-removal react-native
Last synced: 6 months ago
JSON representation
A React Native lib that removes background from images
- Host: GitHub
- URL: https://github.com/atlj/react-native-background-remover
- Owner: atlj
- License: mit
- Created: 2024-02-04T16:44:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-17T20:58:42.000Z (10 months ago)
- Last Synced: 2025-03-28T17:58:02.698Z (6 months ago)
- Topics: background-removal, react-native
- Language: Kotlin
- Homepage: https://www.npmjs.com/package/react-native-background-remover
- Size: 2.48 MB
- Stars: 68
- Watchers: 3
- Forks: 13
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# react-native-background-remover
This package is a React Native package that uses MLKit on Android and Vision on iOS to remove the background from an image.
## Installation
```sh
yarn add react-native-background-remover
```
## Usage
```js
import { removeBackground } from 'react-native-background-remover';
// You can get the imageURI from the camera or the gallery.
const backgroundRemovedImageURI = removeBackground(imageURI);
```
> Note: You need to use a real device on iOS to use this package. Otherwise, it will throw a warning and return the original image. You can still use an emulator on Android.
> Note: This only works with iOS 15 and above. Otherwise, you will get an error.
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## License
MIT
---
Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)