Halaman ini diterjemahkan oleh Cloud Translation API.

Widget

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

Struktur untuk widget lain seperti kartu dan bagian,
Informasi untuk 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 memiliki tampilan dan fungsi yang sama di web dan perangkat seluler. Dokumentasi referensi menjelaskan beberapa metode untuk mem-build kumpulan widget.

Menggunakan kit desain Add-on Google Workspace

Untuk menghemat waktu dalam mendesain widget add-on, desainer dapat menggunakan Kit desain UI Add-on Google Workspace yang tersedia di Figma. Anda dapat membuat akun Figma, atau meminta lisensi dari administrator organisasi.

Cari komponen dan gunakan template bawaan untuk membuat dan memvisualisasikan widget.

Dapatkan kit desain

Jenis widget

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

Widget struktural

Widget struktural menyediakan container dan pengaturan untuk widget lain yang digunakan dalam AI.

Widget struktural

Set tombol—Koleksi satu atau beberapa tombol teks atau gambar, yang dikelompokkan bersama dalam baris horizontal.
Kartu—Satu kartu konteks yang berisi satu atau beberapa bagian kartu. Anda dapat menentukan cara pengguna berpindah antar-kartu dengan mengonfigurasi navigasi kartu.
Header kartu—Header untuk kartu tertentu. Header kartu dapat berisi judul, subtitel, dan gambar. Tindakan kartu dan tindakan universal muncul di header kartu jika add-on menggunakannya.
Bagian kartu—Grup widget yang dikumpulkan, yang dibagi dari bagian kartu lainnya berdasarkan aturan 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 struktural dasar ini, dalam Add-on Google Workspace, Anda dapat menggunakan Layanan kartu untuk membuat struktur yang tumpang-tindih dengan kartu saat ini: footer tetap dan kartu pengintip:

Footer tetap

Anda kini dapat menambahkan deretan tombol tetap ke bagian bawah kartu. Baris ini tidak bergerak atau men-scroll sisa konten kartu. Nukilan kode berikut menunjukkan cara menentukan contoh footer tetap dan menambahkannya ke kartu:

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

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

Lihat kartu

Contoh kartu intip

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

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

Untuk menyesuaikan header kartu intip, 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 Google Workspace untuk Kucing, 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.
LengkapidText—String konten teks yang dapat Anda sambungkan dengan elemen lain seperti label teks atas dan bawah, serta gambar atau ikon. Widget decorationdText juga dapat menyertakan widget Button atau Switch. Tombol akses yang ditambahkan dapat berupa tombol atau kotak centang sederhana. Teks konten widget LengkapidText dapat menggunakan pemformatan HTML; label atas dan bawah harus menggunakan teks biasa.
Teks paragraf—Paragraf teks sederhana, yang dapat menyertakan elemen berformat HTML.

Widget interaksi pengguna

Widget tindakan kartu

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

Widget interaksi pengguna

Tindakan kartu—Item menu yang ditempatkan di menu panel header add-on. Menu kolom header juga dapat berisi item yang ditentukan sebagai tindakan universal, yang muncul pada setiap kartu yang ditentukan oleh add-on.
Alat pilih DateTime—widget yang memungkinkan pengguna memilih tanggal, waktu, atau keduanya. Lihat Alat pilih 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 yang telah ditetapkan sebelumnya atau gambar yang dihosting secara publik yang ditunjukkan oleh URL-nya.
Input pilihan—Kolom input yang mewakili kumpulan opsi. Widget input pilihan ditampilkan sebagai kotak centang, tombol pilihan, atau kotak pilihan drop-down.
Tombol—Widget tombol. Anda hanya dapat menggunakan tombol bersamaan dengan widget decorationdText. Secara default, tampilan ini sebagai tombol akses, tetapi Anda dapat membuatnya ditampilkan sebagai kotak centang.
Tombol teks—Tombol dengan label teks. Anda dapat menentukan isi warna latar belakang untuk tombol teks (defaultnya transparan). Anda juga dapat menonaktifkan tombol sesuai kebutuhan.
Input teks—Kolom input teks. Widget dapat memiliki teks judul, teks petunjuk, dan teks multibaris. Widget dapat memicu tindakan saat nilai teks berubah.
Grid—Tata letak multi-kolom yang mewakili kumpulan item. Anda dapat mewakili item dengan gambar, judul, subtitel, dan berbagai opsi penyesuaian seperti gaya batas dan pemangkasan.

Kotak centang decorationdtext

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

Nukilan 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));

Contoh widget kotak centang teks yang dihias

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.

Nukilan kode berikut menunjukkan cara menentukan pemilih tanggal saja, pemilih waktu saja, dan pemilih tanggal dan waktu, yang kemudian dapat Anda tambahkan ke kartu:

var dateOnlyPicker = CardService.newDatePicker()
    .setTitle("Enter the 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 the 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 the date and time in EDT 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 dan waktu. Pengendali ini hanya memformat dan mencatat string yang merepresentasikan waktu tanggal yang dipilih oleh pengguna dalam widget pemilih tanggal dan ID, 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/apps-script/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 di bawah ini menunjukkan contoh UI pilihan pemilih di perangkat desktop dan seluler. Jika dipilih, pemilih tanggal akan membuka UI kalender berbasis bulan untuk memungkinkan pengguna memilih tanggal baru dengan cepat.

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

Desktop	Ponsel

Kisi

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

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

var gridItem = CardService.newGridItem()
  .setIdentifier("item_001")
  .setTitle("A grid item")
  .setSubtitle("with a subtitle")
  .setImage(imageComponent);

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

var borderStyle = CardService.newBorderStyle()
  .setType(CardService.BorderType.STROKE)
  .setCornerRadius(8)
  .setStrokeColor("#00FF00FF");

var imageComponent = CardService.newImageComponent()
  .setImageUrl("https://cataas.com/cat?0.001")
  .setCropStyle(cropStyle)
  .setBorderStyle(borderStyle);

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

Pemformatan teks

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

Tag yang didukung dan tujuannya ditampilkan dalam tabel berikut:

Format	Contoh	Hasil yang dirender
Tebal	`"This is <b>bold</b>."`	Ini tebal.
Miring	`"This is <i>italics</i>."`	Ini miring.
Garis bawah	`"This is <u>underline</u>."`	Ini adalah garis bawah.
Coret	`"This is <s>strikethrough</s>."`	Ini ~~dicoret~~.
Warna font	`"This is <font color=\"#FF0000\">red font</text>."`	Ini adalah font merah.
Hyperlink	`"This is a <a href=\"https://www.google.com\">hyperlink</a>."`	Ini adalah hyperlink.
Waktu	`"This is a time format: <time>2023-02-16 15:00</time>."`	Ini adalah format waktu: 10-05-2023 15.00.
Baris baru	`"This is the first line. <br> This is a new line.` inci	Ini baris pertama. Ini adalah baris baru.