Widget

Widget adalah elemen UI yang menyediakan satu atau beberapa hal berikut:

• Struktur untuk widget lain seperti kartu dan bagian,
• Informasi kepada pengguna seperti teks dan gambar, atau
• Kemampuan untuk melakukan tindakan seperti tombol, kolom input teks, atau kotak centang.

Kumpulan widget yang ditambahkan ke bagian kartu menentukan UI add-on secara keseluruhan. Widget ini memiliki tampilan dan fungsi yang sama di perangkat web dan seluler. Dokumentasi referensi menjelaskan beberapa metode untuk mem-build set widget.

Jenis widget

Widget add-on umumnya dikategorikan ke dalam tiga grup: widget struktural, widget informasi, dan widget interaksi pengguna.

Widget struktural

Widget struktural menyediakan penampung dan pengaturan untuk widget lain yang digunakan di UI.

• Kumpulan tombol—Kumpulan satu atau beberapa tombol teks atau gambar, yang dikelompokkan dalam baris horizontal.
• Kartu—Satu kartu konteks yang berisi satu atau beberapa bagian kartu. Anda menentukan cara pengguna dapat berpindah antarkartu dengan mengonfigurasi navigasi kartu.
• Header kartu—Header untuk kartu tertentu. Header kartu dapat memiliki judul, subtitel, dan gambar. Tindakan kartu dan tindakan universal muncul di header kartu jika add-on menggunakannya.
• Bagian kartu—Grup widget yang dikumpulkan, dipisahkan dari bagian kartu lainnya dengan garis horizontal, dan secara opsional memiliki header bagian. Setiap kartu harus memiliki setidaknya satu bagian kartu. Anda tidak dapat menambahkan kartu atau header kartu ke bagian kartu.

Selain widget struktur dasar ini, di add-on Google Workspace, Anda dapat menggunakan Layanan kartu untuk membuat struktur yang tumpang-tindih dengan kartu saat ini: footer tetap dan kartu sekilas:

Footer tetap

Anda dapat menambahkan baris tombol tetap ke bagian bawah kartu. Baris ini tidak berpindah atau di-scroll dengan konten kartu lainnya.

Cuplikan kode berikut menunjukkan cara menentukan contoh footer tetap dan menambahkannya ke kartu:

var fixedFooter = CardService.newFixedFooter()
    .setPrimaryButton(
        CardService.newTextButton()
            .setText("Primary")
            .setOpenLink(CardService.newOpenLink()
                .setUrl("https://www.google.com")))
    .setSecondaryButton(
        CardService.newTextButton()
            .setText("Secondary")
            .setOnClickAction(
                CardService.newAction()
                    .setFunctionName(
                        "secondaryCallback")));

var card = CardService.newCardBuilder()
    // (...)
    .setFixedFooter(fixedFooter)
    .build();

Kartu Peek

Saat konten kontekstual baru dipicu oleh tindakan pengguna, seperti membuka pesan Gmail, Anda dapat langsung menampilkan konten kontekstual baru (perilaku default) atau menampilkan notifikasi kartu sekilas di bagian bawah sidebar. Jika pengguna mengklik Kembali arrow_back untuk kembali ke halaman beranda saat pemicu kontekstual aktif, kartu sekilas akan muncul untuk membantu pengguna menemukan konten kontekstual lagi.

Untuk menampilkan kartu sekilas saat konten kontekstual baru tersedia, tambahkan .setDisplayStyle(CardService.DisplayStyle.PEEK) ke class CardBuilder, bukan langsung menampilkan konten kontekstual baru. Kartu sekilas hanya muncul jika satu objek kartu ditampilkan dengan pemicu kontekstual Anda; jika tidak, kartu yang ditampilkan akan segera menggantikan kartu saat ini.

Untuk menyesuaikan header kartu sekilas, tambahkan metode .setPeekCardHeader() dengan objek CardHeader standar saat membuat kartu kontekstual. Secara default, header kartu Peek hanya berisi nama add-on Anda.

Kode berikut, berdasarkan panduan memulai add-on Cats Google Workspace, memberi tahu pengguna tentang konten kontekstual baru dengan kartu Peek dan menyesuaikan header kartu Peek untuk menampilkan subjek rangkaian pesan Gmail yang dipilih.

