# 文档列表

来源快照：`result_data_new_260518.json`

- 来源 ID：`1183984889993773159`
- 模块：低代码平台e-builder
- 目录：页面引擎 - 页面设计器 - 页面组件 - 模块组件 - 模块组件与公文、文档
- space ID：`1157961794811633670`
- 原文链接：未提供
- 产品基线：未提供

## 正文

## 一、功能背景及价值用途

【文档列表】主要用于在表单、门户页面或流程中动态展示或关联系统内的文档/文件，方便用户快速查看、引用或管理相关文档。

## 二、功能使用说明

### 1、功能入口

#### 1.1、登录页

文档列表支持登陆前访问

界面配置中心-登录页设置-pc/移动端登录页设置-保存进入登录页设置页面

拖入设计器内的组件数据源默认为空（图1）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540991430131788&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图1）

#### 1.2、eb设计器

设计器内拖入文档列表组件，组件数据源默认为全部（图2）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540931245129873&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图2）

### 2、功能介绍

#### 2.1、标题按钮-more按钮

启用标题中支持more按钮（图3）

点击more后可查看当前数据源下有权限的所有数据

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540995764117541&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图3）

#### 2.2、展示样式

列表样式主要分为两类：表格式和列表式。表格式用表格的形式展示数据；列表式可以更加自由灵活的排版展示数据。

列表式又分为：列表式、左图式、上图式、横向列表式和网格列表式。主要内置一些常用的列表式布局方式。

表格式显示效果：（图4）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540858392272914&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图4）

列表式显示效果：（图5）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541133271007410&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图5）

#### 2.3、数据源

数据源支持设置为：知识库、虚拟知识库、指定文档、新闻中心，数据源可在知识门户创建（图6）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540909926416431&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图6）

#### 2.4、显示字段

显示字段功能允许用户根据行业特性、需求场景自定义字段的展示方式（如字段显示布局、字段字体样式等），实现字段自由设计与展示，满足复杂业务数据个性化展示需求。（图7）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541034377707656&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图7）

#### 2.5、数据过滤

默认为请选择，支持按类型搜索、按条件搜索（图8）

登录前页面仅支持按条件搜索

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541013028700334&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图8）

##### 2.5.1、按类型搜索

默认选择为我的文档，展示我创建的文档，支持切换为：我的文档、我负责的文档、我参与的文档、我分享的文档、我关注的文档、我下属的文档、我创建的文档、共享给我的文档、我全部的文档、未读文档（图9）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541086070407173&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图9）

##### 2.5.2、条件过滤

支持根据名称、负责人、创建人、创建时间、创建人部门、创建人分部、最后修改时间、状态、允许外部分享进行数据过滤（图10）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541141795930187&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图10）

#### 2.6、字段排序

排序功能是提高数据查询效率、优化用户体验的基础工具（图11）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540853938749557&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图11）

#### 2.7显示设置

支持设置隐藏check框及文件夹模式（图12）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540901207728136&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图12）

##### 2.7.1、隐藏check框

“隐藏check框”开关开启后，数据前方的check框则不显示。数据前方的check框是用来选择数据的，如果当前列表不需要做选择数据的相关操作，可以设置隐藏。（图13）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541051626782865&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图13）

##### 2.7.2、文件夹模式

默认关闭，开启后，文档以文件夹形式展示，开启前后功能一致（图14）

文件夹模式开启后：

①只支持按条件搜索

②展示目录路径

③通过目录路径可返回是指定目录

④切换至移动端同步生效（目录路径）

⑤当列表样式为左图式、上图式、横向列表式时，不支持转换为文件夹模式

⑥当列表样式为网格列表式时：

•不支持隐藏check框设置

•支持设置网格行列、宽度、高度

•支持文件夹模式切换

⑦选则指定文档、或者过滤数据后，文档数据展示在文件夹内。文件夹内只展示符合条件的数据，不符合的数据不展示，文件夹为空

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540974233485502&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图14）

#### 2.8、文档相关

##### 2.8.1、显示置顶效果

默认开启，设置置顶文档后，置顶文档会展示在第一条，且有置顶文档标识（图15）

##### 2.8.2、置顶文档

可自由添加所要置顶的文档，此处设置的置顶文档的排序高于知识门户设置的置顶排序（图15）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540940002836570&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图15）

##### 2.8.3、正文无内容时打开附件

默认关闭，开启后当正文无数据时自动打开附件（图16）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540862698553428&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图16）

##### 2.8.4、未读样式

支持设置未读文档提示标识，默认展示图标，未读文档前有红色的标识，支持自定义修改

支持添加、取消：图标、加粗、倾斜、颜色设置（图17）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541068907315209&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图17）

##### 2.8.5、快速新建

默认关闭，开启后，预览运行时右下角展示“+”，可快速添加文档（图18）

如数据源为全部、多个自定义数据源时，弹出弹框选择所有添加到的文件夹

如数据源为单个数据源，点击新建则可直接新建文档，新建的文档自动保存到当前数据源

如无当前所选数据来源，则运行时快速新建“+”不会展示

配置：（图18）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540957135405210&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图18）

运行：（图19）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540957098819935&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图19）

#### 2.9、其他

##### 2.9.1、每页行数

默认展示为5行，支持选择5、10、20、50、100及自定义（图20）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540888359305283&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图20）

##### 2.9.2、分页模式

默认展示为隐藏分页，支持选择页码分页、点击加载更多、滚顶分页、隐藏分页（图21）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541008774848680&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图21）

##### 2.9.3、显示总数

默认展示为不显示，支持选择不显示、显示总数量（图22）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541004270166048&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)（图22）

##### 2.9.4、定时刷新

定时刷新可设置列表每隔多长时间进行一次数据更新。默认不刷新，可以设置不刷新、3分钟、5分钟、10分钟、可自定义刷新时间（单位：分钟）。自定义刷新时间最小可设置为3分钟。（图23）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541128875376758&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图23）

##### 2.9.5、自动滚动

该配置仅支持PC端。自动滚动可配置列表每间隔多少时间滚动多少条数据。默认关闭，开启后需要配置滚动方向、滚动间隔时间和滚动条数。

列表样式为表格式，列表式，左图式，上图式时支持向上和向下滚动；为横向列表式时支持向左和向右滚动。（图24）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541055832735812&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图24）

 

##### 2.9.6、高度

该配置仅支持移动端。移动端列表高度是根据数据自适应的，数据越多高度越高，如果想控制列表固定高度，可通过高度配置列表显示高度。高度默认为不固定高度，可选不固定高度、固定高度、铺满屏幕。

不固定高度：按照组件内容高度展示。固定高度：可设置具体的高度值，单位为px。铺满屏幕：设置之后组件高度展示为屏幕高度。（图25）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540862495129628&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图25）

##### 2.9.7、无数据时

无数据时可配置在列表没有展示数据时的显示效果，默认提示“暂无数据”。

可配置无数据时隐藏组件和无数据提示自定义。

无数据提示自定义中可配置提示文本、按钮或关联页面。（图26）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541042994905211&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图26）

##### 2.9.8、数据预加载

数据预加载可提高列表数据渲染速度。如果列表使用的数据源更新频率较低，或对列表显示数据实时性要求不高，可以开启数据预加载以提高渲染速度。

数据预加载默认关闭。开启后，会将列表数据缓存在前端，下一次加载时将优先使用缓存中数据进行渲染，待后端接口获取最新数据后再进行渲染更新。实际效果第一次预览/运行列表会显示加载效果，后续再次打开时，不重新加载数据（不显示加载效果）。（图27）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541098812702800&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图27）

## 三、注意事项

### 1、登录前访问

访问登录页时，需在账号未登录的情况下访问（图28）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541115982086203&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图28）

### 2、显示字段为图片字段

封面图片、文档图片：字段配置中支持自定义图片，支持素材库、本地、数据集图片（图29）

封面图片配置入口：文档-属性-封面图片

封面图片默认取设置好的图片，如果未设置则取文档内容的图片（必须是富文本中的，不支持选择附件中的）

如封面图片和文档正文均无图片，则展示系统默认图片

文档图片：默认取文档内容的第一张图片，如果正文没有图片封面有图片，则展示封面图片，如果2者都没有，那就展示系统的默认图片

封面图片、文档图片获取图片优先级：

封面图片的第一顺位是：封面图片自己，然后是文档图片，最后是系统图片

文档图片：文档正文第一张然后是封面图片，最后是系统图片

封面图片和文档图片都不支持选择附件图片，附件里的图片没有图地址，所以获取不到

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160540875625398293&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图29）

## 四、上下游关联功能点

1、

组件标题和底部使用方法，请参考：

[https://www.e-cology.com.cn/sp/doc/docEdit/1126198012134236250](https://weapp.eteams.cn/sp/ebdpage/view/freepass/1152863419640021002?id=1159789715744890921&freepass_doc=1&space_id=1157961794811633670 "https://www.e-cology.com.cn/sp/doc/docEdit/1126198012134236250")

2、显示字段使用方法，请参考：

[e-cology.com.cn/sp/doc/docEdit/1125477668787732560](https://weapp.eteams.cn/sp/ebdpage/view/freepass/1152863419640021002?id=1160523773019652097&freepass_doc=1&space_id=1157961794811633670 "e-cology.com.cn/sp/doc/docEdit/1125477668787732560")

3、数据过滤使用方法，请参考：

[https://www.e-cology.com.cn/sp/doc/docDetail/1126390211912344012](https://weapp.eteams.cn/sp/ebdpage/view/freepass/1152863419640021002?id=1159791936157941806&freepass_doc=1&space_id=1157961794811633670 "https://www.e-cology.com.cn/sp/doc/docDetail/1126390211912344012")

4、字段排序使用方法，请参考：

[https://www.e-cology.com.cn/sp/doc/docDetail/1125808419831955819](https://weapp.eteams.cn/sp/ebdpage/view/freepass/1152863419640021002?id=1159790879839256584&freepass_doc=1&space_id=1157961794811633670 "https://www.e-cology.com.cn/sp/doc/docDetail/1125808419831955819")

5、知识文档使用方法

1、

选项卡嵌套文档列表（图30）

①选项卡嵌套文档时，只开启选项卡标题，则more按钮展示在选项卡上，点击跳转后展示选项卡标题

②选项卡嵌套文档时，只开启文档列表标题，则more按钮展示在文档列表上，点击跳转后展示文档列表的标题

③选项卡嵌套文档时，同时开启选项卡和文档列列表标题，则more按钮展示在文档列表上，点击跳转后展示文档列表标题

![](https://weapp.eteams.cn/papi/file/preview?fileId=1160541176145182828&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

（图30）

6、筛选组件对文档列表数据过滤，筛选组件使用方法，请参考：

[https://www.e-cology.com.cn/sp/doc/docDetail/1130933153328161573](https://weapp.eteams.cn/sp/ebdpage/view/freepass/1152863419640021002?id=1159173701578424349&freepass_doc=1&space_id=1157961794811633670 "https://www.e-cology.com.cn/sp/doc/docDetail/1130933153328161573")
