Getting Started

Install

bun add @capgo/capacitor-textinteraction
bunx cap sync

Import

import { TextInteraction } from '@capgo/capacitor-textinteraction';

API Overview

toggle

Toggle text interaction (selection) on the Capacitor WebView.

⚠️ Disabling text interaction prevents all text input controls from working while disabled. Use it sparingly and re-enable when text entry is required.

iOS only.

import { TextInteraction } from '@capgo/capacitor-textinteraction';

await TextInteraction.toggle({} as TextInteractionOptions);

Type Reference

TextInteractionOptions

export interface TextInteractionOptions {
  /**
   * Whether text interaction should be enabled or disabled. Disabling hides the
   * magnifier lens reintroduced with iOS 15.
   */
  enabled: boolean;
}

TextInteractionResult

export interface TextInteractionResult {
  /**
   * `true` when the platform supports toggling text interaction (iOS >= 14.5), otherwise `false`.
   */
  success: boolean;

  /**
   * Get the native Capacitor plugin version
   *
   * @returns {Promise<{ id: string }>} an Promise with version for this device
   * @throws An error if the something went wrong
   */
  getPluginVersion(): Promise<{ version: string }>;
}

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.