var peekHeader = CardService.newCardHeader()
    .setTitle('Contextual Cat')
    .setImageUrl('https://www.gstatic.com/images/
        icons/material/system/1x/pets_black_48dp.png')
    .setSubtitle(text);

. . .

var card = CardService.newCardBuilder()
    .setDisplayStyle(CardService.DisplayStyle.PEEK)
    .setPeekCardHeader(peekHeader);

Widget informasi

Widget informasi menampilkan informasi kepada pengguna.

• Gambar—Gambar yang ditunjukkan oleh URL yang dihosting dan dapat diakses secara publik yang Anda berikan.
• DecoratedText—String konten teks yang dapat Anda gabungkan dengan elemen lain seperti label teks atas dan bawah, serta gambar atau ikon. Widget DecoratedText juga dapat menyertakan widget Button atau Switch. Tombol yang ditambahkan dapat berupa tombol atau kotak centang. Teks konten widget DecoratedText dapat menggunakan pemformatan HTML; label atas dan bawah harus menggunakan teks biasa.
• Paragraf teks—Paragraf teks, yang dapat menyertakan elemen berformat HTML.

Widget interaksi pengguna

Widget interaksi pengguna memungkinkan add-on merespons tindakan yang dilakukan oleh pengguna. Anda dapat mengonfigurasi widget ini dengan respons tindakan untuk menampilkan kartu yang berbeda, membuka URL, menampilkan notifikasi, menulis draf email, atau menjalankan fungsi Apps Script lainnya. Lihat panduan Membuat Kartu Interaktif untuk mengetahui detailnya.

• Tindakan kartu—Item menu yang ditempatkan di menu kolom header add-on. Menu panel header juga dapat berisi item yang ditentukan sebagai tindakan universal, yang muncul di setiap kartu yang ditentukan add-on.
• Alat pilih DateTime—widget yang memungkinkan pengguna memilih tanggal, waktu, atau keduanya. Lihat Pemilih tanggal dan waktu di bawah untuk mengetahui informasi selengkapnya.
• Tombol gambar—Tombol yang menggunakan gambar, bukan teks. Anda dapat menggunakan salah satu dari beberapa ikon standar atau gambar yang dihosting secara publik yang ditunjukkan oleh URL-nya.
• Input pilihan—Kolom input yang mewakili kumpulan opsi. Widget input pilihan ada sebagai kotak centang, tombol pilihan, atau kotak pilihan drop-down.
• Tombol—Widget tombol. Anda hanya dapat menggunakan tombol bersama dengan widget DecoratedText. Secara default, tombol ini ditampilkan sebagai tombol beralih, tetapi Anda dapat membuatnya ditampilkan sebagai kotak centang.
• Tombol teks—Tombol dengan label teks. Anda dapat menentukan isian warna latar belakang untuk tombol teks (defaultnya transparan). Anda juga dapat menonaktifkan tombol tersebut sesuai kebutuhan.
• Input teks—Bidang input teks. Widget dapat memiliki teks judul, teks petunjuk, dan teks multibaris. Widget dapat memicu tindakan saat nilai teks berubah.
• Petak—Tata letak multi-kolom yang mewakili kumpulan item. Anda dapat merepresentasikan item dengan gambar, judul, subtitel, dan berbagai opsi penyesuaian seperti gaya batas dan pemangkasan.

Kotak centang DecoratedText

Anda dapat menentukan widget DecoratedText yang memiliki kotak centang terlampir, bukan tombol atau tombol tombol biner. Seperti tombol, nilai kotak centang disertakan dalam objek peristiwa tindakan yang diteruskan ke Action yang dilampirkan ke DecoratedText ini dengan metode setOnClickAction(action).

Cuplikan kode berikut menunjukkan cara menentukan widget DecoratedText kotak centang, yang kemudian dapat Anda tambahkan ke kartu:

var decoratedText = CardService.newDecoratedText()
    // (...)
    .setSwitch(CardService.newSwitch()
        .setFieldName('form_input_switch_key')
        .setValue('switch_is_on')
        .setControlType(
            CardService.SwitchControlType.CHECK_BOX));

Pemilih tanggal dan waktu

Anda dapat menentukan widget yang memungkinkan pengguna memilih waktu, tanggal, atau keduanya. Anda dapat menggunakan setOnChangeAction() untuk menetapkan fungsi pengendali widget yang akan dijalankan saat nilai pemilih berubah.

Cuplikan kode berikut menunjukkan cara menentukan pemilih khusus tanggal, pemilih khusus waktu, dan pemilih tanggal-waktu, yang kemudian dapat Anda tambahkan ke kartu:

var dateOnlyPicker = CardService.newDatePicker()
    .setTitle("Enter a date")
    .setFieldName("date_field")
    // Set default value as May 24 2019. Either a
    // number or string is acceptable.
    .setValueInMsSinceEpoch(1558668600000)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleDateChange"));

var timeOnlyPicker = CardService.newTimePicker()
    .setTitle("Enter a time")
    .setFieldName("time_field")
    // Set default value as 23:30.
    .setHours(23)
    .setMinutes(30)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleTimeChange"));

var dateTimePicker = CardService.newDateTimePicker()
    .setTitle("Enter a date and time")
    .setFieldName("date_time_field")
    // Set default value as May 24 2019 03:30 AM UTC.
    // Either a number or string is acceptable.
    .setValueInMsSinceEpoch(1558668600000)
    // EDT time is 4 hours behind UTC.
    .setTimeZoneOffsetInMins(-4 * 60)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleDateTimeChange"));

Berikut adalah contoh fungsi pengendali widget pemilih tanggal-waktu. Pengendali ini memformat dan mencatat string yang mewakili tanggal dan waktu yang dipilih oleh pengguna di widget pemilih tanggal dan waktu dengan ID "myDateTimePickerWidgetID":

function handleDateTimeChange(event) {
  var dateTimeInput =
    event.commonEventObject.formInputs["myDateTimePickerWidgetID"];
  var msSinceEpoch = dateTimeInput.msSinceEpoch;
  var hasDate = dateTimeInput.hasDate;
  var hasTime = dateTimeInput.hadTime;

  // The following requires you to configure the add-on to read user locale
  // and timezone.
  // See https://developers.google.com/workspace/add-ons/how-tos/access-user-locale
  var userTimezoneId = event.userTimezone.id;

  // Format and log the date-time selected using the user's timezone.
  var formattedDateTime;
  if (hasDate && hasTime) {
    formattedDateTime = Utilities.formatDate(
      new Date(msSinceEpoch), userTimezoneId, "yyy/MM/dd hh:mm:ss");
  } else if (hasDate) {
    formattedDateTime = Utilities.formatDate(
      new Date(msSinceEpoch), userTimezoneId, "yyy/MM/dd")
      + ", Time unspecified";
  } else if (hasTime) {
    formattedDateTime = "Date unspecified, "
      + Utilities.formatDate(
          new Date(msSinceEpoch), userTimezoneId, "hh:mm a");
  }

  if (formattedDateTime) {
    console.log(formattedDateTime);
  }
}

Tabel berikut menunjukkan contoh UI pemilihan pemilih di perangkat desktop dan seluler. Saat dipilih, pemilih tanggal akan membuka UI kalender berbasis bulan untuk memungkinkan pengguna memilih tanggal baru dengan cepat.

Saat pengguna memilih pemilih waktu di perangkat desktop, menu drop-down akan terbuka dengan daftar waktu yang dipisahkan dalam penambahan 30 menit yang dapat dipilih pengguna. Pengguna juga dapat mengetikkan waktu tertentu. Di perangkat seluler, memilih pemilih waktu akan membuka pemilih waktu "jam" seluler bawaan.

Desktop	Seluler

Petak

Menampilkan item dalam tata letak multi-kolom dengan widget petak. Setiap item dapat menampilkan gambar, judul, dan subtitel. Gunakan opsi konfigurasi tambahan untuk menetapkan posisi teks relatif terhadap gambar dalam item petak.

Anda dapat mengonfigurasi item petak dengan ID yang ditampilkan sebagai parameter ke tindakan yang ditentukan pada petak.

var gridItem = CardService.newGridItem()
  .setIdentifier("item_001")
  .setTitle("Lucian R.")
  .setSubtitle("Chief Information Officer")
  .setImage(imageComponent);

var cropStyle = CardService.newImageCropStyle()
  .setImageCropType(CardService.ImageCropType.RECTANGLE_4_3);

var imageComponent = CardService.newImageComponent()
  .setImageUrl("https://developers.google.com/workspace/
      images/cymbal/people/person1.jpeg")
  .setCropStyle(cropStyle)

var grid = CardService.newGrid()
  .setTitle("Recently viewed")
  .addItem(gridItem)
  .setNumColumns(2)
  .setOnClickAction(CardService.newAction()
    .setFunctionName("handleGridItemClick"));

Pemformatan teks

Beberapa widget berbasis teks dapat mendukung pemformatan HTML teks sederhana. Saat menetapkan konten teks widget ini, cukup sertakan tag HTML yang sesuai.

Tag yang didukung dan tujuannya ditampilkan dalam tabel berikut: