Glance

Glance

  コードサンプル

API リファレンス
androidx.glance

Jetpack Compose スタイルの API を使用して、リモート サーフェスのレイアウトを作成します。

最新の更新	安定版リリース	リリース候補版	ベータ版リリース	アルファ版リリース
2022 年 10 月 5 日	-	-	-	1.0.0-alpha05

依存関係の宣言

Glance への依存関係を追加するには、Google の Maven リポジトリをプロジェクトに追加する必要があります。詳しくは、Google の Maven リポジトリをご覧ください。

アプリまたはモジュールの build.gradle ファイルに、必要なアーティファクトの依存関係を追加します。

Groovy

dependencies {
    // For AppWidgets support
    implementation "androidx.glance:glance-appwidget:1.0.0-alpha05"

    // For Wear-Tiles support
    implementation "androidx.glance:glance-wear-tiles:1.0.0-alpha05"
}

android {
    buildFeatures {
        compose true
    }

    composeOptions {
        kotlinCompilerExtensionVersion = "1.1.0-beta03"
    }

    kotlinOptions {
        jvmTarget = "1.8"
    }
}

Kotlin

dependencies {
    // For AppWidgets support
    implementation("androidx.glance:glance-appwidget:1.0.0-alpha05")

    // For Wear-Tiles support
    implementation("androidx.glance:glance-wear-tiles:1.0.0-alpha05")
}

android {
    buildFeatures {
        compose = true
    }

    composeOptions {
        kotlinCompilerExtensionVersion = "1.1.0-beta03"
    }

    kotlinOptions {
        jvmTarget = "1.8"
    }
}

依存関係について詳しくは、ビルド依存関係の追加をご覧ください。

フィードバック

お寄せいただいたフィードバックは Jetpack 改善の参考にさせていただきます。新しい問題が見つかった場合や、このライブラリを改善するアイデアをお持ちの場合は、お知らせください。新しい問題を報告していただく前に、このライブラリの既存の問題をご確認ください。スターボタンをクリックすると、既存の問題に投票できます。

新しい問題を報告する

詳細については、Issue Tracker のドキュメントをご覧ください。

バージョン 1.0.0

バージョン 1.0.0-alpha05

2022 年 10 月 5 日

androidx.glance:glance:1.0.0-alpha05、androidx.glance:glance-appwidget:1.0.0-alpha05、androidx.glance:glance-wear-tiles:1.0.0-alpha05 がリリースされました。バージョン 1.0.0-alpha05 に含まれる commit については、こちらをご覧ください。

新機能

• GlanceAppWidgetManager に requestPinGlanceAppWidget を追加し、ホーム画面に Glance ベースのウィジェットを追加するようユーザーに促すプロンプトをアプリで表示できるようにしました。（Ic6e47）
• GlanceAppWidgetReceiver に ACTION_DEBUG_UPDATE を追加し、デベロッパーが、ユーザーに root 権限のあるデバイスとエミュレータ上で adb からウィジェットを強制的に更新できるようにしました。（I94ae1）

API の変更

• Glance テンプレートのヘッダー アクション ボタンを削除し、ユースケースを簡素化しました。（Ie4387）
• ブロック サブシステムの設計を再利用するように、単一エンティティ テンプレートをリファクタリングしました。（Iecd2c）
• Text/Image/Action ブロックの設計を使用するように、Glance リスト テンプレートをリファクタリングしました。（If0cc1）
• TextBlock と ImageBlock の優先度の数値の範囲を追加しました。（I73100）

バグの修正

• マテリアル 3 の依存関係を削除しました。（I28d1c）
• Glance テンプレートのレイアウトに余白やスペースを追加できるように、一貫性のあるシステムに移行しました。（I29773）
• 圧縮リリースによるビルドがブロックされていた、不正な形式の Proguard ルールを修正しました。

バージョン 1.0.0-alpha04

