widget 是提供以下一项或多项内容的界面元素:
- 其他 widget 的结构,例如卡片和部分;
- 向用户显示的信息,如文字和图片;或者
- 操作可见性,例如按钮、文本输入字段或复选框。
添加到卡片部分的一组 widget 定义了整个插件界面。这些 widget 在 Web 和移动设备上具有相同的外观和功能。参考文档介绍了构建 widget 集的几种方法。
微件类型
插件 widget 通常分为三组:结构化 widget、信息 widget 和用户互动 widget。
结构化 widget
结构化 widget 为界面中使用的其他 widget 提供容器和组织。
- 按钮集 - 一个或多个文本或图片按钮的集合,按水平行排列。
- 卡片 - 包含一个或多个卡片部分的单个上下文卡片。通过配置卡片导航,您可以定义用户如何在卡片之间移动。
- 卡片标头 - 指定卡片的标头。卡片标题可以包含标题、副标题和图片。如果插件使用卡片操作和通用操作,这些操作便会显示在卡片标题中。
- 卡片部分 - 一组集合的 widget,通过水平线将其他卡片部分与其他卡片部分分隔开,并可以视需要添加部分标题。每张卡片都必须至少有一个卡片部分。您不能向卡片部分添加卡片或卡片标题。
除了这些基本的结构微件之外,在 Google Workspace 插件中,您还可以使用卡片服务创建与当前卡片重叠的结构:固定页脚和提示卡片:
固定页脚
您可以在卡片底部添加一排固定按钮。此行不会随卡片的其余部分一起移动或滚动。
以下代码段展示了如何定义固定页脚示例并将其添加到卡片中:
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();
提示卡
当用户操作(例如打开 Gmail 邮件)触发新的上下文内容时,您可以立即显示新的上下文内容(默认行为),或者在边栏底部显示提示卡通知。在内容相关触发器处于启用状态时,如果用户点击“返回” 以返回到您的首页,系统会显示一个提示卡,以帮助用户再次找到上下文内容。
如需在有新的上下文内容时显示提示卡,而不是立即显示新的上下文内容,请将 .setDisplayStyle(CardService.DisplayStyle.PEEK)
添加到您的 CardBuilder
类。只有在上下文触发器返回单个卡片对象时,才会显示提示卡;否则,返回的卡片会立即替换当前卡片。
如需自定义提示卡片的标题,请在构建上下文卡片时添加带有标准 CardHeader
对象的 .setPeekCardHeader()
方法。默认情况下,提示卡标头仅包含插件的名称。
以下代码基于 Cats Google Workspace 插件快速入门,使用提示卡向用户通知新的上下文内容,并自定义提示卡标头以显示所选 Gmail 邮件会话的主题。
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 会向用户显示信息。
- 图片 - 由您提供的托管且可公开访问的网址表示的图片。
- DecoratedText - 一个文本内容字符串,您可以将其与其他元素(如顶部和底部文本标签以及图片或图标)配对。DecoratedText widget 还可以包含 Button 或 Switch widget。添加的开关可以是切换开关或复选框。DecoratedText widget 的内容文本可以使用 HTML 格式;顶部和底部标签必须使用纯文本。
- 文本段落 - 文本段落,可以包含 HTML 格式的元素。
用户互动微件
通过用户互动 widget,该插件可以响应用户执行的操作。您可以为这些 widget 配置操作响应,以显示不同的卡片、打开网址、显示通知、撰写电子邮件草稿或运行其他 Apps 脚本函数。如需了解详情,请参阅构建互动卡片指南。
- 卡片操作 - 放置在插件标题栏菜单中的菜单项。标题栏菜单还可以包含定义为通用操作的项,这些操作会显示在该插件定义的每张卡片上。
- 日期时间选择器 - 一种微件,可让用户选择日期和/或时间。如需了解详情,请参阅下文的日期和时间选择器。
- “图片”按钮 - 一个使用图片而非文字的按钮。您可以使用多个预定义图标中的一个或由其网址指示的公开托管的图片。
- 选择输入 - 表示一组选项的输入字段。选择输入 widget,显示为复选框、单选按钮或下拉选择框。
- 开关 - 一个切换开关 widget。您只能将开关与 DecoratedText widget 结合使用。默认情况下,这些控件显示为切换开关,但您可以将其显示为复选框。
- 文本按钮 - 一个带有文本标签的按钮。您可以为文本按钮指定背景颜色填充(默认设置为透明)。您也可以根据需要停用该按钮。
- 文本输入 - 文本输入字段。该 widget 可以包含标题文本、提示文本和多行文本。当文本值发生更改时,微件可以触发操作。
- 网格 - 表示一组项的多列布局。您可以使用图片、标题、副标题以及一系列自定义选项(例如边框和剪裁样式)来表示项。
DecoratedText
个复选框
您可以定义一个附加了复选框(而不是按钮或二元切换开关)的 DecoratedText
widget。与开关一样,复选框的值会包含在操作事件对象中,操作事件对象会传递到通过 setOnClickAction(action)
方法附加到此 DecoratedText
的 Action
。
以下代码片段展示了如何定义复选框 DecoratedText
widget,然后您可以将其添加到卡片中:
var decoratedText = CardService.newDecoratedText()
// (...)
.setSwitch(CardService.newSwitch()
.setFieldName('form_input_switch_key')
.setValue('switch_is_on')
.setControlType(
CardService.SwitchControlType.CHECK_BOX));
日期和时间选择器
您可以定义允许用户选择时间和/或日期的微件。您可以使用 setOnChangeAction()
分配一个在选择器值发生更改时要执行的 widget 处理程序函数。
以下代码摘录展示了如何定义仅限日期的选择器、仅限时间的选择器和日期时间选择器,然后您就可以将它们添加到卡片中:
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"));
以下是日期时间选择器 widget 处理程序函数的示例。此处理程序会在日期时间选择器微件 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);
}
}
下表显示了桌面设备和移动设备上的选择器选择界面示例。选择此选项后,日期选择器会打开一个基于月份的日历界面,以便用户快速选择新日期。
用户在桌面设备上选择时间选择器时,系统会打开一个下拉菜单,其中包含以 30 分钟为增量分隔的时间列表,以供用户选择。用户还可以输入特定时间。在移动设备上,选择时间选择器会打开内置的移动设备“时钟”时间选择器。
桌面版 | 移动设备 |
---|---|
网格
使用网格 widget 以多列布局显示项。每项都可以显示图片、标题和副标题。使用其他配置选项来设置文本相对于网格项中图片的位置。
您可以使用标识符配置网格项,该标识符会作为参数返回给网格上定义的操作。
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"));
文本格式
某些基于文本的微件可支持简单的文本 HTML 格式。设置这些微件的文本内容时,只需添加相应的 HTML 标记即可。
下表中列出了支持的标记及其用途:
形式 | 示例 | 渲染结果 |
---|---|---|
粗体 | "This is <b>bold</b>." |
此为粗体。 |
斜体 | "This is <i>italics</i>." |
(斜体)。 |
下划线 | "This is <u>underline</u>." |
这是下划线。 |
删除线 | "This is <s>strikethrough</s>." |
这是 |
字体颜色 | "This is <font color=\"#FF0000\">red font</font>." |
这是红色字体。 |
超链接 | "This is a <a href=\"https://www.google.com\">hyperlink</a>." |
这是一个超链接。 |
时间 | "This is a time format: <time>2023-02-16 15:00</time>." |
时间格式:。 |
换行符 | "This is the first line. <br> This is a new line. 英寸 |
这是第一行。 。这是新的一行。 |