このページは Cloud Translation API によって翻訳されました。

Glance で UI を作成する

このページでは、Glance を使用してサイズを処理し、柔軟でレスポンシブなレイアウトを提供する方法について説明します。

`Box`、`Column`、`Row` を使用する

Glance には、主に次の 3 つのコンポーザブルレイアウトがあります。

Box: 要素を別の要素の上に配置します。これは RelativeLayout に変換されます。
Column: 縦軸で要素を互いに並べて配置します。これは、縦向きの LinearLayout に変換されます。
Row: 横軸で要素を互いに並べて配置します。これは、横向きの LinearLayout に変換されます。

列、行、ボックスのレイアウトの画像。 — **図 1.**Column、Row、Box を使用したレイアウトの例。

これらのコンポーザブルでは、修飾子を使用して、コンテンツの垂直方向と水平方向の配置と、幅、高さ、太さ、パディングの制約を定義できます。また、それぞれの子で修飾子を定義して、親内のスペースと配置を変更できます。

次の例は、図 1 に示すように、子を水平方向に均等に分配する Row を作成する方法を示しています。

Row(modifier = GlanceModifier.fillMaxWidth().padding(16.dp)) {
    val modifier = GlanceModifier.defaultWeight()
    Text("first", modifier)
    Text("second", modifier)
    Text("third", modifier)
}GlanceSnippets.kt

Row は、使用可能な最大幅いっぱいになります。また、それぞれの子は同じ重みであるため、使用可能なスペースを均等に共有します。さまざまな太さ、サイズ、パディング、配置を定義して、レイアウトをニーズに合わせて調整できます。

スクロール可能なレイアウトを使用する

レスポンシブコンテンツを提供するもう 1 つの方法は、スクロール可能にすることです。これは、LazyColumn コンポーザブルで実現できます。このコンポーザブルを使用すると、アプリウィジェットのスクロール可能なコンテナ内に表示されるアイテムのセットを定義できます。

次のスニペットは、LazyColumn 内のアイテムを定義するさまざまな方法を示しています。

アイテムの数を指定できます。

// Remember to import Glance Composables
// import androidx.glance.appwidget.layout.LazyColumn

LazyColumn {
    items(10) { index: Int ->
        Text(
            text = "Item $index",
            modifier = GlanceModifier.fillMaxWidth()
        )
    }
}GlanceSnippets.kt

個々のアイテムを指定する:

LazyColumn {
    item {
        Text("First Item")
    }
    item {
        Text("Second Item")
    }
}GlanceSnippets.kt

アイテムのリストまたは配列を指定します。

LazyColumn {
    items(peopleNameList) { name ->
        Text(name)
    }
}GlanceSnippets.kt

上記の例を組み合わせて使用することもできます。

LazyColumn {
    item {
        Text("Names:")
    }
    items(peopleNameList) { name ->
        Text(name)
    }

    // or in case you need the index:
    itemsIndexed(peopleNameList) { index, person ->
        Text("$person at index $index")
    }
}GlanceSnippets.kt

前のスニペットでは itemId が指定されていません。itemId を指定すると、Android 12 以降のリストと appWidget の更新を通じて（たとえば、リストのアイテムを追加または削除するときなど）、パフォーマンスを向上させ、スクロール位置を維持できます。次の例は、itemId を指定する方法を示しています。

items(items = peopleList, key = { person -> person.id }) { person ->
    Text(person.name)
}GlanceSnippets.kt

`SizeMode` を定義する

AppWidget のサイズは、デバイス、ユーザーの選択、ランチャーによって異なる可能性があるため、柔軟なウィジェットレイアウトの提供ページで説明されているように、柔軟なレイアウトを提供することが重要です。Glance は、SizeMode 定義と LocalSize 値を使用してこれを簡略化します。以降のセクションでは、3 つのモードについて説明します。

`SizeMode.Single`

SizeMode.Single モード（デフォルトモード）: これは、1 種類のコンテンツのみが提供されることを示します。つまり、使用可能な AppWidget のサイズが変更されても、コンテンツサイズは変更されません。

class MyAppWidget : GlanceAppWidget() {

    override val sizeMode = SizeMode.Single

    override suspend fun provideGlance(context: Context, id: GlanceId) {
        // ...

        provideContent {
            MyContent()
        }
    }

    @Composable
    private fun MyContent() {
        // Size will be the minimum size or resizable
        // size defined in the App Widget metadata
        val size = LocalSize.current
        // ...
    }
}GlanceSnippets.kt

このモードを使用する場合は、次のことを確認してください。