2022 年 8 月 10 日

androidx.glance:glance:1.0.0-alpha04、androidx.glance:glance-appwidget:1.0.0-alpha04、androidx.glance:glance-wear-tiles:1.0.0-alpha04 がリリースされました。バージョン 1.0.0-alpha04 に含まれる commit については、こちらをご覧ください。

新機能

• ボタンの色分け機能を追加しました。
• コンパイル時のチェックに役立つ GlanceComposable アノテーションを追加しました。
• Wear 固有の Glance 機能を追加しました。

API の変更

• Glance Gallery Data API と簡略ビューを更新しました。（Ibc7a8）
• ボタンを設定するための ButtonColors を追加しました。（Iea88d、b/236305351）
• ColorProvider.resolve の名前を ColorProvider.getColor に変更しました。（Ic9dfe）
• TextStyle に copy() メソッドを追加しました。（I9aef6）
• Glance のテーマの一部として使用できる ColorProviders クラスを追加しました。（I848b9、b/237012816）
• リストのスタイルと折りたたみビューにリスト テンプレートのサポートを追加しました。（I50cdc）
• GlanceModiier と GlanceCurvedModifier にセマンティクスを追加しました。（Ifda7e）
• GlanceComposable アノテーションを追加しました。（I5dbf0）
• Glance テンプレートをメインの Glance プロジェクトに移動しました。（I9db94）
• ColorProvider.resolve() を追加しました。（Ife532、b/214733442）
• 既存の appWidgetId から GlanceId を取得する、または設定アクティビティからインテントを取得する、新しいメソッドを追加しました。（Icb70c、b/230391946）
• GlanceComposable アノテーションを追加しました。（I2c21f）
• GlanceAppWidget の外部でコンポジションを実行する GlanceRemoteViews を追加しました。（I18f92）
• ProgressIndicatorDefaults の色を削除しました。（I40299）
• API レビューのフィードバックに従って公開 API との整合性を保つため、ActionCallback の onRun メソッドの名前を onAction に変更しました。（Icfa57）
• 地図を使用するように Glance テンプレートのレイアウトを変換しました。（I46bfd）
• RadioButton コンポーザブルを追加しました。（I4ecce）
• Wear Tiles を作成するための GlanceWearTiles を追加しました。（Ia9f65）
• GlanceCurvedModifier にクリック可能な要素を追加しました。（Iec2a0）
• CurvedRow をスコープとして実装し、通常のコンポーザブル要素または曲線要素を追加する DSL を作成します。また curvedLine と curvedSpacer を追加しました。これは proto タイルでそれぞれ ArcLine と ArcSpacer に変換されます。（Ib955b）
• Tiramisu DP2 と一致するよう core と appcompat の null 可能性を更新しました。（I0cbb7）
• glance-wear-tiles での RuncallbackAction のサポートを追加しました。現時点では、パラメータなしの RunCallbackAction のみがサポートされます。（Ide64a）

外部からの協力

• test-coroutines-lib の移行により :compose:ui:ui-test API（updateApi）を更新しました。（I3366d）

バージョン 1.0.0-alpha03

2022 年 2 月 23 日

androidx.glance:glance-*:1.0.0-alpha03 がリリースされました。バージョン 1.0.0-alpha03 に含まれる commit については、こちらをご覧ください。

新機能

• 状態定義をデフォルトの Preferences に簡略化しました。

API の変更

• 状態処理を、PreferencesGlanceStateDefinition をデフォルトの状態処理にすることで簡略化しました。GlanceAppWidget.updateAppWidgetState を削除し、デフォルトで Preferences を使用する updateAppWidgetState を導入しました。（I58963）
• Glance TemplateText クラスを追加し、テンプレート デザインを更新しました。（I4e146）
• Freeform テンプレート用のアウトライン インフラストラクチャを追加しました。（If03d6）
• SingleEntityTemplate レイアウトの更新（If925d）
• LazyVerticalGrid を追加しました（I5f442）
• SingleEntityTemplate で ColorProvider を使用します（I01ee0）
• テンプレート クラス名を更新しました（I3720e）
• LinearProgressIndicator と CircularProgressIndicator コンポーザブルを追加しました。（Ie116b）

