スタートガイド
インストール手順と、このプラグインの完全なMarkdownガイドを含むセットアッププロンプトをコピーします。
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-share-target`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/share-target/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
インストール
「インストール」セクションAIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins次に、以下のプロンプトを使用します:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-share-target` plugin in my project.手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください:
bun add @capgo/capacitor-share-targetbunx cap syncインポート
「インポート」セクションimport { CapacitorShareTarget } from '@capgo/capacitor-share-target';早期リスニング(コールドスタート)
「早めにリッスンする(コールドスタート)」セクション新規登録 shareReceived アプリの起動直後、共有コンテンツを利用する画面へユーザーをルーティングする前に実行してください。iOSでは、JavaScriptがイベントを消費するまでネイティブレイヤーがイベントを保持するため、WebViewの起動中に届いたシェアもカバーできます。
import { CapacitorShareTarget } from '@capgo/capacitor-share-target';
const shareListener = await CapacitorShareTarget.addListener('shareReceived', (event) => { routeSharedPayload(event.title, event.texts, event.files);});
// When tearing down the handler:await shareListener.remove();設定 appGroupId における capacitor.config Share Extensionでも同じApp Groupを設定してください。拡張機能のサンプル code については、GitHub のプラグインREADMEを参照してください。
よくある落とし穴
「よくある落とし穴」セクション- ネイティブの設定: intentは、READMEにあるmanifestとXcodeの手順を完了しないと動作しません。
- コールドスタート: ルーターの準備ができるまで共有をバッファします。
- ファイルURI: アップロード前にアプリのストレージにコピーしてください。アクセスが失効する可能性があります。
API の概要
「API 概要」セクションaddListener
セクション「addListener」shareReceived イベントをリッスンします。
他のアプリからコンテンツがアプリケーションに共有されたときに呼び出されるリスナーを登録します。コールバックは、title、texts、files を含むイベントデータを受け取ります。
import { CapacitorShareTarget } from '@capgo/capacitor-share-target';
const listener = await CapacitorShareTarget.addListener('shareReceived', (event) => { console.log('Title:', event.title); console.log('Texts:', event.texts); event.files?.forEach(file => { console.log(`File: ${file.name} (${file.mimeType})`); });});
// To remove the listener:await listener.remove();removeAllListeners
セクション「removeAllListeners」このプラグインのすべてのリスナーを削除します。
import { CapacitorShareTarget } from '@capgo/capacitor-share-target';
await CapacitorShareTarget.removeAllListeners();getPluginVersion
「getPluginVersion」セクションネイティブの Capacitor プラグインのバージョンを取得します。
ネイティブプラグイン実装の現在のバージョンを返します。
import { CapacitorShareTarget } from '@capgo/capacitor-share-target';
const { version} = await CapacitorShareTarget.getPluginVersion();console.log('Plugin version:', version);型リファレンス
「型リファレンス」セクションShareReceivedEvent
「ShareReceivedEvent」セクションコンテンツがアプリケーションに共有された際に受信するイベントデータです。
export interface ShareReceivedEvent { /** * The title of the shared content. * * @since 0.1.0 */ title: string;
/** * Array of text content shared to the application. * * @since 0.1.0 */ texts: string[];
/** * Array of files shared to the application. * * @since 0.2.0 */ files: SharedFile[];}SharedFile
「SharedFile」セクションアプリケーションに共有されたファイルを表します。
export interface SharedFile { /** * The URI of the shared file. On Android/iOS this will be a file path or data URL. * On web this will be a cached URL accessible via fetch. * * @since 0.1.0 */ uri: string;
/** * The name of the shared file, with or without extension. * * @since 0.1.0 */ name: string;
/** * The MIME type of the shared file. * * @since 0.1.0 */ mimeType: string;}Source of Truth
「Source Of Truth」セクションこのページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。
Getting Startedの続きを進める
「Getting Started からの続き」セクション使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-share-targetの使い方 「@capgo/capacitor-share-targetの使い方」のネイティブ機能については、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。