Menambahkan widget Layar Utama ke Aplikasi Flutter Anda

1. Pengantar

Apa itu Widget?

Bagi developer Flutter, definisi umum widget mengacu pada komponen UI yang dibuat menggunakan framework Flutter. Dalam konteks codelab ini, widget mengacu pada versi mini aplikasi yang memberikan tampilan informasi aplikasi tanpa membuka aplikasi. Di Android, widget berada di layar utama. Di iOS, widget dapat ditambahkan ke layar utama, layar kunci, atau tampilan hari ini.

Sebagian besar widget Layar Utama sederhana. Notifikasi ini mungkin berisi teks dasar, grafis sederhana, atau, di Android, kontrol dasar. Android dan iOS membatasi komponen dan fitur UI yang dapat Anda gunakan.

Membuat UI untuk Widget

Karena batasan UI ini, Anda tidak dapat langsung menggambar UI widget Layar Utama menggunakan framework Flutter. Sebagai gantinya, Anda dapat menambahkan widget yang dibuat dengan framework platform seperti Jetpack Compose atau SwiftUI ke aplikasi Flutter. Codelab ini membahas contoh untuk berbagi resource antara aplikasi dan widget Anda guna menghindari penulisan ulang UI yang kompleks.

Yang akan Anda bangun

Dalam codelab ini, Anda akan membuat widget Layar Utama di Android dan iOS untuk aplikasi Flutter sederhana, menggunakan paket home_widget, yang memungkinkan pengguna membaca artikel. Widget Anda akan:

Menampilkan data dari aplikasi Flutter Anda.
Menampilkan teks menggunakan aset font yang dibagikan dari aplikasi Flutter.
Menampilkan gambar widget Flutter yang dirender.

Aplikasi Flutter ini mencakup dua layar (atau rute):

Yang pertama menampilkan daftar artikel berita dengan judul dan deskripsi.
Yang kedua menampilkan artikel lengkap dengan diagram yang dibuat menggunakan CustomPaint.

Yang akan Anda pelajari

Cara membuat widget Layar Utama di iOS dan Android.
Cara menggunakan paket home_widget untuk membagikan data antara widget Layar Utama dan aplikasi Flutter Anda.
Cara mengurangi jumlah kode yang perlu Anda tulis ulang.
Cara memperbarui widget Layar Utama dari aplikasi Flutter Anda.

2. Menyiapkan lingkungan pengembangan

Untuk kedua platform, Anda memerlukan Flutter SDK dan IDE. Anda dapat menggunakan IDE pilihan Anda untuk bekerja dengan Flutter. Anda dapat menggunakan Visual Studio Code dengan ekstensi Dart Code dan Flutter, atau Android Studio atau IntelliJ dengan plugin Flutter dan Dart yang sudah diinstal.

Anda dapat menjalankan codelab ini di perangkat iOS fisik atau simulator iOS.
Anda harus mengonfigurasi sistem macOS dengan Xcode IDE. Tindakan ini akan menginstal compiler yang diperlukan untuk membuat versi iOS aplikasi Anda.

Anda dapat menjalankan codelab ini di perangkat Android fisik atau emulator Android.
Anda harus mengonfigurasi sistem pengembangan dengan Android Studio. Tindakan ini akan menginstal compiler yang diperlukan untuk membuat aplikasi versi Android.

Mendapatkan kode awal

Download project versi awal Anda dari GitHub

Dari command line, clone repositori GitHub ke direktori flutter-codelabs:

$ git clone https://github.com/flutter/codelabs.git flutter-codelabs

Setelah meng-clone repo, Anda dapat menemukan kode untuk codelab ini di direktori flutter-codelabs/homescreen_codelab. Direktori ini berisi kode project yang sudah selesai untuk setiap langkah di codelab.

Membuka aplikasi awal

Buka direktori flutter-codelabs/homescreen_codelab/step_03 di IDE pilihan Anda.

Menginstal paket

Semua paket yang diperlukan telah ditambahkan ke file pubspec.yaml project. Untuk mengambil dependensi project, jalankan perintah berikut:

$ flutter pub get

3. Menambahkan widget Layar Utama dasar

Pertama, tambahkan widget Layar Utama menggunakan alat platform bawaan.

Menambahkan ekstensi aplikasi ke aplikasi iOS Flutter mirip dengan menambahkan ekstensi aplikasi ke aplikasi SwiftUI atau UIKit:

Jalankan open ios/Runner.xcworkspace di jendela terminal dari direktori project Flutter Anda. Atau, klik kanan folder ios dari VSCode, lalu pilih Open in Xcode. Tindakan ini akan membuka ruang kerja Xcode default di project Flutter Anda.
Pilih File → New → Target dari menu. Tindakan ini akan menambahkan target baru ke project.
Daftar template akan muncul. Pilih Ekstensi Widget.
Ketik "NewsWidgets" di kotak Product Name untuk widget ini. Hapus centang pada kotak Sertakan Aktivitas Live dan Sertakan Maksud Konfigurasi.

Periksa kode contoh

Saat Anda menambahkan target baru, Xcode akan membuat kode contoh berdasarkan template yang Anda pilih. Untuk mengetahui informasi selengkapnya tentang kode yang dihasilkan dan WidgetKit, lihat dokumentasi ekstensi aplikasi Apple.

