Help prepare for 2025 → Answer 8 simple questions on our Fall Survey
Open Survey

View on GitHub

@nativescript/mlkit-text-recognition ​

A plugin used with @nativescript/mlkit-core to enable Text Recognition in your app and provide TextResult type for the text recognition event data.

Contents ​

Installation ​

cli
npm install @nativescript/mlkit-text-recognition

Use @nativescript/mlkit-text-recognition ​

For an example, read Use @nativescript/mlkit-core and Text Recognition.

API ​

TextResult ​

The Text Recognition event data type.

ts
interface TextResult {
  text?: string
  bounds: Bounds
  lines: TextLine[]
  points: Point[]
}

Point ​

ts
interface Point {
  x: number
  y: number
}

Bounds ​

ts
interface Bounds {
  origin: Origin
  size: Size
}

Origin ​

ts
interface Origin {
  x: number
  y: number
}

Size ​

ts
interface Size {
  width: number
  height: number
}

TextLine ​

ts
interface TextLine {
  text?: string
  bounds: Bounds
  elements: TextElement[]
  points?: Point[]
}

TextElement ​

ts
interface TextElement {
  text?: string
  bounds: Bounds
}

License ​

Apache License Version 2.0

Next
Core