メタデータ値の最小サイズと最大サイズは、コンテンツのサイズに基づいて適切に定義されます。
コンテンツに、想定されるサイズ範囲内で十分な柔軟性がある。

通常、このモードは次のような場合に使用してください。

a）AppWidget のサイズが固定されている、または b）サイズ変更時にその内容が変更されない。

`SizeMode.Responsive`

このモードは、レスポンシブレイアウトを提供するのと同等です。これにより、GlanceAppWidget で、特定のサイズで制限されたレスポンシブレイアウトのセットを定義できます。定義されたサイズごとに、AppWidget が作成または更新されるときにコンテンツが作成され、特定のサイズにマッピングされます。次に、使用可能なサイズに基づいて最適なものが選択されます。

たとえば、デスティネーションの AppWidget では、3 つのサイズとそのコンテンツを定義できます。

class MyAppWidget : GlanceAppWidget() {

    companion object {
        private val SMALL_SQUARE = DpSize(100.dp, 100.dp)
        private val HORIZONTAL_RECTANGLE = DpSize(250.dp, 100.dp)
        private val BIG_SQUARE = DpSize(250.dp, 250.dp)
    }

    override val sizeMode = SizeMode.Responsive(
        setOf(
            SMALL_SQUARE,
            HORIZONTAL_RECTANGLE,
            BIG_SQUARE
        )
    )

    override suspend fun provideGlance(context: Context, id: GlanceId) {
        // ...

        provideContent {
            MyContent()
        }
    }

    @Composable
    private fun MyContent() {
        // Size will be one of the sizes defined above.
        val size = LocalSize.current
        Column {
            if (size.height >= BIG_SQUARE.height) {
                Text(text = "Where to?", modifier = GlanceModifier.padding(12.dp))
            }
            Row(horizontalAlignment = Alignment.CenterHorizontally) {
                Button()
                Button()
                if (size.width >= HORIZONTAL_RECTANGLE.width) {
                    Button("School")
                }
            }
            if (size.height >= BIG_SQUARE.height) {
                Text(text = "provided by X")
            }
        }
    }
}
GlanceSnippets.kt

上記の例では、provideContent メソッドは 3 回呼び出され、定義されたサイズにマッピングされます。

最初の呼び出しでは、サイズは 100x100 と評価されます。コンテンツには、追加のボタンや、上部と下部のテキストは含まれていません。
2 回目の呼び出しでは、サイズは 250x100 と評価されます。コンテンツには追加ボタンは含まれますが、上部と下部のテキストは含まれません。
3 回目の呼び出しでは、サイズは 250x250 と評価されます。コンテンツには、追加のボタンと両方のテキストが含まれています。

SizeMode.Responsive は他の 2 つのモードを組み合わせたもので、事前定義された境界内でレスポンシブコンテンツを定義できます。一般に、このモードのほうがパフォーマンスが良く、AppWidget のサイズ変更時の遷移がスムーズになります。

次の表に、使用可能なサイズ SizeMode と AppWidget に応じたサイズの値を示します。

利用可能なサイズ	105×110	203×112	72 x 72	203×150
`SizeMode.Single`	110×110	110×110	110×110	110×110
`SizeMode.Exact`	105×110	203×112	72 x 72	203×150
`SizeMode.Responsive`	80×100	80×100	80×100	150×120
* 正確な値はデモ用です。

`SizeMode.Exact`

SizeMode.Exact は、正確なレイアウトを提供する場合と同等です。利用可能な AppWidget サイズが変更されるたびに（たとえば、ユーザーがホーム画面で AppWidget のサイズを変更したとき）、GlanceAppWidget コンテンツをリクエストします。

たとえば、デスティネーションウィジェットでは、使用可能な幅が特定の値より大きい場合に、ボタンを追加できます。

class MyAppWidget : GlanceAppWidget() {

    override val sizeMode = SizeMode.Exact

    override suspend fun provideGlance(context: Context, id: GlanceId) {
        // ...

        provideContent {
            MyContent()
        }
    }

    @Composable
    private fun MyContent() {
        // Size will be the size of the AppWidget
        val size = LocalSize.current
        Column {
            Text(text = "Where to?", modifier = GlanceModifier.padding(12.dp))
            Row(horizontalAlignment = Alignment.CenterHorizontally) {
                Button()
                Button()
                if (size.width > 250.dp) {
                    Button("School")
                }
            }
        }
    }
}GlanceSnippets.kt

このモードは他のモードよりも柔軟性がありますが、いくつかの注意点があります。