Pertama, perbarui konfigurasi aplikasi Flutter Anda. Anda harus melakukannya saat menambahkan paket baru di aplikasi Flutter dan berencana menjalankan target dalam project dari Xcode. Untuk mengupdate konfigurasi aplikasi, jalankan perintah berikut di direktori aplikasi Flutter Anda:

$ flutter build ios --config-only

Klik Runner untuk menampilkan daftar target. Pilih target widget yang baru saja Anda buat, NewsWidgets, lalu klik Run. Jalankan target widget dari Xcode saat Anda mengubah kode widget iOS.

Layar simulator atau perangkat akan menampilkan widget Layar Utama dasar. Jika tidak melihatnya, Anda dapat menambahkannya ke layar. Klik lama layar utama, lalu klik + di pojok kiri atas.

Telusuri nama aplikasi. Untuk codelab ini, telusuri "Widget Layar Utama"

Setelah Anda menambahkan widget Layar Utama, widget tersebut akan menampilkan teks sederhana yang menunjukkan waktu.

Untuk menambahkan widget Layar Utama di Android, buka file build project di Android Studio. Anda dapat menemukan file ini di android/build.gradle. Atau, klik kanan folder android dari VSCode, lalu pilih Open in Android Studio.
Setelah project dibuat, temukan direktori aplikasi di pojok kiri atas. Tambahkan widget Layar Utama baru Anda ke direktori ini. Klik kanan direktori, pilih New -> Widget -> App Widget.

Android Studio akan menampilkan formulir baru. Tambahkan informasi dasar tentang widget Layar Utama Anda, termasuk nama class, penempatan, ukuran, dan bahasa sumbernya

Untuk codelab ini, tetapkan nilai berikut:

Class Name menjadi NewsWidget
Dropdown Lebar Minimum (sel) menjadi 3
Dropdown Tinggi Minimum (sel) menjadi 3

Periksa kode contoh

Saat Anda mengirimkan formulir, Android Studio akan membuat dan memperbarui beberapa file. Perubahan yang relevan untuk codelab ini tercantum dalam tabel di bawah

Tindakan	File Target	Ubah
Perbarui	`AndroidManifest.xml`	Menambahkan penerima baru yang mendaftarkan NewsWidget.
Buat	`res/layout/news_widget.xml`	Mendefinisikan UI widget Layar Utama.
Buat	`res/xml/news_widget_info.xml`	Menentukan konfigurasi widget Layar Utama Anda. Anda dapat menyesuaikan dimensi atau nama widget di file ini.
Buat	`java/com/example/homescreen_widgets/NewsWidget.kt`	Berisi kode Kotlin untuk menambahkan fungsi ke widget Layar Utama.

Anda dapat menemukan detail selengkapnya tentang file ini di sepanjang codelab ini.

Men-debug dan menguji widget contoh

Sekarang, jalankan aplikasi Anda dan lihat widget Layar Utama. Setelah Anda membuat aplikasi, buka layar pemilihan aplikasi di perangkat Android Anda, lalu tekan lama ikon untuk project Flutter ini. Pilih Widget dari menu pop-up.

Perangkat atau emulator Android menampilkan widget Layar Utama default Anda untuk Android.

4. Mengirim data dari aplikasi Flutter ke widget Layar Utama

Anda dapat menyesuaikan widget Layar Utama dasar yang Anda buat. Perbarui widget Layar Utama untuk menampilkan judul dan ringkasan artikel berita. Screenshot berikut menampilkan contoh widget Layar Utama yang menampilkan judul dan ringkasan.

Untuk meneruskan data antara aplikasi dan widget Layar Utama, Anda perlu menulis kode Dart dan native. Bagian ini membagi proses ini menjadi tiga bagian:

Menulis kode Dart di aplikasi Flutter yang dapat digunakan oleh Android dan iOS
Menambahkan fungsi iOS native
Menambahkan fungsi Android native

Menggunakan Grup Aplikasi iOS

Untuk membagikan data antara aplikasi induk iOS dan ekstensi widget, kedua target harus termasuk dalam grup aplikasi yang sama. Untuk mempelajari lebih lanjut grup aplikasi, lihat dokumentasi grup aplikasi Apple.

Perbarui ID paket Anda:

Di Xcode, buka setelan target Anda. Di tab Signing & Capabilities, pastikan tim dan ID paket Anda telah ditetapkan.

Tambahkan Grup Aplikasi ke kedua target Runner dan target NewsWidgetExtension di Xcode:

Pilih + Kemampuan -> Grup Aplikasi dan tambahkan Grup Aplikasi baru. Ulangi untuk target Runner (aplikasi induk) dan target widget.

Tambahkan kode Dart

Aplikasi iOS dan Android dapat membagikan data ke aplikasi Flutter dengan beberapa cara berbeda.Untuk berkomunikasi dengan aplikasi ini, manfaatkan penyimpanan key/value lokal perangkat. iOS menyebut penyimpanan ini UserDefaults, dan Android menyebut penyimpanan ini SharedPreferences. Paket home_widget membungkus API ini untuk menyederhanakan penyimpanan data ke salah satu platform dan memungkinkan widget Layar Utama menarik data yang diperbarui.

Data judul dan deskripsi berasal dari file news_data.dart. File ini berisi data tiruan dan class data NewsArticle.

lib/news_data.dart

class NewsArticle {
  final String title;
  final String description;
  final String? articleText;

  NewsArticle({
    required this.title,
    required this.description,
    this.articleText = loremIpsum,
  });
}

Perbarui nilai judul dan deskripsi

Untuk menambahkan fungsi guna memperbarui widget Layar Utama dari aplikasi Flutter, buka file lib/home_screen.dart. Ganti konten file dengan kode berikut. Kemudian, ganti <YOUR APP GROUP> dengan ID untuk Grup Aplikasi Anda.

lib/home_screen.dart

import 'package:flutter/material.dart';
import 'package:home_widget/home_widget.dart';             // Add this import

import 'article_screen.dart';
import 'news_data.dart';

// TODO: Replace with your App Group ID
const String appGroupId = '<YOUR APP GROUP>';              // Add from here
const String iOSWidgetName = 'NewsWidgets';
const String androidWidgetName = 'NewsWidget';             // To here.

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key});
  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

void updateHeadline(NewsArticle newHeadline) {             // Add from here
  // Save the headline data to the widget
  HomeWidget.saveWidgetData<String>('headline_title', newHeadline.title);
  HomeWidget.saveWidgetData<String>(
      'headline_description', newHeadline.description);
  HomeWidget.updateWidget(
    iOSName: iOSWidgetName,
    androidName: androidWidgetName,
  );
}                                                          // To here.

class _MyHomePageState extends State<MyHomePage> {

  @override                                                // Add from here
  void initState() {
    super.initState();

    HomeWidget.setAppGroupId(appGroupId);

    // Mock read in some data and update the headline
    final newHeadline = getNewsStories()[0];
    updateHeadline(newHeadline);
  }                                                        // To here.

  @override
  Widget build(BuildContext context) {
    return Scaffold(
        appBar: AppBar(
            title: const Text('Top Stories'),
            centerTitle: false,
            titleTextStyle: const TextStyle(
                fontSize: 30,
                fontWeight: FontWeight.bold,
                color: Colors.black)),
        body: ListView.separated(
          separatorBuilder: (context, idx) {
            return const Divider();
          },
          itemCount: getNewsStories().length,
          itemBuilder: (context, idx) {
            final article = getNewsStories()[idx];
            return ListTile(
              key: Key('$idx ${article.hashCode}'),
              title: Text(article.title!),
              subtitle: Text(article.description!),
              onTap: () {
                Navigator.of(context).push(
                  MaterialPageRoute(
                    builder: (context) {
                      return ArticleScreen(article: article);
                    },
                  ),
                );
              },
            );
          },
        ));
  }
}

Fungsi updateHeadline menyimpan pasangan kunci/nilai ke penyimpanan lokal perangkat Anda. Kunci headline_title menyimpan nilai newHeadline.title. Kunci headline_description menyimpan nilai newHeadline.description. Fungsi ini juga memberi tahu platform native bahwa data baru untuk widget Layar Utama dapat diambil dan dirender.

Mengubah floatingActionButton

Panggil fungsi updateHeadline saat floatingActionButton ditekan seperti yang ditunjukkan:

lib/article_screen.dart

// New: import the updateHeadline function
import 'home_screen.dart';

...

floatingActionButton: FloatingActionButton.extended(
        onPressed: () {
          ScaffoldMessenger.of(context).showSnackBar(const SnackBar(
            content: Text('Updating home screen widget...'),
          ));
          // New: call updateHeadline
          updateHeadline(widget.article);
        },
        label: const Text('Update Homescreen'),
      ),
...

Dengan perubahan ini, saat pengguna menekan tombol Perbarui Judul dari halaman artikel, detail widget Layar Utama akan diperbarui.

Perbarui kode iOS untuk menampilkan data artikel

Untuk memperbarui widget Layar Utama untuk iOS, gunakan Xcode.

Buka file NewsWidgets.swift di Xcode:

Konfigurasi `TimelineEntry`.

Ganti struct SimpleEntry dengan kode berikut:

ios/NewsWidgets/NewsWidgets.swift

// The date and any data you want to pass into your app must conform to TimelineEntry
struct NewsArticleEntry: TimelineEntry {
    let date: Date
    let title: String
    let description:String
}

Struktur NewsArticleEntry ini menentukan data masuk yang akan diteruskan ke widget Layar Utama saat diperbarui. Jenis TimelineEntry memerlukan parameter tanggal.Untuk mempelajari lebih lanjut protokol TimelineEntry, lihat dokumentasi TimelineEntry Apple.

Edit `View` yang menampilkan konten

Ubah widget Layar Utama Anda untuk menampilkan judul dan deskripsi artikel berita, bukan tanggal. Untuk menampilkan teks di SwiftUI, gunakan tampilan Text. Untuk menumpuk tampilan di atas satu sama lain di SwiftUI, gunakan tampilan VStack.

Ganti tampilan NewsWidgetEntryView yang dibuat dengan kode berikut:

ios/NewsWidgets/NewsWidgets.swift

//View that holds the contents of the widget
struct NewsWidgetsEntryView : View {
    var entry: Provider.Entry

    var body: some View {
      VStack {
        Text(entry.title)
        Text(entry.description)
      }
    }
}

Ganti Provider yang ada dengan kode berikut. Kemudian, ganti <YOUR APP GROUP> dengan ID grup aplikasi Anda:

ios/NewsWidgets/NewsWidgets.swift

