智能助手
帮助中心智能助手上线
我能为你解答 Lark 使用的问题,快来问问我吧!
00:00
点击按住可拖动视频
我知道了
去试试
“图文列表”小组件使用手册

“图文列表”小组件使用手册

本文阅读时长:20 分钟
一、功能简介
🔖
谁能操作:超级管理员、拥有工作台或定制工作台权限的管理员
编辑定制工作台时,你可以添加官方小组件“图文列表”,解决企业在内部新闻宣发场景中的需求。
“图文列表”小组件:
  • 提供图文形式(左图右文/右图左文)或列表形式。
  • 支持手动配置或自定义接口两种内容配置方式。
:小组件是定制工作台中的功能,请先确认你的 Lark 版本可以使用定制工作台功能,再参考本文进行操作。
图文版(适合新闻资讯等场景)
列表版(适合公文制度等场景)
250px|700px|reset
250px|700px|reset
二、操作流程
  1. 添加图文列表小组件
  1. 进入Lark 管理后台企业管理 页面,点击左侧 工作台 > 定制工作台
  1. 在列表中找到需要编辑的工作台,点击 编辑
  1. 在弹窗中点击编辑器地址链接,进入编辑器页面。
  1. 在编辑器页面左侧组件库区域,点击 官方小组件 中的 图文列表
你会看到小组件出现在编辑器上,你可拖动小组件调整位置。建议添加小组件后及时点击 保存,避免进度丢失。
  1. 设置图文列表小组件
通用设置
  1. 在工作台编辑器页面,点击选中已添加的图文列表小组件。
  1. 在右侧 通用设置 标签下,调整卡片圆角、小组件高度以及标题等设置。
250px|700px|reset
自定义设置
点击 自定义设置 标签,进入自定义设置页面。自定义设置项包括列表设置、文字设置、图片设置,以及为文章列表开启分页展示。
  • 列表设置:列表样式、列表行间距、是否展示分割线
  • 文章展示规则:你可选择隐藏超出小组件高度的文章,或者设置单个分组下文章条数最大值,上限为 20 条,超出高度时翻页展示。
  • 桌面端用户可通过切换页面浏览全部文章;移动端用户可通过手势左右滑动浏览全部文章。
  • 分页展示时,文章底部的分页器或滑动条会占用一定的高度,可能会压缩每页可展示的文章数量,请在设置后检查组件高度是否满足需求。
  • 文字设置:主标题、副标题、日期的文字行数、大小及粗体样式
  • 图片设置:图片宽高比、图片圆角、图片裁剪方式
250px|700px|reset
内容设置
  1. 在工作台编辑器页面,点击选中已添加的宣传栏小组件。
  1. 点击 内容设置 标签 > 小组件设置,打开小组件设置页
在内容设置页面,你可以选择 手动配置 数据源,或者通过 自定义接口 获取图文信息。
250px|700px|reset
手动配置
数据源形式选择手动配置时,你可以选择展示知识库、订阅号,或者文章链接。具体信息请参考手动配置“图文列表”小组件内容
自定义接口
你可以填写接口地址,通过接口获取图文信息。
该途径需 IT 人员介入,企业内部拥有自建内容管理系统时可使用。前端样式由 Lark 工作台提供,企业通过后端接口将 OA 或内网数据同步至前端,加载数据时通过 Lark 工作台前端拉取接口获取数据。
250px|700px|reset
内容设置项
  • 接口方法(Method):可选择 GET 和 POST 方法,默认为 GET
  • 接口地址(URL):为配置的数据源链接,填写数据源后方可显示数据内容。注意,这里的接口地址非某篇文章或新闻的跳转地址,而是一个接口(接口中承载所有的文章内容),该接口需由企业自行生成,再将生成的接口地址添加到此处。当企业内部有 OA 系统时,可采用该方式。同时,要使接口数据在工作台编辑器可预览,需注意服务端跨域问题,可参考跨域解决方法
  • Secret Key:小组件的签名秘钥,由平台随机生成,支持对 Key 进行复制、查看和重置。一个组件对应一个唯一可用的 Secret Key。Secret Key 可选使用,用于验证请求是否来自 Lark,以及返回的参数信息是否可信任。
请求参数说明
小组件请求用户配置的自定义数据源链接时,会默认带上一些参数信息,用于企业根据需要千人千面展示返回内容。
  • userId:当前设备登录用户的 User ID
  • signature:signatureTimestamp 的加密签名,使用设置页中的 Secret Key 通过 HMAC-SHA256 方式加密,可用于验证请求来源于 Lark。
  • secretKey 和时间戳通过 sha256 加密可以得到 signatureTimestamp。
  • signatureTimestamp 和 secretKey 通过 sha256 加密可以得到 signature。
  • signatureTimestamp:加密原始信息,结合 signature 和 Secret Key 可用于验证请求是否来自 Lark。
  • language: 当前客户端语言,用于根据语言返回国际化内容。language 枚举值的格式为 {语言}_{地区}。取值包括:
