{"_id":"@capacitor-mlkit/genai-proofreading","_rev":"3-a475a77a368a5803dcbf75b7252f5523","name":"@capacitor-mlkit/genai-proofreading","dist-tags":{"latest":"8.2.1"},"versions":{"8.1.0":{"name":"@capacitor-mlkit/genai-proofreading","version":"8.1.0","keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","proofreading","proofread","on-device ai"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","_id":"@capacitor-mlkit/genai-proofreading@8.1.0","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/mlkit/genai-proofreading/","bugs":{"url":"https://github.com/capawesome-team/capacitor-mlkit/issues"},"dist":{"shasum":"762448eb84e6b6112ee0f6ac6152072decd3f979","tarball":"https://registry.npmjs.org/@capacitor-mlkit/genai-proofreading/-/genai-proofreading-8.1.0.tgz","fileCount":36,"integrity":"sha512-FTRaRArWsu5H7civOIgQgLdQ9uenZ2fg9u5v/dg8ZE0MK9pXAW7rMtjecGtm6dPQBlJeet1VdnPJ89cJhk8v/w==","signatures":[{"sig":"MEQCIA73tC89z2PPxXfc9m6xf5pxHrvv35q++e8IGJ10opRPAiAi80KhFA89l2/yIMN7lKRg0pAJr0P/Vl4sR7toXhJi+Q==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":100608},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"6557f01f9f882afd5a13dff597f7635009585822","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api GenAiProofreadingPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"robingenz","email":"mail@robingenz.dev"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/capawesome-team/capacitor-mlkit.git","type":"git"},"_npmVersion":"11.13.0","description":"Capacitor plugin for ML Kit GenAI Proofreading on Android.","directories":{},"_nodeVersion":"24.16.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.1.2","rollup":"4.53.3","swiftlint":"2.0.0","typescript":"5.9.3","@capacitor/cli":"8.0.0","@capacitor/ios":"8.0.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/android":"8.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/genai-proofreading_8.1.0_1783756931356_0.47238477765494546","host":"s3://npm-registry-packages-npm-production"}},"8.2.0":{"name":"@capacitor-mlkit/genai-proofreading","version":"8.2.0","keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","proofreading","proofread","on-device ai"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","_id":"@capacitor-mlkit/genai-proofreading@8.2.0","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/mlkit/genai-proofreading/","bugs":{"url":"https://github.com/capawesome-team/capacitor-mlkit/issues"},"dist":{"shasum":"035e9d8f81d61b2355b1b417caa4a186b504dab4","tarball":"https://registry.npmjs.org/@capacitor-mlkit/genai-proofreading/-/genai-proofreading-8.2.0.tgz","fileCount":36,"integrity":"sha512-9xN4AD1WTJ67woLdgKRqcSEB79DmpGPSL226aSqeM+q9JY9KRcirjtVpQUCRhFETtKLsocQlxcnprwYGTT11Vw==","signatures":[{"sig":"MEYCIQD/b62bYqg19KhC/eaeL24nHASoDQwF2vUMqWSlykWSvQIhAOIXhf5wej/r34JwrM4ZUHFAmcit/uJFMRmlw6h21n0o","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capacitor-mlkit%2fgenai-proofreading@8.2.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":100608},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"b960e3339eb497476360d5a6b24bb993f3449ba8","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api GenAiProofreadingPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:913c1730-37ca-45aa-bd17-7dbdf3bb649d"}},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/capawesome-team/capacitor-mlkit.git","type":"git"},"_npmVersion":"11.16.0","description":"Capacitor plugin for ML Kit GenAI Proofreading on Android.","directories":{},"_nodeVersion":"24.18.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.1.2","rollup":"4.53.3","swiftlint":"2.0.0","typescript":"5.9.3","@capacitor/cli":"8.0.0","@capacitor/ios":"8.0.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/android":"8.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/genai-proofreading_8.2.0_1784269871289_0.6679903886213037","host":"s3://npm-registry-packages-npm-production"}},"8.2.1":{"name":"@capacitor-mlkit/genai-proofreading","version":"8.2.1","description":"Capacitor plugin for ML Kit GenAI Proofreading on Android.","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","repository":{"type":"git","url":"git+https://github.com/capawesome-team/capacitor-mlkit.git"},"bugs":{"url":"https://github.com/capawesome-team/capacitor-mlkit/issues"},"funding":[{"type":"github","url":"https://github.com/sponsors/capawesome-team/"},{"type":"opencollective","url":"https://opencollective.com/capawesome"}],"keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","proofreading","proofread","on-device ai"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api GenAiProofreadingPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd ..","prepublishOnly":"npm run build"},"devDependencies":{"@capacitor/android":"8.0.0","@capacitor/cli":"8.5.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/ios":"8.0.0","@ionic/eslint-config":"0.4.0","eslint":"8.57.0","prettier-plugin-java":"2.9.7","rimraf":"6.1.2","rollup":"4.62.3","swiftlint":"2.0.0","typescript":"5.9.3"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"publishConfig":{"access":"public"},"homepage":"https://capawesome.io/docs/sdks/capacitor/mlkit/genai-proofreading/","gitHead":"0fcd1977cfb70d9c39d618680045cf01434aebf2","_id":"@capacitor-mlkit/genai-proofreading@8.2.1","_nodeVersion":"24.20.0","_npmVersion":"11.19.0","dist":{"integrity":"sha512-2j4wJVc8QaYaUev6QCVwpQ8BBQwP8AdVOhOv7RCtLJBiieebKy8xt0T1OvoS5dVKTYCHvzN66AZ20+rl2xMgxw==","shasum":"ca5623827ee28cc75363237b7764f9c9cce4d2af","tarball":"https://registry.npmjs.org/@capacitor-mlkit/genai-proofreading/-/genai-proofreading-8.2.1.tgz","fileCount":36,"unpackedSize":100322,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capacitor-mlkit%2fgenai-proofreading@8.2.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIBgprGj2LaMIAPUTcQbRbTFX4HL6ZreAuCtL0tVSKJZlAiBcey1zTXP6qoV0Mg3+97ocyFXHo8/WkG5hNBJtxA7Jhw=="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:913c1730-37ca-45aa-bd17-7dbdf3bb649d"}},"directories":{},"maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/genai-proofreading_8.2.1_1789015821746_0.4225675018563029"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-11T08:02:11.096Z","modified":"2026-09-10T04:50:22.234Z","8.1.0":"2026-07-11T08:02:11.503Z","8.2.0":"2026-07-17T06:31:11.433Z","8.2.1":"2026-09-10T04:50:21.905Z"},"bugs":{"url":"https://github.com/capawesome-team/capacitor-mlkit/issues"},"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","homepage":"https://capawesome.io/docs/sdks/capacitor/mlkit/genai-proofreading/","keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","proofreading","proofread","on-device ai"],"repository":{"type":"git","url":"git+https://github.com/capawesome-team/capacitor-mlkit.git"},"description":"Capacitor plugin for ML Kit GenAI Proofreading on Android.","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"readme":"# Capacitor ML Kit GenAI Proofreading Plugin\n\nUnofficial Capacitor plugin for [ML Kit GenAI Proofreading](https://developers.google.com/ml-kit/genai/proofreading).[^1]\n\n> [!WARNING]\n> The ML Kit GenAI APIs are currently in **beta**. The API surface and behavior may change in future releases.\n\n<div class=\"capawesome-z29o10a\">\n  <a href=\"https://cloud.capawesome.io/\" target=\"_blank\">\n    <img alt=\"Deliver Live Updates to your Capacitor app with Capawesome Cloud\" src=\"https://cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.png?t=1\" />\n  </a>\n</div>\n\n## Use Cases\n\nThe GenAI Proofreading plugin is typically used to refine grammar and fix spelling in short content on-device using Gemini Nano, for example:\n\n- **Message polishing**: Correct typos and grammar in chat or email drafts before sending.\n- **Form input cleanup**: Proofread user-generated text such as reviews or comments.\n- **Voice-to-text refinement**: Clean up text produced by voice dictation.\n\n## Requirements\n\nThis plugin uses [Gemini Nano](https://developers.google.com/ml-kit/genai), which runs entirely on-device. It is only available on Android and has the following device requirements:\n\n- The device must support Gemini Nano (see [supported devices](https://developers.google.com/ml-kit/genai#supported_devices)).\n- The device must run Android API level 26 or higher.\n- The device must not have an unlocked bootloader.\n\nUse the `checkFeatureStatus(...)` method to check whether the feature is available on the device.\n\n## Compatibility\n\n| Plugin Version | Capacitor Version | Status         |\n| -------------- | ----------------- | -------------- |\n| 8.x.x          | >=8.x.x           | Active support |\n\n## Installation\n\nYou can use our **AI-Assisted Setup** to install the plugin.\nAdd the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:\n\n```bash\nnpx skills add capawesome-team/skills --skill capacitor-plugins\n```\n\nThen use the following prompt:\n\n```\nUse the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-mlkit/genai-proofreading` plugin in my project.\n```\n\nIf you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below:\n\n```bash\nnpm install @capacitor-mlkit/genai-proofreading\nnpx cap sync\n```\n\n### Android\n\n#### API level\n\nThis plugin requires a minimum API level of 26. Make sure to set the `minSdkVersion` in your `variables.gradle` file to at least `26`.\n\n#### Variables\n\nThis plugin will use the following project variables (defined in your app’s `variables.gradle` file):\n\n- `$mlkitGenaiProofreadingVersion` version of `com.google.mlkit:genai-proofreading` (default: `1.0.0-beta1`)\n\n## Usage\n\nThe following example shows how to check the feature status, download the feature and proofread a text.\n\n### Check the feature status\n\nBefore using the proofreading feature, check whether it is available on the device. The feature availability depends on the configured input type and language:\n\n```typescript\nimport {\n  FeatureStatus,\n  GenAiProofreading,\n  InputType,\n  Language,\n} from '@capacitor-mlkit/genai-proofreading';\n\nconst checkFeatureStatus = async () => {\n  const { featureStatus } = await GenAiProofreading.checkFeatureStatus({\n    inputType: InputType.Keyboard,\n    language: Language.English,\n  });\n  return featureStatus === FeatureStatus.Available;\n};\n```\n\n### Download the feature\n\nIf the feature status is `DOWNLOADABLE`, download the feature before using it. Add a listener for the `downloadProgress` event to get notified about the download progress:\n\n```typescript\nimport { GenAiProofreading, InputType, Language } from '@capacitor-mlkit/genai-proofreading';\n\nconst downloadFeature = async () => {\n  await GenAiProofreading.addListener('downloadProgress', event => {\n    console.log('Total bytes downloaded:', event.totalBytesDownloaded);\n  });\n  await GenAiProofreading.downloadFeature({\n    inputType: InputType.Keyboard,\n    language: Language.English,\n  });\n};\n```\n\n### Proofread a text\n\nPass the text to `proofread(...)` to generate corrected suggestions. Add a listener for the `inferenceProgress` event to receive partial results as they are generated:\n\n```typescript\nimport { GenAiProofreading, InputType, Language } from '@capacitor-mlkit/genai-proofreading';\n\nconst proofread = async () => {\n  await GenAiProofreading.addListener('inferenceProgress', event => {\n    console.log('Partial result:', event.text);\n  });\n  const { results } = await GenAiProofreading.proofread({\n    text: 'Capacitor is an open source natvie runtime for buildng Web Native apps.',\n    inputType: InputType.Keyboard,\n    language: Language.English,\n  });\n  return results;\n};\n```\n\n## API\n\n<docgen-index>\n\n* [`checkFeatureStatus(...)`](#checkfeaturestatus)\n* [`downloadFeature(...)`](#downloadfeature)\n* [`proofread(...)`](#proofread)\n* [`addListener('downloadProgress', ...)`](#addlistenerdownloadprogress-)\n* [`addListener('inferenceProgress', ...)`](#addlistenerinferenceprogress-)\n* [`removeAllListeners()`](#removealllisteners)\n* [Interfaces](#interfaces)\n* [Enums](#enums)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### checkFeatureStatus(...)\n\n```typescript\ncheckFeatureStatus(options?: FeatureOptions | undefined) => Promise<CheckFeatureStatusResult>\n```\n\nCheck the current availability status of the proofreading feature.\n\nIf the status is `DOWNLOADABLE`, you can download the feature\nusing `downloadFeature(...)`.\n\nOnly available on Android.\n\n| Param         | Type                                                      |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | <code><a href=\"#featureoptions\">FeatureOptions</a></code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#checkfeaturestatusresult\">CheckFeatureStatusResult</a>&gt;</code>\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### downloadFeature(...)\n\n```typescript\ndownloadFeature(options?: FeatureOptions | undefined) => Promise<void>\n```\n\nDownload the proofreading feature.\n\nThe `downloadProgress` event listener will notify you about\nthe download progress. The returned promise resolves when\nthe download is complete or the feature is already available.\n\nOnly available on Android.\n\n| Param         | Type                                                      |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | <code><a href=\"#featureoptions\">FeatureOptions</a></code> |\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### proofread(...)\n\n```typescript\nproofread(options: ProofreadOptions) => Promise<ProofreadResult>\n```\n\nProofread the given text.\n\nThe `inferenceProgress` event listener will notify you about\npartial results as they are generated. The returned promise\nresolves with the full result.\n\nOnly available on Android.\n\n| Param         | Type                                                          |\n| ------------- | ------------------------------------------------------------- |\n| **`options`** | <code><a href=\"#proofreadoptions\">ProofreadOptions</a></code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#proofreadresult\">ProofreadResult</a>&gt;</code>\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### addListener('downloadProgress', ...)\n\n```typescript\naddListener(eventName: 'downloadProgress', listenerFunc: (event: DownloadProgressEvent) => void) => Promise<PluginListenerHandle>\n```\n\nCalled while the proofreading feature is being downloaded.\n\nOnly available on Android.\n\n| Param              | Type                                                                                        |\n| ------------------ | ------------------------------------------------------------------------------------------- |\n| **`eventName`**    | <code>'downloadProgress'</code>                                                             |\n| **`listenerFunc`** | <code>(event: <a href=\"#downloadprogressevent\">DownloadProgressEvent</a>) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### addListener('inferenceProgress', ...)\n\n```typescript\naddListener(eventName: 'inferenceProgress', listenerFunc: (event: InferenceProgressEvent) => void) => Promise<PluginListenerHandle>\n```\n\nCalled when a new partial result is available during inference.\n\nOnly available on Android.\n\n| Param              | Type                                                                                          |\n| ------------------ | --------------------------------------------------------------------------------------------- |\n| **`eventName`**    | <code>'inferenceProgress'</code>                                                              |\n| **`listenerFunc`** | <code>(event: <a href=\"#inferenceprogressevent\">InferenceProgressEvent</a>) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() => Promise<void>\n```\n\nRemove all listeners for this plugin.\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### CheckFeatureStatusResult\n\n| Prop                | Type                                                    | Description                                                  | Since |\n| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------ | ----- |\n| **`featureStatus`** | <code><a href=\"#featurestatus\">FeatureStatus</a></code> | The current availability status of the proofreading feature. | 8.2.0 |\n\n\n#### FeatureOptions\n\nThe feature availability depends on the configured input type\nand language. Therefore, `checkFeatureStatus(...)` and\n`downloadFeature(...)` take the same base options as `proofread(...)`.\n\n| Prop            | Type                                            | Description                     | Default                         | Since |\n| --------------- | ----------------------------------------------- | ------------------------------- | ------------------------------- | ----- |\n| **`inputType`** | <code><a href=\"#inputtype\">InputType</a></code> | The type of the input text.     | <code>InputType.Keyboard</code> | 8.2.0 |\n| **`language`**  | <code><a href=\"#language\">Language</a></code>   | The language of the input text. | <code>Language.English</code>   | 8.2.0 |\n\n\n#### ProofreadResult\n\n| Prop          | Type                  | Description                                                                                                                                                                  | Since |\n| ------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |\n| **`results`** | <code>string[]</code> | The proofread suggestions for the input text. More than one result may be returned. If multiple suggestions are returned, they are sorted in descending order of confidence. | 8.2.0 |\n\n\n#### ProofreadOptions\n\n| Prop       | Type                | Description            | Since |\n| ---------- | ------------------- | ---------------------- | ----- |\n| **`text`** | <code>string</code> | The text to proofread. | 8.2.0 |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |\n\n\n#### DownloadProgressEvent\n\n| Prop                       | Type                | Description                                  | Since |\n| -------------------------- | ------------------- | -------------------------------------------- | ----- |\n| **`totalBytesDownloaded`** | <code>number</code> | The total number of bytes downloaded so far. | 8.2.0 |\n\n\n#### InferenceProgressEvent\n\n| Prop       | Type                | Description                         | Since |\n| ---------- | ------------------- | ----------------------------------- | ----- |\n| **`text`** | <code>string</code> | The new text of the partial result. | 8.2.0 |\n\n\n### Enums\n\n\n#### FeatureStatus\n\n| Members            | Value                       | Description                                                 | Since |\n| ------------------ | --------------------------- | ----------------------------------------------------------- | ----- |\n| **`Available`**    | <code>'AVAILABLE'</code>    | The feature is available to use.                            | 8.2.0 |\n| **`Downloadable`** | <code>'DOWNLOADABLE'</code> | The feature can be downloaded using `downloadFeature(...)`. | 8.2.0 |\n| **`Downloading`**  | <code>'DOWNLOADING'</code>  | The feature is currently being downloaded.                  | 8.2.0 |\n| **`Unavailable`**  | <code>'UNAVAILABLE'</code>  | The feature is not available on this device.                | 8.2.0 |\n\n\n#### InputType\n\n| Members        | Value                   | Description                                              | Since |\n| -------------- | ----------------------- | -------------------------------------------------------- | ----- |\n| **`Keyboard`** | <code>'KEYBOARD'</code> | The input text was typed on a keyboard.                  | 8.2.0 |\n| **`Voice`**    | <code>'VOICE'</code>    | The input text was produced by converting voice to text. | 8.2.0 |\n\n\n#### Language\n\n| Members        | Value                   | Since |\n| -------------- | ----------------------- | ----- |\n| **`English`**  | <code>'ENGLISH'</code>  | 8.2.0 |\n| **`French`**   | <code>'FRENCH'</code>   | 8.2.0 |\n| **`German`**   | <code>'GERMAN'</code>   | 8.2.0 |\n| **`Italian`**  | <code>'ITALIAN'</code>  | 8.2.0 |\n| **`Japanese`** | <code>'JAPANESE'</code> | 8.2.0 |\n| **`Korean`**   | <code>'KOREAN'</code>   | 8.2.0 |\n| **`Spanish`**  | <code>'SPANISH'</code>  | 8.2.0 |\n\n</docgen-api>\n\n## FAQ\n\n### What are the requirements to use this plugin?\n\nThe proofreading is performed on-device by Gemini Nano. This requires a device that supports Gemini Nano, Android API level 26 or higher and a locked bootloader (see [Requirements](#requirements)). Use the `checkFeatureStatus(...)` method to check whether the feature is available on the device.\n\n### Why is this plugin only available on Android?\n\nThe ML Kit GenAI APIs are based on Gemini Nano and AICore, which are currently only available on Android. On iOS and Web, all methods reject with an appropriate error.\n\n### Which languages are supported?\n\nProofreading is supported for English, French, German, Italian, Japanese, Korean and Spanish. Use the `Language` enum to configure the language of the input text.\n\n### How do I get the result as a stream?\n\nAdd a listener for the `inferenceProgress` event before calling `proofread(...)`. The listener is called with each partial result as it is generated. The promise returned by `proofread(...)` resolves with the full result.\n\n### Can I use this plugin with Ionic, React, Vue or Angular?\n\nYes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects.\n\n## Related Plugins\n\n- [GenAI Summarization](https://capawesome.io/docs/sdks/capacitor/mlkit/genai-summarization/): Unofficial Capacitor plugin for ML Kit GenAI Summarization.\n- [Translation](https://capawesome.io/docs/sdks/capacitor/mlkit/translation/): Unofficial Capacitor plugin for ML Kit Translation.\n\n## Terms & Privacy\n\nThis plugin uses the [Google ML Kit](https://developers.google.com/ml-kit):\n\n- [Terms & Privacy](https://developers.google.com/ml-kit/terms)\n- [Android Data Disclosure](https://developers.google.com/ml-kit/android-data-disclosure)\n- [iOS Data Disclosure](https://developers.google.com/ml-kit/ios-data-disclosure)\n\n## Newsletter\n\nStay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).\n\n## Changelog\n\nSee [CHANGELOG.md](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/genai-proofreading/CHANGELOG.md).\n\n## License\n\nSee [LICENSE](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/genai-proofreading/LICENSE).\n\n[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.\n","readmeFilename":"README.md"}