struct Provider: TimelineProvider {

// Placeholder is used as a placeholder when the widget is first displayed
    func placeholder(in context: Context) -> NewsArticleEntry {
//      Add some placeholder title and description, and get the current date
      NewsArticleEntry(date: Date(), title: "Placeholder Title", description: "Placeholder description")
    }

// Snapshot entry represents the current time and state
    func getSnapshot(in context: Context, completion: @escaping (NewsArticleEntry) -> ()) {
      let entry: NewsArticleEntry
      if context.isPreview{
        entry = placeholder(in: context)
      }
      else{
        //      Get the data from the user defaults to display
        let userDefaults = UserDefaults(suiteName: <YOUR APP GROUP>)
        let title = userDefaults?.string(forKey: "headline_title") ?? "No Title Set"
        let description = userDefaults?.string(forKey: "headline_description") ?? "No Description Set"
        entry = NewsArticleEntry(date: Date(), title: title, description: description)
      }
        completion(entry)
    }

//    getTimeline is called for the current and optionally future times to update the widget
    func getTimeline(in context: Context, completion: @escaping (Timeline<Entry>) -> ()) {
//      This just uses the snapshot function you defined earlier
      getSnapshot(in: context) { (entry) in
// atEnd policy tells widgetkit to request a new entry after the date has passed
        let timeline = Timeline(entries: [entry], policy: .atEnd)
                  completion(timeline)
              }
    }
}

Provider dalam kode sebelumnya sesuai dengan TimelineProvider. Provider memiliki tiga metode yang berbeda:

Metode placeholder menghasilkan entri placeholder saat pengguna pertama kali melihat pratinjau widget Layar Utama.

Metode getSnapshot membaca data dari default pengguna dan membuat entri untuk waktu saat ini.
Metode getTimeline menampilkan entri linimasa. Hal ini akan membantu jika Anda memiliki waktu yang dapat diprediksi untuk memperbarui konten. Codelab ini menggunakan fungsi getSnapshot untuk mendapatkan status saat ini. Metode.atEnd memberi tahu widget Layar Utama untuk memuat ulang data setelah waktu saat ini berlalu.

Beri komentar pada `NewsWidgets_Previews`

Penggunaan pratinjau berada di luar cakupan codelab ini. Untuk mengetahui detail selengkapnya tentang pratinjau widget Layar Utama SwiftUI, lihat Dokumentasi Apple tentang Debugging Widget.

Jalankan kembali target untuk memvalidasi bahwa aplikasi dan widget Layar Utama berfungsi.

Pilih skema aplikasi di Xcode untuk menjalankan target aplikasi.
Pilih skema ekstensi di Xcode untuk menjalankan target ekstensi.
Buka halaman artikel di aplikasi.
Klik tombol untuk memperbarui judul. Widget Layar Utama juga akan memperbarui judul.

Memperbarui kode Android

Di Android Studio, perbarui file yang dibuat pada langkah sebelumnya.Buka file res/layout/news_widget.xml. Menentukan struktur dan tata letak widget layar utama Anda. Pilih Code di sudut kanan atas dan ganti konten file tersebut dengan kode berikut:

android/app/res/layout/news_widget.xml

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
   xmlns:app="http://schemas.android.com/apk/res-auto"
   xmlns:tools="http://schemas.android.com/tools"
   android:id="@+id/widget_container"
   style="@style/Widget.Android.AppWidget.Container"
   android:layout_width="wrap_content"
   android:layout_height="match_parent"
   android:background="@android:color/white"
   android:theme="@style/Theme.Android.AppWidgetContainer">
   
   <TextView
       android:id="@+id/headline_title"
       style="@style/Widget.Android.AppWidget.InnerView"
       android:layout_width="wrap_content"
       android:layout_height="wrap_content"
       android:layout_alignParentStart="true"
       android:layout_alignParentLeft="true"
       android:layout_marginStart="8dp"
       android:layout_marginLeft="8dp"
       android:background="@android:color/white"
       android:text="Title"
       android:textSize="20sp"
       android:textStyle="bold" />

   <TextView
       android:id="@+id/headline_description"
       style="@style/Widget.Android.AppWidget.InnerView"
       android:layout_width="wrap_content"
       android:layout_height="wrap_content"
       android:layout_below="@+id/headline_title"
       android:layout_alignParentStart="true"
       android:layout_alignParentLeft="true"
       android:layout_marginStart="8dp"
       android:layout_marginLeft="8dp"
       android:layout_marginTop="4dp"
       android:background="@android:color/white"
       android:text="Title"
       android:textSize="16sp" />

</RelativeLayout>

XML ini menentukan dua tampilan teks, satu untuk judul artikel dan yang lainnya untuk deskripsi artikel. Tampilan teks ini juga menentukan gaya. Anda akan kembali ke file ini selama codelab ini.

Memperbarui fungsi NewsWidget

Buka file kode sumber Kotlin NewsWidget.kt. File ini berisi class yang dibuat bernama NewsWidget yang memperluas class AppWidgetProvider.

Class NewsWidget berisi tiga metode dari superclass-nya. Anda akan mengubah metode onUpdate. Android memanggil metode ini untuk widget pada interval tetap.

Ganti konten file NewsWidget.kt dengan kode berikut:

android/app/java/com.mydomain.homescreen_widgets/NewsWidget.kt

// Import will depend on App ID.
package com.mydomain.homescreen_widgets

import android.appwidget.AppWidgetManager
import android.appwidget.AppWidgetProvider
import android.content.Context
import android.widget.RemoteViews

// New import.
import es.antonborri.home_widget.HomeWidgetPlugin


/**
 * Implementation of App Widget functionality.
 */