サイズが変更されるたびに、AppWidget を完全に再作成する必要があります。コンテンツが複雑な場合、パフォーマンスの問題や UI の追記が発生する可能性があります。
使用可能なサイズは、ランチャーの実装によって異なる場合があります。たとえば、ランチャーがサイズのリストを提供していない場合、可能な最小サイズが使用されます。
Android 12 より前のデバイスでは、状況によってはサイズ計算ロジックが機能しない場合があります。

一般に、SizeMode.Responsive を使用できない場合（つまり、少数のレスポンシブレイアウトセットが現実的でない場合）は、このモードを使用する必要があります。

リソースにアクセスする

任意の Android リソースにアクセスするには、次の例に示すように LocalContext.current を使用します。

LocalContext.current.getString(R.string.glance_title)GlanceSnippets.kt

最終的な RemoteViews オブジェクトのサイズを小さくし、ダイナミックカラーなどの動的リソースを有効にするために、リソース ID を直接指定することをおすすめします。

コンポーザブルとメソッドは、ImageProvider などの「プロバイダ」または GlanceModifier.background(R.color.blue) などのオーバーロードメソッドを使用してリソースを受け入れます。次に例を示します。

Column(
    modifier = GlanceModifier.background(R.color.default_widget_background)
) { /**...*/ }

Image(
    provider = ImageProvider(R.drawable.ic_logo),
    contentDescription = "My image",
)GlanceSnippets.kt

複合ボタンを追加する

複合ボタンは Android 12 で導入されました。Glance は、次のタイプの複合ボタンに対して下位互換性をサポートしています。

これらの複合ボタンには、「オン」状態を表すクリック可能なビューが表示されます。

var isApplesChecked by remember { mutableStateOf(false) }
var isEnabledSwitched by remember { mutableStateOf(false) }
var isRadioChecked by remember { mutableStateOf(0) }

CheckBox(
    checked = isApplesChecked,
    onCheckedChange = { isApplesChecked = !isApplesChecked },
    text = "Apples"
)

Switch(
    checked = isEnabledSwitched,
    onCheckedChange = { isEnabledSwitched = !isEnabledSwitched },
    text = "Enabled"
)

RadioButton(
    checked = isRadioChecked == 1,
    onClick = { isRadioChecked = 1 },
    text = "Checked"
)GlanceSnippets.kt

状態が変化すると、指定されたラムダがトリガーされます。次の例に示すように、チェック状態を保存できます。

class MyAppWidget : GlanceAppWidget() {

    override suspend fun provideGlance(context: Context, id: GlanceId) {
        val myRepository = MyRepository.getInstance()

        provideContent {
            val scope = rememberCoroutineScope()

            val saveApple: (Boolean) -> Unit =
                { scope.launch { myRepository.saveApple(it) } }
            MyContent(saveApple)
        }
    }

    @Composable
    private fun MyContent(saveApple: (Boolean) -> Unit) {

        var isAppleChecked by remember { mutableStateOf(false) }

        Button(
            text = "Save",
            onClick = { saveApple(isAppleChecked) }
        )
    }
}GlanceSnippets.kt

colors 属性を CheckBox、Switch、RadioButton に指定して色をカスタマイズすることもできます。

CheckBox(
    // ...
    colors = CheckboxDefaults.colors(
        checkedColor = ColorProvider(day = colorAccentDay, night = colorAccentNight),
        uncheckedColor = ColorProvider(day = Color.DarkGray, night = Color.LightGray)
    ),
    checked = isChecked,
    onCheckedChange = { isChecked = !isChecked }
)

Switch(
    // ...
    colors = SwitchDefaults.colors(
        checkedThumbColor = ColorProvider(day = Color.Red, night = Color.Cyan),
        uncheckedThumbColor = ColorProvider(day = Color.Green, night = Color.Magenta),
        checkedTrackColor = ColorProvider(day = Color.Blue, night = Color.Yellow),
        uncheckedTrackColor = ColorProvider(day = Color.Magenta, night = Color.Green)
    ),
    checked = isChecked,
    onCheckedChange = { isChecked = !isChecked },
    text = "Enabled"
)

RadioButton(
    // ...
    colors = RadioButtonDefaults.colors(
        checkedColor = ColorProvider(day = Color.Cyan, night = Color.Yellow),
        uncheckedColor = ColorProvider(day = Color.Red, night = Color.Blue)
    ),

)GlanceSnippets.kt

GlanceAppWidget を管理、更新する

Glance テーマを実装する

Glance で UI を作成する

Box、Column、Row を使用する

スクロール可能なレイアウトを使用する

SizeMode を定義する

SizeMode.Single

SizeMode.Responsive

SizeMode.Exact