Compose のカットアウト

ディスプレイ カットアウトとは、一部のデバイスにある表示サーフェスに拡張された領域です。ディスプレイ カットアウトにより、デバイスの前面に重要なセンサーのスペースを確保しながら、エッジ ツー エッジのエクスペリエンスを実現できます。

Android は、Android 9（API レベル 28）を搭載したデバイスでディスプレイ カットアウトをサポートします。 高くなります。ただし、デバイス メーカーはディスプレイ カットアウトを Android 8.1 以前を搭載したデバイス

このページでは、カットアウト領域（カットアウトを含む表示サーフェスの長方形全体）の活用方法など、Compose でカットアウト付きのデバイスに対するサポートを実装する方法について説明します。

デフォルトの場合

デフォルトでは、ディスプレイ カットアウトはウィンドウ インセット情報に含まれています。 そのため、 アプリをエッジ ツー エッジ対応にするためのガイドです。

たとえば、kubectl の Modifier.windowInsetsPadding(WindowInsets.safeContent) またはModifier.windowInsetsPadding(WindowInsets.safeDrawing) カットアウトが配置された領域には描画されなくなります。 WindowInsets.safeContent と WindowInsets.safeDrawing の両方にディスプレイ カットアウトの情報が含まれており、デバイスのカットアウトがある場所には描画されません。

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    WindowCompat.setDecorFitsSystemWindows(window, false)

    setContent {
        Box(Modifier.windowInsetsPadding(WindowInsets.safeContent)) {
            // Any composable inside here will avoid drawing behind cutouts
        }
    }
}
CutoutSnippets.kt

この動作をさらにカスタマイズするには、カットアウト情報を処理する必要があります。 できます。

カットアウト情報を手動で処理する

カットアウトは次のいずれかの方法で処理できます。

• WindowInsets.displayCutout を使用する

• android:windowLayoutInDisplayCutoutMode を使用したテーマ マニフェストの設定

• window.attributes.layoutInDisplayCutoutMode を使用して Window のオプションをプログラムで設定する

• LocalView.current.rootWindowInsets.displayCutout を使用して切り抜き Path オブジェクトにアクセスする

Compose では、windowLayoutInDisplayCutoutMode を次のように設定することをおすすめします。 全体のテーマで default してから、WindowInsets.displayCutout を活用する 次のように指定してコンポーザブルでインセットを処理します。

Canvas(modifier = Modifier.fillMaxSize().windowInsetsPadding(WindowInsets.displayCutout)) {
    drawRect(Color.Red, style = Stroke(2.dp.toPx()))
}
CutoutSnippets.kt

このアプローチにより、必要に応じて displayCutout パディングを維持できます。 不要な場合は無視してください。

または、ビュー カットアウトと同じ設定を適用することもできます。 ドキュメントでは、 アクティビティ テーマの android:windowLayoutInDisplayCutoutMode を別のアクティビティ テーマに オプションを使用して window 属性を設定するか、 window.attributes.layoutInDisplayCutoutMode = LAYOUT_IN_DISPLAY_CUTOUT_MODE_DEFAULT。ただしカットアウトモードは 個々のコンポーザブルごとに制御することはできません。

特定のコンポーザブルでディスプレイの切り欠きを考慮し、他のコンポーザブルでは考慮しない場合は、WindowInset.displayCutout を使用します。この API を使用すると 表示することもできます。

おすすめの方法

ディスプレイ カットアウトを使用する場合は、次の点を考慮してください。

• UI の重要な要素の配置に注意してください。お客様の カットアウト領域を使うと、重要なテキスト、コントロール、その他の情報が見えにくくなります。
• 繊細なタップ認識を必要とするインタラクティブな要素をカットアウト領域に配置または拡張しないでください。設定によっては、タップの感度が カットアウト領域を指定します
• エッジツーエッジのガイダンスに沿って、カットアウト情報は safeDrawing / safeContent インセットに含まれます。
• 可能な場合は Modifier.windowInsetsPadding(WindowInsets.safeDrawing) を使用してください。 コンテンツに適用する適切なパディングを決定します。不使用 ステータスバーの高さをハードコードすると、 説明します。

カットアウトを使用してコンテンツがどのようにレンダリングされるかをテストする

アプリの画面と動作をすべてテストしてください。以下を搭載したデバイスでテストする 可能であれば さまざまなタイプのカットアウトを 使用することをおすすめしますカットアウト付きのデバイスがない場合は、Android 9 以降を搭載しているデバイスまたはエミュレータで、次の手順を使用して一般的なカットアウト構成をシミュレートできます。

1. [開発者向けオプション] を有効にします。
2. [開発者向けオプション] 画面で、[図形描画] まで下にスクロールします。 [カットアウトでディスプレイをシミュレート] を選択します。
3. カットアウトのタイプを選択します。