class NewsWidget : AppWidgetProvider() {
    override fun onUpdate(
            context: Context,
            appWidgetManager: AppWidgetManager,
            appWidgetIds: IntArray,
    ) {
        for (appWidgetId in appWidgetIds) {
            // Get reference to SharedPreferences
            val widgetData = HomeWidgetPlugin.getData(context)
            val views = RemoteViews(context.packageName, R.layout.news_widget).apply {

                val title = widgetData.getString("headline_title", null)
                setTextViewText(R.id.headline_title, title ?: "No title set")

                val description = widgetData.getString("headline_description", null)
                setTextViewText(R.id.headline_description, description ?: "No description set")
            }

            appWidgetManager.updateAppWidget(appWidgetId, views)
        }
    }
}

Sekarang, saat onUpdate dipanggil, Android akan mendapatkan nilai terbaru dari penyimpanan lokal menggunakan metode the widgetData.getString(), lalu memanggil setTextViewText untuk mengubah teks yang ditampilkan di widget Layar Utama.

Uji pembaruan

Uji aplikasi untuk memastikan widget Layar Utama Anda diperbarui dengan data baru. Untuk memperbarui data, gunakan Perbarui Layar Utama FloatingActionButton di halaman artikel. Widget Layar Utama Anda akan diperbarui dengan judul artikel.

5. Menggunakan font kustom aplikasi Flutter di widget Layar Utama iOS

Sejauh ini, Anda telah mengonfigurasi widget Layar Utama untuk membaca data yang disediakan aplikasi Flutter. Aplikasi Flutter menyertakan font kustom yang mungkin ingin Anda gunakan di widget Layar Utama. Anda dapat menggunakan font kustom di widget Layar Utama iOS. Penggunaan font kustom di widget Layar Utama tidak tersedia di Android.

Perbarui kode iOS

Flutter menyimpan asetnya di mainBundle aplikasi iOS. Anda dapat mengakses aset dalam paket ini dari kode widget Layar Utama.

Di struct NewsWidgetsEntryView dalam file NewsWidgets.swift, lakukan perubahan berikut

Buat fungsi bantuan untuk mendapatkan jalur ke direktori aset Flutter:

ios/NewsWidgets/NewsWidgets.swift

struct NewsWidgetsEntryView : View {
   ...

   // New: Add the helper function.
   var bundle: URL {
           let bundle = Bundle.main
           if bundle.bundleURL.pathExtension == "appex" {
               // Peel off two directory levels - MY_APP.app/PlugIns/MY_APP_EXTENSION.appex
               var url = bundle.bundleURL.deletingLastPathComponent().deletingLastPathComponent()
               url.append(component: "Frameworks/App.framework/flutter_assets")
               return url
           }
           return bundle.bundleURL
       }
   ...
}

Daftarkan font menggunakan URL ke file font kustom Anda.

ios/NewsWidgets/NewsWidgets.swift

struct NewsWidgetsEntryView : View {
   ...

   // New: Register the font.
   init(entry: Provider.Entry){
     self.entry = entry
     CTFontManagerRegisterFontsForURL(bundle.appending(path: "/fonts/Chewy-Regular.ttf") as CFURL, CTFontManagerScope.process, nil)
   }
   ...
}

Perbarui tampilan Teks judul untuk menggunakan font kustom Anda.

ios/NewsWidgets/NewsWidgets.swift

struct NewsWidgetsEntryView : View {
   ...


   var body: some View {
    VStack {
      // Update the following line.
      Text(entry.title).font(Font.custom("Chewy", size: 13))
      Text(entry.description)
    }
   }
   ...
}

Saat Anda menjalankan widget Layar Utama, widget tersebut kini menggunakan font kustom untuk judul seperti yang ditampilkan pada gambar berikut:

6. Merender widget Flutter sebagai gambar

Di bagian ini, Anda akan menampilkan grafik dari aplikasi Flutter sebagai widget Layar Utama.

Widget ini memberikan tantangan yang lebih besar daripada teks yang telah Anda tampilkan di layar utama. Jauh lebih mudah untuk menampilkan diagram Flutter sebagai gambar daripada mencoba membuatnya ulang menggunakan komponen UI native.

Kodingkan widget Layar Utama Anda untuk merender diagram Flutter sebagai file PNG. Widget Layar Utama Anda dapat menampilkan gambar tersebut.

Tulis kode Dart

Di sisi Dart, tambahkan metode renderFlutterWidget dari paket home_widget. Metode ini mengambil widget, nama file, dan kunci. Metode ini menampilkan gambar widget Flutter dan menyimpannya ke penampung bersama. Berikan nama gambar dalam kode Anda dan pastikan widget Layar Utama dapat mengakses penampung. key menyimpan jalur file lengkap sebagai string di penyimpanan lokal perangkat. Hal ini memungkinkan widget Layar Utama menemukan file jika namanya berubah dalam kode Dart.

Untuk codelab ini, class LineChart dalam file lib/article_screen.dart mewakili diagram. Metode build-nya menampilkan CustomPainter yang melukis diagram ini ke layar.

Untuk menerapkan fitur ini, buka file lib/article_screen.dart. Impor paket home_widget. Selanjutnya, ganti kode di class _ArticleScreenState dengan kode berikut:

lib/article_screen.dart

import 'package:flutter/material.dart';
// New: import the home_widget package.
import 'package:home_widget/home_widget.dart';

import 'home_screen.dart';
import 'news_data.dart';

...

