W sekcjach poniżej opisujemy, jak utworzyć prosty widżet aplikacji za pomocą Glance.
Zadeklaruj AppWidget
w pliku manifestu
Po zakończeniu czynności konfiguracji zadeklaruj w aplikacji AppWidget
i jego metadane.
- Zarejestruj dostawcę widżetu aplikacji w pliku
AndroidManifest.xml
i powiązanym pliku metadanych:
<receiver android:name=".glance.MyReceiver"
android:exported="true">
<intent-filter>
<action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
</intent-filter>
<meta-data
android:name="android.appwidget.provider"
android:resource="@xml/my_app_widget_info" />
</receiver>
- Rozszerz odbiornik
AppWidget
z przeglądarkiGlanceAppWidgetReceiver
:
class MyAppWidgetReceiver : GlanceAppWidgetReceiver() { override val glanceAppWidget: GlanceAppWidget = TODO("Create GlanceAppWidget") }
Dodaj metadane AppWidgetProviderInfo
Następnie dodaj metadane AppWidgetProviderInfo
, wykonując te czynności:
Postępuj zgodnie z przewodnikiem Tworzenie prostego widżetu, aby utworzyć i zdefiniować informacje o widżetach aplikacji w pliku
@xml/my_app_widget_info
.Jedyną różnicą w przypadku Glance jest to, że nie ma kodu XML
initialLayout
, ale musisz go zdefiniować. Możesz użyć wstępnie zdefiniowanego układu wczytywania, dostępnego w bibliotece:
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
android:initialLayout="@layout/glance_default_loading_layout">
</appwidget-provider>
Podaj definicję słowa GlanceAppWidget
Utwórz nową klasę, która zaczyna się od
GlanceAppWidget
i zastępuje metodęprovideGlance
. Oto metoda, która pozwala wczytać dane potrzebne do wyrenderowania widżetu:
class MyAppWidget : GlanceAppWidget() { override suspend fun provideGlance(context: Context, id: GlanceId) { // In this method, load data needed to render the AppWidget. // Use `withContext` to switch to another thread for long running // operations. provideContent { // create your AppWidget here Text("Hello World") } } }
- Utwórz instancję w
glanceAppWidget
na urządzeniuGlanceAppWidgetReceiver
:
class MyAppWidgetReceiver : GlanceAppWidgetReceiver() { // Let MyAppWidgetReceiver know which GlanceAppWidget to use override val glanceAppWidget: GlanceAppWidget = MyAppWidget() }
Udało Ci się skonfigurować urządzenie AppWidget
za pomocą Glance.
Utwórz interfejs
Ten fragment kodu pokazuje, jak utworzyć interfejs użytkownika:
/* Import Glance Composables In the event there is a name clash with the Compose classes of the same name, you may rename the imports per https://kotlinlang.org/docs/packages.html#imports using the `as` keyword. import androidx.glance.Button import androidx.glance.layout.Column import androidx.glance.layout.Row import androidx.glance.text.Text */ class MyAppWidget : GlanceAppWidget() { override suspend fun provideGlance(context: Context, id: GlanceId) { // Load data needed to render the AppWidget. // Use `withContext` to switch to another thread for long running // operations. provideContent { // create your AppWidget here GlanceTheme { MyContent() } } } @Composable private fun MyContent() { Column( modifier = GlanceModifier.fillMaxSize() .background(GlanceTheme.colors.background), verticalAlignment = Alignment.Top, horizontalAlignment = Alignment.CenterHorizontally ) { Text(text = "Where to?", modifier = GlanceModifier.padding(12.dp)) Row(horizontalAlignment = Alignment.CenterHorizontally) { Button( text = "Home", onClick = actionStartActivity<MyActivity>() ) Button( text = "Work", onClick = actionStartActivity<MyActivity>() ) } } } }
Poprzedni przykładowy kod wykonuje te czynności:
- Na najwyższym poziomie
Column
elementy są umieszczane jeden po drugim w pionie. - Element
Column
powiększa swój rozmiar, aby dopasować się do dostępnego miejsca (po użyciu elementuGlanceModifier
), wyrównuje jego zawartość do górnej krawędzi (verticalAlignment
) i wyśrodkowuje ją w poziomie (horizontalAlignment
). - Zawartość obiektu
Column
jest definiowana za pomocą funkcji lambda. Kolejność ma znaczenie.- Pierwszym elementem
Column
jest komponentText
z12.dp
dopełnieniem. - Drugi element to
Row
, w którym elementy są umieszczone jeden po drugim w poziomie, a 2 elementyButtons
są wyśrodkowane w poziomie (horizontalAlignment
). Ostateczny sposób wyświetlania zależy od dostępnego miejsca. Poniższy obraz jest przykładem, jak może to wyglądać:
- Pierwszym elementem
Aby zmienić położenie i rozmiar komponentów, możesz zmienić wartości wyrównania lub zastosować różne wartości modyfikatorów (np. dopełnienie). Pełną listę komponentów, parametrów i dostępnych modyfikatorów dla poszczególnych klas znajdziesz w dokumentacji referencyjnej.