ダークモードを実装する

Compose の方法を試す

Jetpack Compose は、Android で推奨される UI ツールキットです。Compose でテーマ設定を使用する方法について学習します。

カラーパターン - マテリアル デザイン 3 →

ダークテーマは、Android 10（API レベル 29）以上で利用可能です。これには次のような利点があります。

• 電力使用量を大幅に削減できます（削減できる量はデバイスの画面テクノロジーに左右されます）。
• 視力の低いユーザーや明るい光に敏感なユーザーにとって、画面の見やすさが向上します。
• 暗い場所でのデバイスの使いやすさが向上します。

ダークモードは、Android システムの UI と、デバイスで実行されるアプリに適用されます。

Android 10 以降でダークモードを有効にするには、次の 3 つの方法があります。

• システム設定を使用して [設定] > [ディスプレイ] > [テーマ] に移動し、ダークモードを有効にします。
• [クイック設定] タイルを使用して、通知トレイ（有効にしている場合）からテーマを切り替えます。
• Pixel デバイスでは、バッテリー セーバー モードを有効にしてダークモードも同時に有効にできます。他のデバイスではこの動作がサポートされていない場合があります。

WebView コンポーネントを使用してウェブベースのコンテンツにダークテーマを適用する手順については、WebView のウェブ コンテンツをダークテーマ化するをご覧ください。

アプリでダークモードをサポートする

ダークモードをサポートするには、アプリのテーマ（通常は res/values/styles.xml にあります）が DayNight テーマを継承するように設定します。

<style name="AppTheme" parent="Theme.AppCompat.DayNight">

Material Components のダークテーマを使用することもできます。

<style name="AppTheme" parent="Theme.MaterialComponents.DayNight">

これにより、アプリのメインテーマがシステム制御の夜間モードのフラグに関連付けられ、アプリが有効になっている場合はデフォルトのダークモードになります。

テーマとスタイル

ライトテーマで使用する目的でハードコードされた色やアイコンは使用しないでください。代わりに、テーマ属性または夜間専用のリソースを使用してください。

ダークモードで最も重要なテーマ属性は次の 2 つです。

• ?android:attr/textColorPrimary: 汎用のテキストの色。ライトモードでは黒に近い色、ダークモードでは白に近い色になります。この属性には「無効」状態もあります。
• ?attr/colorControlNormal: 汎用アイコンの色。この属性には「無効」状態もあります。

マテリアル デザイン コンポーネントの使用をおすすめします。カラーテーマ設定システム（テーマ属性 ?attr/colorSurface や ?attr/colorOnSurface など）では適切な色に簡単にアクセスできます。これらの属性は、テーマでカスタマイズできます。

アプリ内でテーマを変更する

アプリの実行中にユーザーがアプリのテーマを変更できるようにすることができます。推奨されるオプションは次のとおりです。

• 光
• ダーク
• システムのデフォルト（推奨されるデフォルト オプション）

これらのオプションは AppCompat.DayNight モードに直接マッピングされています。

• ライト: MODE_NIGHT_NO。

• ダーク: MODE_NIGHT_YES。

• システムのデフォルト: MODE_NIGHT_FOLLOW_SYSTEM。

テーマを切り替えるには、次の操作を行います。

• API レベル 31 以降では、UiModeManager#setApplicationNightMode を使用して、アプリで実行されるテーマをシステムに通知します。これにより、スプラッシュ画面でテーマを照合できます。

• API レベル 30 以下では、AppCompatDelegate.setDefaultNightMode() を使用してテーマを切り替えます。

フォースダーク

Android 10 には、デベロッパーが DayNight テーマを明示的に設定せずにダークテーマをすばやく実装できるフォースダーク機能が用意されています。

フォースダーク機能は、ライトテーマが設定されているアプリの各ビューを分析し、ダークテーマを自動的に適用してから画面に描画します。フォースダークとネイティブ実装を組み合わせて使用することで、ダークテーマの実装に必要な時間を短縮できます。

アプリは、アクティビティのテーマで android:forceDarkAllowed="true" を設定することにより、フォースダークをオプトインする必要があります。この属性は、システムおよび AndroidX が提供するすべてのライトテーマ（Theme.Material.Light など）に設定されます。フォースダークを使用する場合は、アプリを徹底的にテストし、必要に応じてビューを除外します。

アプリでダークモード（Theme.Material など）を使用している場合、フォースダークは適用されません。同様に、アプリのテーマが DayNight テーマを継承している場合、テーマは自動的に切り替えられるので、フォースダークは適用されません。

ビューで強制ダークを無効にする

android:forceDarkAllowed レイアウト属性または setForceDarkAllowed() を使用して、特定のビューでフォースダークを制御できます。

ウェブ コンテンツ

ウェブベースのコンテンツでダークテーマを使用する方法については、WebView のウェブ コンテンツにダークテーマを適用するをご覧ください。WebView にダークテーマを適用する例については、GitHub の WebView デモをご覧ください。

おすすめの方法

以下のセクションでは、ダークテーマの実装に関するおすすめの方法を紹介します。

通知とウィジェット

デバイスに表示するが直接制御しない UI サーフェスでは、使用するすべてのビューにホストアプリのテーマを反映させることが重要です。その 2 つの例として、通知ウィジェットとランチャー ウィジェットがあります。

通知

システムが提供する通知テンプレート（MessagingStyle など）を使用します。つまり、適切なビュースタイルの適用はシステムが行います。

ウィジェットとカスタム通知ビュー

ランチャー ウィジェットを使用する場合や、アプリでカスタムの通知コンテンツ ビューを使用する場合は、ライトテーマとダークテーマの両方でコンテンツをテストします。

陥りやすい落とし穴には次のようなものがあります。

• 背景色は常に明るいと仮定します。
• テキストの色をハードコードする。
• ハードコードされた背景色を設定し、さらにデフォルトのテキストの色を使用する。
• 静的な色のドローアブル アイコンを使用する。

上記のいずれの場合も、ハードコードされた色ではなく、適切なテーマ属性を使用してください。

起動画面

アプリにカスタムの起動画面がある場合は、選択したテーマを反映するように修正が必要になることがあります。

プログラムで白に設定された背景色など、ハードコードされた色はすべて削除します。代わりに ?android:attr/colorBackground テーマ属性を使用します。

構成の変更

アプリのテーマが（システム設定または AppCompat のいずれかによって）変更されると、uiMode の構成変更がトリガーされます。つまり、アクティビティが自動的に再作成されます。

場合によっては、アプリで構成の変更を処理したいことがあります。たとえば、動画の再生中に構成の変更を遅延させる場合などです。

アプリは、各 Activity が uiMode 構成の変更を処理できることを宣言することで、ダークモードの実装を処理できます。

<activity
    android:name=".MyActivity"
    android:configChanges="uiMode" />

Activity が構成の変更を処理することを宣言すると、テーマが変更されると onConfigurationChanged() メソッドが呼び出されます。

アプリで現在のテーマを確認するには、次のようなコードを実行します。

val currentNightMode = configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
when (currentNightMode) {
    Configuration.UI_MODE_NIGHT_NO -> {} // Night mode is not active, we're using the light theme.
    Configuration.UI_MODE_NIGHT_YES -> {} // Night mode is active, we're using dark theme.
}

int currentNightMode = configuration.uiMode & Configuration.UI_MODE_NIGHT_MASK;
switch (currentNightMode) {
    case Configuration.UI_MODE_NIGHT_NO:
        // Night mode is not active, we're using the light theme
        break;
    case Configuration.UI_MODE_NIGHT_YES:
        // Night mode is active, we're using dark theme
        break;
}