# @mitsuharu/react-native-sunmi-printer-library

> React Native module that support SUNMI mobile printer devices.

Latest version **3.0.0** (published 2026-09-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @mitsuharu/react-native-sunmi-printer-library
pnpm add @mitsuharu/react-native-sunmi-printer-library
yarn add @mitsuharu/react-native-sunmi-printer-library
bun add @mitsuharu/react-native-sunmi-printer-library
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2026-09-07 |
| First published | 2023-12-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 18.0.0 |
| Dependencies | 0 |
| Unpacked size | 258.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 27 |
| Author | Mitsuharu Emoto |
| Maintainers | mitsuharu_e |
| Keywords | react-native, android, sunmi, printer |

## Links

- npm: https://www.npmjs.com/package/@mitsuharu/react-native-sunmi-printer-library
- Repository: https://github.com/mitsuharu/react-native-sunmi-printer-library
- Homepage: https://github.com/mitsuharu/react-native-sunmi-printer-library#readme
- Issues: https://github.com/mitsuharu/react-native-sunmi-printer-library/issues
- npm.io page: https://npm.io/package/@mitsuharu/react-native-sunmi-printer-library

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2026-09-07
- 2.4.0 — 2025-10-19
- 2.3.0 — 2025-05-05
- 2.2.0 — 2024-07-19
- 2.1.2 — 2024-07-19
- 2.1.1 — 2024-04-13
- 2.1.0 — 2024-04-12
- 2.0.0 — 2024-03-16
- 1.0.1 — 2023-12-11
- 1.0.0 — 2023-12-06
- 0.1.1 — 2023-12-03
- 0.1.0 — 2023-12-02

## README

# @mitsuharu/react-native-sunmi-printer-library

React Native module that supports for SUNMI mobile printer devices.

## Verification devices

I validate it with GMS enable and developable SUNMI V2 PRO and SUNMI V2s as follows. Though I do not have other devices, users report to work with V1s and V2.

| | Android | SUNMI OS | firmware | storage | memory | NFC |
| :-- | :-- | :-- | :-- | :-- | :-- | :-- |
| SUNMI V2 PRO | 7.1 | 3.6.23 | 754 | 16 GB | 2 GB | enable |
| SUNMI V2 PRO (foodpanda) | 7.1 | 1.0.33 | 138 | 8 GB | 1 GB | disable |
| SUNMI V2s | 11 | 3.0.11 | 242 | 32 GB | 3 GB | enable |

[^GMS]: Google Mobile Services [https://www.android.com/gms](https://www.android.com/gms)


## Installation

### React Native

```shell
npm install @mitsuharu/react-native-sunmi-printer-library
```

or 

```shell
yarn add @mitsuharu/react-native-sunmi-printer-library
```

### Expo

This package contains custom Android native code, so it does not work in Expo
Go. Install it in an Expo project that uses a development build:

```shell
yarn expo install expo-dev-client @mitsuharu/react-native-sunmi-printer-library
```

Regenerate the Android project after installing or updating the package, then
compile and install it locally. An EAS Build or Expo account is not required:

```shell
yarn expo prebuild --platform android --clean
yarn expo run:android --device
```

See [Expo's development build documentation](https://docs.expo.dev/develop/development-builds/introduction/)
for details. This library supports Android only.

## Usage

See the React Native example in `example/` or the Expo example in
`example-expo/` for details.

### prepare

```typescript
import * as SunmiPrinterLibrary from '@mitsuharu/react-native-sunmi-printer-library'
```

```typescript
try {
    await SunmiPrinterLibrary.prepare()
} catch (error: any) {
    console.warn("This device is not supported.")
}
```

### print Text

```typescript
await SunmiPrinterLibrary.printText('Hello World')
```

or

```typescript
SunmiPrinterLibrary.printText('Hello World')
```

> [!WARNING]
> Printing without `await` is faster, but may be interrupted by other printing. When it use without `await`, it is better to use with Transaction.

### change style

```typescript
await SunmiPrinterLibrary.setAlignment('center')
await SunmiPrinterLibrary.setTextStyle('bold', true)
await SunmiPrinterLibrary.setParagraphStyle('textRightSpacing', 5)
await SunmiPrinterLibrary.setFontSize(32)
await SunmiPrinterLibrary.printText('Hello World')
```

### print Image (Base64)

```typescript
const base64 = 'data:image/png;base64,iVBORw0KGgoAAAA...'
await SunmiPrinterLibrary.printImage(base64, 384, 'binary')
await SunmiPrinterLibrary.printImage(base64, 384, 'grayscale')
```

### print QR code

```typescript
await SunmiPrinterLibrary.printQRCode('Hello World', 8, 'middle')
```

### scan QR code

```typescript
const result = await SunmiPrinterLibrary.scan()
```

or

```typescript
SunmiPrinterLibrary.scan()
```

```typescript
useEffect(() => {
   DeviceEventEmitter.addListener(
      SunmiPrinterLibrary.EventType.onScanSuccess,
      (message) => {
        console.log(`[onScanSuccess] ${message}`)
      })
   DeviceEventEmitter.addListener(
      SunmiPrinterLibrary.EventType.onScanFailed, 
      (message) => {
        console.log(`[onScanFailed] ${message}`)
      })
   return () => {
      DeviceEventEmitter.removeAllListeners(SunmiPrinterLibrary.EventType.onScanSuccess)
      DeviceEventEmitter.removeAllListeners(SunmiPrinterLibrary.EventType.onScanFailed)
    }
}, [])
```

### Transaction

```typescript
await SunmiPrinterLibrary.enterPrinterBuffer(true)

SunmiPrinterLibrary.printText('Transaction Test 0')

await SunmiPrinterLibrary.commitPrinterBuffer()

SunmiPrinterLibrary.printText('Transaction Test 1')
SunmiPrinterLibrary.printText('Transaction Test 2')
SunmiPrinterLibrary.printText('Transaction Test 3')
SunmiPrinterLibrary.lineWrap(4)

await SunmiPrinterLibrary.exitPrinterBuffer(true)
```

### Raw Data (ESC/POS command)

```typescript
// use to convert data to Base 64
import { Buffer } from 'buffer'

// ESC/POS command
// see: https://developer.sunmi.com/docs/en-US/index
const boldOn = new Uint8Array([0x1B, 0x45, 0x01])
const boldOnBase64 = Buffer.from(boldOn).toString('base64')
await SunmiPrinterLibrary.sendRAWData(boldOnBase64)

await SunmiPrinterLibrary.printText('Bold is ON')

const boldOff = new Uint8Array([0x1B, 0x45, 0x00])
const boldOffBase64= Buffer.from(boldOff).toString('base64')
await SunmiPrinterLibrary.sendRAWData(boldOffBase64)

await SunmiPrinterLibrary.printText('Bold is OFF')
```

### not support

- Cash Drawer API
- Black Mark Print API

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

### Develop

```shell
yarn
yarn example android
```

### Examples

- `example/` is the bare React Native example and uses React Native 0.87.
- `example-expo/` is the Expo example and uses Expo SDK 57 with React Native
  0.86.
- Both examples reuse the same printer operation screen.

The Expo example uses local Continuous Native Generation. It does not use EAS
Build or any other cloud build service. Generate a fresh Android project with
Expo Prebuild and build the APK with the generated Gradle Wrapper:

```shell
yarn example:expo build:android
```

The generated `example-expo/android/` directory is intentionally ignored. Do
not edit it directly; update the Expo app configuration or a config plugin and
run Prebuild again.

#### Development builds on Android 7.x

The Expo SDK 57 development launcher uses `java.time.Duration` during startup.
Without compatibility handling, the APK cannot resolve this API below Android
8.0 and crashes at startup on Android 7.1 devices such as the SUNMI V2 PRO:

```text
java.lang.NoClassDefFoundError: Failed resolution of: Ljava/time/Duration;
```

The Expo example registers
`example-expo/plugins/withAndroidCoreLibraryDesugaring.js` as a config plugin
in `app.json`. During Prebuild, it enables core library desugaring and adds
`desugar_jdk_libs`, allowing the development build to start on Android 7.x.

Do not add this configuration directly to the generated
`example-expo/android/app/build.gradle`; `expo prebuild --clean` will replace
that file. Keep native configuration in the config plugin instead. See the
[Expo config plugin documentation](https://docs.expo.dev/config-plugins/introduction/)
and [Android Java API desugaring documentation](https://developer.android.com/studio/write/java8-support)
for more information.

To start the Expo development server for an installed development build:

```shell
yarn example:expo start
```

### Guides

- Create Pull Requests against the `main` branch.
- I recommend that add or fix test, readme and example.

### Release

Maintainers only: update the version in `package.json` in a pull request against
`main`. After the pull request is merged and CI succeeds, run the **Release to
npm** workflow from the Actions tab and enter that exact version. The workflow
builds and verifies the package, creates a matching tag and GitHub release, and
publishes the package to npm. Merging into `main` never publishes a package.

## License

MIT

---

Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)

---
_Source: https://npm.io/package/@mitsuharu/react-native-sunmi-printer-library · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._