class _ArticleScreenState extends State<ArticleScreen> {
  // New: add this GlobalKey
  final _globalKey = GlobalKey();
  String? imagePath;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.article.title!),
      ),
      // New: add this FloatingActionButton
      floatingActionButton: FloatingActionButton.extended(
        onPressed: () async {
          if (_globalKey.currentContext != null) {
            var path = await HomeWidget.renderFlutterWidget(
              const LineChart(),
              fileName: 'screenshot',
              key: 'filename',
              logicalSize: _globalKey.currentContext!.size,
              pixelRatio:
                  MediaQuery.of(_globalKey.currentContext!).devicePixelRatio,
            );
            setState(() {
              imagePath = path as String?;
            });
          }
          updateHeadline(widget.article);
        },
        label: const Text('Update Homescreen'),
      ),
      body: ListView(
        padding: const EdgeInsets.all(16.0),
        children: [
          Text(
            widget.article.description!,
            style: Theme.of(context).textTheme.titleMedium,
          ),
          const SizedBox(height: 20.0),
          Text(widget.article.articleText!),
          const SizedBox(height: 20.0),
          Center(
            // New: Add this key
            key: _globalKey,
            child: const LineChart(),
          ),
          const SizedBox(height: 20.0),
          Text(widget.article.articleText!),
        ],
      ),
    );
  }
}

Contoh ini membuat tiga perubahan pada class _ArticleScreenState.

Membuat GlobalKey

GlobalKey mendapatkan konteks widget tertentu, yang diperlukan untuk mendapatkan ukuran widget tersebut .

lib/article_screen.dart

class _ArticleScreenState extends State<ArticleScreen> {
   // New: add this GlobalKey
   final _globalKey = GlobalKey();
   ...
}

Menambahkan imagePath

Properti imagePath menyimpan lokasi gambar tempat widget Flutter dirender.

lib/article_screen.dart

class _ArticleScreenState extends State<ArticleScreen> {
   ...
   // New: add this imagePath
   String? imagePath;
   ...
}

_globalKey berisi widget Flutter yang dirender ke gambar. Dalam hal ini, widget Flutter adalah Center yang berisi LineChart.

lib/article_screen.dart

class _ArticleScreenState extends State<ArticleScreen> {
   ...
   Center(
      // New: Add this key
 key: _globalKey,
 child: const LineChart(),
   ),
   ...
}

Menyimpan widget sebagai gambar

Metode renderFlutterWidget dipanggil saat pengguna mengklik floatingActionButton. Metode ini menyimpan file PNG yang dihasilkan sebagai "screenshot" ke direktori penampung bersama. Metode ini juga menyimpan jalur lengkap ke gambar sebagai kunci nama file di penyimpanan perangkat.

lib/article_screen.dart

class _ArticleScreenState extends State<ArticleScreen> {
   ...
   floatingActionButton: FloatingActionButton.extended(
 onPressed: () async {
   if (_globalKey.currentContext != null) {
     var path = await HomeWidget.renderFlutterWidget(
       LineChart(),
       fileName: 'screenshot',
       key: 'filename',
       logicalSize: _globalKey.currentContext!.size,
       pixelRatio:
         MediaQuery.of(_globalKey.currentContext!).devicePixelRatio,
     );
     setState(() {
        imagePath = path as String?;
     });
    }
  updateHeadline(widget.article);
  },
   ...
}

Perbarui kode iOS

Untuk iOS, perbarui kode untuk mendapatkan jalur file dari penyimpanan dan menampilkan file sebagai gambar menggunakan SwiftUI.

Buka file NewsWidgets.swift untuk melakukan perubahan berikut:

Tambahkan `filename` dan `displaySize` ke struct `NewsArticleEntry`

Properti filename menyimpan string yang merepresentasikan jalur ke file gambar. Properti displaySize menyimpan ukuran widget Layar Utama di perangkat pengguna. Ukuran widget Layar Utama berasal dari context.

ios/NewsWidgets/NewsWidgets.swift

struct NewsArticleEntry: TimelineEntry {
   ...

   // New: add the filename and displaySize.
   let filename: String
   let displaySize: CGSize
}

Memperbarui `placeholder` fungsi

Sertakan placeholder filename dan displaySize.

ios/NewsWidgets/NewsWidgets.swift

func placeholder(in context: Context) -> NewsArticleEntry {
      NewsArticleEntry(date: Date(), title: "Placeholder Title", description: "Placeholder description", filename: "No screenshot available",  displaySize: context.displaySize)
    }

Dapatkan nama file dari `userDefaults` di getSnapshot

Tindakan ini menetapkan variabel filename ke nilai filename di penyimpanan userDefaults saat widget Layar Utama diperbarui.

ios/NewsWidgets/NewsWidgets.swift

func getSnapshot(
   ...

   let title = userDefaults?.string(forKey: "headline_title") ?? "No Title Set"
   let description = userDefaults?.string(forKey: "headline_description") ?? "No Description Set"
   // New: get fileName from key/value store
   let filename = userDefaults?.string(forKey: "filename") ?? "No screenshot available"
   ...
)

Buat ChartImage yang menampilkan gambar dari jalur

Tampilan ChartImage membuat gambar dari konten file yang dibuat di sisi Dart. Di sini, Anda menetapkan ukuran menjadi 50% dari frame.

ios/NewsWidgets/NewsWidgets.swift

struct NewsWidgetsEntryView : View {
   ...

