メインコンテンツへスキップ

ActionSheetIOS

iOS のネイティブ アクションシート コンポーネントを表示します。

リファレンス

Methods

showActionSheetWithOptions()

tsx
static showActionSheetWithOptions: (
options: ActionSheetIOSOptions,
callback: (buttonIndex: number) => void,
);

iOS のアクションシートを表示します。options オブジェクトには、次のいずれかまたは複数を指定する必要があります。

  • options (文字列の配列) - ボタンタイトルのリスト (必須)
  • cancelButtonIndex (int) - options 内のキャンセルボタンのインデックス
  • cancelButtonTintColor (string) - キャンセルボタンのテキストカラーを変更するために使用される
  • destructiveButtonIndex (int または int の配列) - options 内の破壊的ボタンのインデックス
  • title (string) - アクションシートの上に表示するタイトル
  • message (string) - タイトルの下に表示するメッセージ
  • anchor (number) - アクションシートを固定するノード (iPad で使用)
  • tintColor (string) - 非破壊的ボタンのタイトルに使用される
  • disabledButtonIndices (数値の配列) - 無効にするボタンインデックスのリスト
  • userInterfaceStyle (string) - アクションシートに使用されるインターフェーススタイル。light または dark に設定できます。それ以外の場合は、デフォルトのシステムスタイルが使用されます。

「callback」関数は、選択された項目のゼロベースのインデックスという1つのパラメータを受け取ります。

最小限の例

tsx
ActionSheetIOS.showActionSheetWithOptions(
{
options: ['Cancel', 'Remove'],
destructiveButtonIndex: 1,
cancelButtonIndex: 0,
},
buttonIndex => {
if (buttonIndex === 1) {
/* destructive action */
}
},
);

dismissActionSheet()

tsx
static dismissActionSheet();

表示されている最も上位の iOS アクションシートを閉じます。アクションシートが表示されていない場合は警告が表示されます。


showShareActionSheetWithOptions()

tsx
static showShareActionSheetWithOptions: (
options: ShareActionSheetIOSOptions,
failureCallback: (error: Error) => void,
successCallback: (success: boolean, method: string) => void,
);

iOS 共有シートを表示します。options オブジェクトには、messageurl のいずれかまたは両方を含める必要があります。さらに、subject または excludedActivityTypes を含めることもできます。

  • url (string) - 共有する URL
  • message (string) - 共有するメッセージ
  • subject (string) - メッセージの件名
  • excludedActivityTypes (配列) - アクションシートから除外するアクティビティ

url がローカルファイルまたは base64 エンコードされた URI を指している場合、そのファイルが読み込まれ、直接共有されます。この方法で、画像、ビデオ、PDF ファイルなどを共有できます。url がリモートファイルまたはアドレスを指している場合、RFC 2396 に記載されている URL 形式に準拠している必要があります。例えば、適切なプロトコル (HTTP/HTTPS) がない Web URL は共有されません。

「failureCallback」関数は、エラーオブジェクトという1つのパラメータを受け取ります。このオブジェクトに定義されている唯一のプロパティは、string 型のオプションの stack プロパティです。

「successCallback」関数は2つのパラメータを受け取ります。

  • 成功または失敗を示すブール値
  • 成功の場合、共有方法を示す文字列