バグの修正

• 初期 glance テンプレートの実装、「単一アイテム テンプレート」データとサンプル テンプレート レイアウトの定義（I35837）
• タイル コンテンツをデフォルトで中央に揃えます（I264be）
• glance-wear-tiles での fillMaxSize / Width / Height のバグを修正しました（I0a39f）

バージョン 1.0.0-alpha02

2022 年 1 月 26 日

androidx.glance:glance-*:1.0.0-alpha02 がリリースされました。バージョン 1.0.0-alpha02 に含まれる commit については、こちらをご覧ください。

新機能

このリリースには、Compose ランタイムを使用して Wear Tiles を作成するための API セットと、「一目でわかる」ように最適化されたコンポーザブルが含まれています。

• GlanceTileService（コンポーズ可能な Content() 関数内でタイルを作成するサービス）を拡張することにより、Wear Tiles のサービスを宣言します。
• Wear Tiles 専用の Glance コンポーザブルとして、CurvedRow と CurvedText があります。
• TimelineMode.SingleEntry と TimelineMode.TimeBoundEntries を定義することで、タイルのさまざまなタイムライン モードを処理できます。
• ローカル コンポジション LocalTimeInterval は特定の時間間隔を参照します。
• BorderModifer は、要素の周囲に枠線を付ける GlanceModifier です。

また、今回のリリースでは、AppWidget Glance に進行状況インジケーターも追加しました。

API の変更

• LinearProgressIndicator と CircularProgressIndicator コンポーザブルを追加しました。（Ie116b）
• actionStartBroadcastReceiver を actionSendBroadcast に変更しました。（I7d555）
• GlanceAppWidget onDelete コールバックにコンテキストを渡すようにしました。（I4c795）

バグの修正

• 空の OPTIONS_APPWIDGET_SIZES が存在する場合の処理を修正しました。（I01f82）

バージョン 1.0.0-alpha01

2021 年 12 月 15 日

androidx.glance:glance:1.0.0-alpha01、androidx.glance:glance-appwidget:1.0.0-alpha01、androidx.glance:glance-appwidget-proto:1.0.0-alpha01 がリリースされました。バージョン 1.0.0-alpha01 に含まれる commit については、こちらをご覧ください。

初回リリースの機能

• Glance の初回リリースには、Compose Runtime を使用して AppWidget を作成する最初の API セットと、「Glanceables」に最適化された新しいコンポーザブルのセットが含まれています。

注: Glance はコンポーザブルの独自のセットを使用します。androidx.compose コンポーザブルと androidx.glance コンポーザブルを組み合わせないでください。

機能

• GlanceAppWidget と GlanceAppWidgetReceiver を使用してアプリ ウィジェットを宣言します。
• Glance コンポーザブルの初期のセット（Box、Row、Column、Text、Button、LazyColumn、Image、Spacer）で UI を作成します。
• GlanceModifier メソッドを使用してコンポーザブルに修飾子を適用します。
• 事前定義された Action を使用してユーザー操作を処理します。
  • actionStartActivity
  • actionRunCallback
  • actionStartService
  • actionStartBroadcastReceiver
• ActionParameters で Action にパラメータを指定します。
• SizeMode.Single、SizeMode.Exact、または SizeMode.Responsive を定義することで、各種のサイズモードを処理します。
• GlanceStateDefinition を指定することで GlanceAppWidget の状態を維持します。
• LocalContext、LocalState、LocalGlanceId、LocalSize などのローカル コンポジション。
• AndroidRemoteViews Composable で、既存の RemoteViews と相互運用します。