zh_cn
en_us
ja_jp
zh_hk
zh_tw
vi_vn
th_th
ru_ru
pt_br
ko_kr
it_it
id_id
hi_in
fr_fr
es_es
de_de
简体中文
英文
日文
繁体中文 - 中国香港
繁体中文 - 中国台湾
越南语
泰语
俄语
葡萄牙语 - 巴西
韩语
意大利语 - 意大利
印度尼西亚语
印地语
法语 - 法国
西班牙语
德语 - 德国
参数拼接方式
  • GET:相关参数会拼接在 URL 参数中
  • http://example.com/feed_list?userId={userId}&signature={signature}&signatureTimestamp={signatureTimestamp}&language={language}
  • POST:相关参数会在 Body 中以 JSON 格式返回
{
"userId": "{userId}",
"signature": "{signature}",
"signatureTimestamp": "{signatureTimestamp}",
"language": "{language}"
}
接口数据字段
分类
字段
字段描述
字段类型
是否必填
根结点字段
feeds
返回数据 JSON Object 的根结点,通过此字段表示当前图文列表的显示内容
Array<Group>
分组数据字段
id
分组 id,用于区分不同的分组
String
tabName
分组名称
String
单分组可选,多分组必填
原 i18n 格式我们仍然会长期兼容,但已不推荐使用,推荐使用返回数据根据请求接口的 language 参数返回国际化名称。
{
"tabName": {
"zh_cn": "some name",
"en_us": "some name",
"ja_jp": "some name",
// ...
}
}}}}}}}
moreLinkURL
分组 查看更多 跳转链接
String
查看更多 会出现在分组底部,占用一定的高度,可能会压缩每页可展示的文章数量,请在设置后检查组件高度是否满足需求。
list
分组文章内容
Array<Article>
文章数据字段
title
图文标题
String
url
图文跳转链接
String
description
图文描述
String
imageUrl
图文展示图片的 URL
String
图片链接地址中,上传的图片需小于 2 MB,否则系统将采用降采样压缩处理,以避免客户端图片加载性能问题,影响用户体验。
date
图文日期
String
接口示例格式
{
"feeds": [
{
"id": "group_id_1",
"tabName": "group1",
"moreLinkURL": "https://example.com/more",
"list": [
{
"imageUrl": "https://example.com/image1",
"url": "https://example.com/article1",
"title": "some title",
"description": "some description",
"date": "2023-01-02"
},
{
"imageUrl": "https://example.com/image2",
"url": "https://example.com/article2",
"title": "some title",
"description": "some description",
"date": "2023-01-01"
}
]
},
{
"id": "group_id_2",
"tabName": "group2",
"moreLinkURL": "https://example.com/more",
"list": [
{
"imageUrl": "https://example.com/image1",
"url": "https://example.com/article2",
"title": "some title",
"description": "some description",
"date": "2023-01-02"
},
{
"imageUrl": "https://example.com/image2",
"url": "https://example.com/article2",
"title": "some title",
"description": "some description",
"date": "2023-01-01"
}
]
}
]
}
  1. 授权普通成员编辑图文列表的内容
管理员可以授权普通成员编辑图文列表小组件的内容;获得授权的成员,可以打开图文列表小组件的内容设置页面,按需维护、管理工作台上的图文列表小组件。
:获得授权的普通成员,仅有图文列表小组件的内容设置权限,无其他小组件设置权限(如小组件的通用设置)或工作台权限,也不能授权其他成员进行图文列表小组件的内容设置。
3.1 进入授权页面
管理员可以通过以下任一方式进入小组件 内容设置 页面,给普通成员授权。
方式 1:进入 Lark 客户端的工作台页面,点击图文列表小组件右上角 ··· 图标 > 小组件设置,进入小组件内容设置页面。
250px|700px|reset
方式 2:进入 Lark 管理后台,打开定制工作台编辑器,选中图文列表小组件,在右侧设置区域点击 内容设置 > 前往设置,进入小组件内容设置页。
250px|700px|reset
3.2 选择授权成员
小组件权限管理 区域,配置你想授权的成员或群组名单。如果不进行权限设置,系统默认不授权其他成员进行内容设置。
250px|700px|reset
3.3 被授权成员编辑图文列表小组件的内容
权限配置完成后,获得授权的成员可以通过两种方式打开图文列表小组件的内容设置页进行编辑。关于内容设置的更多信息,参考本文第二章 操作流程 > 内容设置
方式 1:进入 Lark 客户端的工作台页面,点击图文列表小组件右上角 ··· 图标 > 小组件设置,进入小组件的内容设置页面。(推荐)
方式 2:管理员可以将图文列表小组件内容设置页的链接直接分享给被授权成员供其使用。
:被授权成员需先重启 Lark 客户端,再进入小组件设置页设置。
四、常见问题
问:为什么我没有添加图片,小组件中会展示出占位图?
这是小组件的一个默认兜底逻辑。如果不希望出现图片(占位图),需在自定义设置的列表样式下设置“无图片”。
250px|700px|reset
同理,如果企业不添加文章副标题、日期,需将副标题、日期的行数调整为 0。
250px|700px|reset
问:非管理员可以编辑“图文列表”小组件的内容吗?
管理员可以授权普通成员,让其他成员帮忙编辑“图文列表”小组件的内容,具体步骤参考本文第三章 授权普通成员编辑“图文列表”的内容
问:为什么我的自定义设置页面没有“文章列表分页展示”按钮?
此功能仅支持新版图文列表小组件,可以新建一个“图文列表”获取更新。
问:上传的图片有尺寸要求吗?
上传的图片需要为 JPG/PNG 格式,2MB 以内,无圆角。
图片宽高比支持 3:2 或 1:1,可前往工作台编辑器中选中“图文列表”小组件,在右侧 自定义设置 标签页的 图片宽高比 下进行设置。
作者Lark 帮助中心
最后更新于2024-11-19
评价此内容
提交成功,感谢你的反馈!
未能解决你的问题?请联系在线客服
0
rangeDom
rangeDom
rangeDom
rangeDom
rangeDom