   // New: create the ChartImage view
   var ChartImage: some View {
        if let uiImage = UIImage(contentsOfFile: entry.filename) {
            let image = Image(uiImage: uiImage)
                .resizable()
                .frame(width: entry.displaySize.height*0.5, height: entry.displaySize.height*0.5, alignment: .center)
            return AnyView(image)
        }
        print("The image file could not be loaded")
        return AnyView(EmptyView())
    }
   ...
}

Menggunakan ChartImage di isi NewsWidgetsEntryView

Tambahkan tampilan ChartImage ke isi NewsWidgetsEntryView untuk menampilkan ChartImage di widget Layar Utama.

ios/NewsWidgets/NewsWidgets.swift

VStack {
   Text(entry.title).font(Font.custom("Chewy", size: 13))
   Text(entry.description).font(.system(size: 12)).padding(10)
   // New: add the ChartImage to the NewsWidgetEntryView
   ChartImage
}

Menguji perubahan

Untuk menguji perubahan, jalankan kembali target aplikasi Flutter (Runner) dan target ekstensi dari Xcode. Untuk melihat gambar, buka salah satu halaman artikel di aplikasi dan tekan tombol untuk memperbarui widget Layar Utama.

Perbarui kode Android

Kode Android berfungsi sama dengan kode iOS.

Buka file android/app/res/layout/news_widget.xml. File ini berisi elemen UI widget Layar Utama Anda. Ganti kontennya dengan kode berikut:

android/app/res/layout/news_widget.xml

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
   xmlns:app="http://schemas.android.com/apk/res-auto"
   xmlns:tools="http://schemas.android.com/tools"
   android:id="@+id/widget_container"
   style="@style/Widget.Android.AppWidget.Container"
   android:layout_width="wrap_content"
   android:layout_height="match_parent"
   android:background="@android:color/white"
   android:theme="@style/Theme.Android.AppWidgetContainer">

   <TextView
       android:id="@+id/headline_title"
       style="@style/Widget.Android.AppWidget.InnerView"
       android:layout_width="wrap_content"
       android:layout_height="wrap_content"
       android:layout_alignParentStart="true"
       android:layout_alignParentLeft="true"
       android:layout_marginStart="8dp"
       android:layout_marginLeft="8dp"
       android:background="@android:color/white"
       android:text="Title"
       android:textSize="20sp"
       android:textStyle="bold" />

   <TextView
       android:id="@+id/headline_description"
       style="@style/Widget.Android.AppWidget.InnerView"
       android:layout_width="wrap_content"
       android:layout_height="wrap_content"
       android:layout_below="@+id/headline_title"
       android:layout_alignParentStart="true"
       android:layout_alignParentLeft="true"
       android:layout_marginStart="8dp"
       android:layout_marginLeft="8dp"
       android:layout_marginTop="4dp"
       android:background="@android:color/white"
       android:text="Title"
       android:textSize="16sp" />
   
