このページでは、既存の Glance コンポーネントを使用して、Glance でサイズを処理し、柔軟でレスポンシブなレイアウトを提供する方法について説明します。
Box
、Column
、Row
を使用する
Glance には、主に次の 3 つのコンポーザブル レイアウトがあります。
Box
: 要素を別の要素の上に重ねて配置します。これはRelativeLayout
に変換されます。Column
: 要素を縦軸で並べます。これは、縦向きのLinearLayout
に変換されます。Row
: 要素を横軸に並べます。これは、横向きのLinearLayout
に変換されます。
Glance は Scaffold
オブジェクトをサポートしています。Column
、Row
、Box
の各コンポーザブルを所定の Scaffold
オブジェクト内に配置します。
これらのコンポーザブルでは、修飾子を使用して、コンテンツの垂直方向と水平方向の配置と、幅、高さ、太さ、パディングの制約を定義できます。さらに、それぞれの子で修飾子を定義して、親内のスペースと配置を変更できます。
次の例は、図 1 に示すように、子を水平方向に均等に分配する Row
の作成方法を示しています。
Row(modifier = GlanceModifier.fillMaxWidth().padding(16.dp)) { val modifier = GlanceModifier.defaultWeight() Text("first", modifier) Text("second", modifier) Text("third", modifier) }
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() ) } }
個々のアイテムを指定します。
LazyColumn { item { Text("First Item") } item { Text("Second Item") } }
項目のリストまたは配列を指定します。
LazyColumn { items(peopleNameList) { name -> Text(name) } }
前述の例を組み合わせて使用することもできます。
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") } }
前のスニペットでは itemId
を指定していないことに注意してください。itemId
を指定すると、パフォーマンスを向上させ、Android 12 以降のリストと appWidget
の更新を通じてスクロール位置を維持できます(たとえば、リストのアイテムを追加または削除する場合)。次の例は、itemId
を指定する方法を示しています。
items(items = peopleList, key = { person -> person.id }) { person -> Text(person.name) }
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 // ... } }
このモードを使用する場合は、次のことを確認してください。
- 最小サイズと最大サイズのメタデータ値が、コンテンツ サイズに基づいて適切に定義されている。
- コンテンツが、想定されたサイズ範囲内で十分に柔軟であること。
一般に、次の場合にこのモードを使用する必要があります。
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") } } } }
上記の例では、provideContent
メソッドが 3 回呼び出され、定義されたサイズにマッピングされています。
- 最初の呼び出しで、サイズは
100x100
と評価されます。コンテンツには、追加ボタンや上下のテキストは含まれません。 - 2 番目の呼び出しでは、サイズは
250x100
と評価されます。コンテンツには追加のボタンが含まれますが、上下のテキストは含まれません。 - 3 番目の呼び出しでは、サイズは
250x250
と評価されます。コンテンツには、追加のボタンと両方のテキストが含まれています。
SizeMode.Responsive
は他の 2 つのモードを組み合わせたもので、事前定義された境界内でレスポンシブ コンテンツを定義できます。一般に、このモードのほうがパフォーマンスに優れ、AppWidget
のサイズを変更したときによりスムーズに遷移できます。
次の表に、SizeMode
と AppWidget
の使用可能なサイズに応じたサイズの値を示します。
利用可能なサイズ | 105×110 | 203×112 | 72×72 | 203×150 |
---|---|---|---|---|
SizeMode.Single |
110×110 | 110×110 | 110×110 | 110×110 |
SizeMode.Exact |
105×110 | 203×112 | 72×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") } } } } }
このモードは他のモードよりも柔軟性がありますが、いくつかの注意点があります。
- サイズが変更されるたびに、
AppWidget
を完全に再作成する必要があります。コンテンツが複雑な場合、パフォーマンスの問題や UI の切り替わりが発生する可能性があります。 - 使用可能なサイズは、ランチャーの実装によって異なる場合があります。たとえば、ランチャーでサイズのリストが提供されない場合は、最小サイズが使用されます。
- Android 12 より前のデバイスでは、サイズ計算ロジックがすべての状況で機能するとは限りません。
一般に、SizeMode.Responsive
を使用できない場合(つまり、少数のレスポンシブ レイアウト セットを使用できない場合)に、このモードを使用する必要があります。
リソースにアクセスする
任意の Android リソースにアクセスするには、次の例に示すように LocalContext.current
を使用します。
LocalContext.current.getString(R.string.glance_title)
最終的な 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", )
テキストを処理する
Glance 1.1.0 には、テキストのスタイルを設定するための API が含まれています。TextStyle クラスの fontSize
属性、fontWeight
属性、fontFamily
属性を使用して、テキスト スタイルを設定します。
次の例に示すように、fontFamily
はすべてのシステム フォントをサポートしますが、アプリのカスタム フォントはサポートされていません。
Text(
style = TextStyle(
fontWeight = FontWeight.Bold,
fontSize = 18.sp,
fontFamily = FontFamily.Monospace
),
text = "Example Text"
)
複合ボタンを追加する
複合ボタンは 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" )
状態が変化すると、指定されたラムダがトリガーされます。次の例に示すように、チェック状態を保存できます。
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) } ) } }
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) ), )
追加コンポーネント
Glance 1.1.0 には、次の表に示す追加コンポーネントのリリースが含まれています。
名前 | 画像 | 参照リンク | その他の注意事項 |
---|---|---|---|
塗りつぶしボタン | コンポーネント | ||
アウトライン ボタン | コンポーネント | ||
アイコンボタン | コンポーネント | メイン / セカンダリ / アイコンのみ | |
タイトルバー | コンポーネント | ||
Scaffold | スキャフォールドとタイトルバーは同じデモにあります。 |
設計の詳細については、Figma の設計キットにあるコンポーネント設計をご覧ください。