   <!--New: add this image view -->
   <ImageView
       android:id="@+id/widget_image"
       android:layout_width="200dp"
       android:layout_height="200dp"
       android:layout_below="@+id/headline_description"
       android:layout_alignBottom="@+id/headline_title"
       android:layout_alignParentStart="true"
       android:layout_alignParentLeft="true"
       android:layout_marginStart="8dp"
       android:layout_marginLeft="8dp"
       android:layout_marginTop="6dp"
       android:layout_marginBottom="-134dp"
       android:layout_weight="1"
       android:adjustViewBounds="true"
       android:background="@android:color/white"
       android:scaleType="fitCenter"
       android:src="@android:drawable/star_big_on"
       android:visibility="visible"
       tools:visibility="visible" />

</RelativeLayout>

Kode baru ini menambahkan gambar ke widget Layar Utama, yang (untuk saat ini) menampilkan ikon bintang umum. Ganti ikon bintang ini dengan gambar yang Anda simpan dalam kode Dart.

Buka file NewsWidget.kt. Ganti kontennya dengan kode berikut:

android/app/java/com.mydomain.homescreen_widgets/NewsWidget.kt

// Import will depend on App ID.
package com.mydomain.homescreen_widgets

import android.appwidget.AppWidgetManager
import android.appwidget.AppWidgetProvider
import android.content.Context
import android.graphics.Bitmap
import android.graphics.BitmapFactory
import android.widget.RemoteViews
import java.io.File
import es.antonborri.home_widget.HomeWidgetPlugin


/**
 * Implementation of App Widget functionality.
 */
class NewsWidget : AppWidgetProvider() {
    override fun onUpdate(
            context: Context,
            appWidgetManager: AppWidgetManager,
            appWidgetIds: IntArray,
    ) {
        for (appWidgetId in appWidgetIds) {
            val widgetData = HomeWidgetPlugin.getData(context)
            val views = RemoteViews(context.packageName, R.layout.news_widget).apply {

                val title = widgetData.getString("headline_title", null)
                setTextViewText(R.id.headline_title, title ?: "No title set")

                val description = widgetData.getString("headline_description", null)
                setTextViewText(R.id.headline_description, description ?: "No description set")

                // New: Add the section below
               // Get chart image and put it in the widget, if it exists
                val imageName = widgetData.getString("filename", null)
                val imageFile = File(imageName)
                val imageExists = imageFile.exists()
                if (imageExists) {
                    val myBitmap: Bitmap = BitmapFactory.decodeFile(imageFile.absolutePath)
                    setImageViewBitmap(R.id.widget_image, myBitmap)
                } else {
                    println("image not found!, looked @: ${imageName}")
                }
                // End new code
            }

            appWidgetManager.updateAppWidget(appWidgetId, views)
        }
    }
}

Kode Dart ini menyimpan screenshot ke penyimpanan lokal dengan kunci filename. Selain itu, aplikasi ini akan mendapatkan jalur lengkap gambar dan membuat objek File dari gambar tersebut. Jika gambar ada, kode Dart akan mengganti gambar di widget Layar Utama dengan gambar baru.

Muat ulang aplikasi Anda dan buka layar artikel. Tekan Perbarui Layar Utama. Widget Layar Utama menampilkan diagram.

7. Langkah Berikutnya

Selamat!

Selamat, Anda berhasil membuat widget Layar Utama untuk aplikasi Flutter iOS dan Android Anda.

Menyediakan link ke konten di aplikasi Flutter Anda

Anda mungkin ingin mengarahkan pengguna ke halaman tertentu di aplikasi Anda, bergantung pada tempat pengguna mengklik. Misalnya, di aplikasi berita dari codelab ini, Anda mungkin ingin pengguna melihat artikel berita untuk judul yang ditampilkan.

Fitur ini berada di luar cakupan codelab ini. Anda dapat menemukan contoh penggunaan stream yang disediakan paket home_widget untuk mengidentifikasi peluncuran aplikasi dari widget Layar Utama dan mengirim pesan dari widget Layar Utama melalui URL. Untuk mempelajari lebih lanjut, lihat dokumentasi deep linking di docs.flutter.dev.

Dalam codelab ini, Anda memicu update widget Layar Utama menggunakan tombol. Meskipun hal ini wajar untuk pengujian, dalam kode produksi, Anda mungkin ingin aplikasi memperbarui widget Layar Utama di latar belakang. Anda dapat menggunakan plugin workmanager untuk membuat tugas latar belakang guna memperbarui resource yang dibutuhkan widget Layar Utama. Untuk mempelajari lebih lanjut, lihat bagian Pembaruan di latar belakang di paket home_widget.

Untuk iOS, Anda juga dapat membuat widget Layar Utama membuat permintaan jaringan untuk memperbarui UI-nya. Untuk mengontrol kondisi atau frekuensi permintaan tersebut, gunakan Linimasa. Untuk mempelajari lebih lanjut cara menggunakan Linimasa, lihat dokumentasi Apple "Menjaga agar widget tetap terbaru".

Bacaan lebih lanjut

Ekstensi aplikasi iOS

Menambahkan widget Layar Utama ke Aplikasi Flutter Anda

1. Pengantar

Apa itu Widget?

Seberapa rumit Widget dapat dibuat?

Membuat UI untuk Widget

Yang akan Anda bangun

Yang akan Anda pelajari

2. Menyiapkan lingkungan pengembangan

Untuk membuat widget Layar Utama iOS:

Untuk membuat widget Layar Utama Android:

Mendapatkan kode awal

Download project versi awal Anda dari GitHub

Membuka aplikasi awal

Menginstal paket

3. Menambahkan widget Layar Utama dasar

Membuat widget Layar Utama iOS dasar

Periksa kode contoh

Men-debug dan menguji widget contoh

Membuat Widget Android Dasar

Periksa kode contoh

Men-debug dan menguji widget contoh

4. Mengirim data dari aplikasi Flutter ke widget Layar Utama

Menggunakan Grup Aplikasi iOS

Perbarui ID paket Anda:

Tambahkan Grup Aplikasi ke kedua target Runner dan target NewsWidgetExtension di Xcode:

Tambahkan kode Dart

Perbarui nilai judul dan deskripsi

Mengubah floatingActionButton

Perbarui kode iOS untuk menampilkan data artikel

Konfigurasi TimelineEntry.

Edit View yang menampilkan konten

Mengedit penyedia untuk memberi tahu widget Layar Utama kapan dan cara memperbarui

Beri komentar pada NewsWidgets_Previews

Simpan semua file dan jalankan ulangtarget aplikasi dan widget.

Memperbarui kode Android

Tambahkan XML widget Layar Utama.

Memperbarui fungsi NewsWidget

Uji pembaruan

5. Menggunakan font kustom aplikasi Flutter di widget Layar Utama iOS

Perbarui kode iOS

Buat fungsi bantuan untuk mendapatkan jalur ke direktori aset Flutter:

Daftarkan font menggunakan URL ke file font kustom Anda.

Perbarui tampilan Teks judul untuk menggunakan font kustom Anda.

6. Merender widget Flutter sebagai gambar

Tulis kode Dart

Membuat GlobalKey

Menambahkan imagePath

Menambahkan kunci ke widget untuk dirender

Perbarui kode iOS

Tambahkan filename dan displaySize ke struct NewsArticleEntry

Memperbarui placeholder fungsi

Dapatkan nama file dari userDefaults di getSnapshot

Buat ChartImage yang menampilkan gambar dari jalur

Menggunakan ChartImage di isi NewsWidgetsEntryView

Menguji perubahan

Perbarui kode Android

7. Langkah Berikutnya

Selamat!

Menyediakan link ke konten di aplikasi Flutter Anda

Memperbarui widget di latar belakang

Bacaan lebih lanjut

Konfigurasi `TimelineEntry`.

Edit `View` yang menampilkan konten

Beri komentar pada `NewsWidgets_Previews`

Tambahkan `filename` dan `displaySize` ke struct `NewsArticleEntry`

Memperbarui `placeholder` fungsi

Dapatkan nama file dari `userDefaults` di getSnapshot