Back to Details

object-list-views

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Steedos Object List Views | Steedos 对象列表视图

Steedos 对象列表视图

Overview | 概述

概述

List views define how records are displayed in table format. Each view is a separate 
.listview.yml
file in the object's 
listviews/
subfolder.
列表视图定义记录的表格显示方式。每个视图是独立的 
.listview.yml
文件，位于对象的 
listviews/
子文件夹中。
列表视图定义记录以表格格式展示的方式。每个视图是一个独立的 
.listview.yml
文件，位于对象的 
listviews/
子文件夹中。

File Location | 文件位置

文件位置

steedos-packages/
└── my-package/
    └── main/default/
        └── objects/
            └── orders/
                └── listviews/
                    ├── all.listview.yml
                    ├── my_orders.listview.yml
                    ├── pending_approval.listview.yml
                    └── high_value.listview.yml
steedos-packages/
└── my-package/
    └── main/default/
        └── objects/
            └── orders/
                └── listviews/
                    ├── all.listview.yml
                    ├── my_orders.listview.yml
                    ├── pending_approval.listview.yml
                    └── high_value.listview.yml

List View Structure | 列表视图结构

列表视图结构

yaml
undefined
yaml
undefined

objects/orders/listviews/all.listview.yml

objects/orders/listviews/all.listview.yml

name: all label: 所有订单 is_enable: true shared: true shared_to: space filter_scope: space crud_mode: table columns:
  • field: order_number
  • field: customer
  • field: total_amount
  • field: status
  • field: created sort:
  • field_name: created order: desc searchable_fields:
  • field: order_number
  • field: customer mobile_columns:
  • field: order_number
  • field: status
undefined
name: all label: 所有订单 is_enable: true shared: true shared_to: space filter_scope: space crud_mode: table columns:
  • field: order_number
  • field: customer
  • field: total_amount
  • field: status
  • field: created sort:
  • field_name: created order: desc searchable_fields:
  • field: order_number
  • field: customer mobile_columns:
  • field: order_number
  • field: status
undefined

Properties | 属性

属性

PropertyTypeRequiredDescription
name
stringYesUnique view name
label
stringYesDisplay label (use the language of the user's prompt)
is_enable
booleanYesEnable/disable view
crud_mode
stringNo⚠️ MUST be 
table
(default) or 
cards
. No other values are valid.
columns
arrayYesDisplayed columns
shared
booleanNoShare with all users
shared_to
stringNo⚠️ MUST be one of: 
mine
(default), 
space
, 
organizations
. No other values are valid.
filter_scope
stringYes⚠️ MUST be 
space
(all records, default) or 
mine
(my records only). No other values are valid.
filters
arrayNoDefault filter conditions
sort
arrayNoDefault sort order (each item: 
field_name
+ 
order
: ⚠️ 
order
MUST be 
asc
or 
desc
)
searchable_fields
arrayNoFull-text search fields
mobile_columns
arrayNoMobile-optimized columns
extra_columns
arrayNoHidden columns (available for formulas)
scrolling_mode
stringNo⚠️ MUST be one of: 
standard
(default), 
virtual
, 
infinite
. No other values are valid.
show_count
booleanNoShow record count
属性类型是否必填描述
name
字符串是唯一视图名称
label
字符串是显示标签（使用用户提示的语言）
is_enable
布尔值是启用/禁用视图
crud_mode
字符串否⚠️ 必须为 
table
（默认值）或 
cards
，不支持其他值。
columns
数组是显示列
shared
布尔值否与所有用户共享
shared_to
字符串否⚠️ 必须为以下值之一：
mine
（默认值）、
space
、
organizations
，不支持其他值。
filter_scope
字符串是⚠️ 必须为 
space
（所有记录，默认值）或 
mine
（仅我的记录），不支持其他值。
filters
数组否默认筛选条件
sort
数组否默认排序规则（每个项包含 
field_name
和 
order
：⚠️ 
order
必须为 
asc
或 
desc
）
searchable_fields
数组否全文搜索字段
mobile_columns
数组否移动端优化列
extra_columns
数组否隐藏列（可用于公式计算）
scrolling_mode
字符串否⚠️ 必须为以下值之一：
standard
（默认值）、
virtual
、
infinite
，不支持其他值。
show_count
布尔值否显示记录数量

Columns | 列配置

列配置

yaml
undefined
yaml
undefined

Simple column

简单列配置

columns:
  • field: name
columns:
  • field: name

With width and wrapping

自定义宽度与自动换行

columns:
  • field: name width: '200' wrap: true
  • field: description width: '300' wrap: true
undefined
columns:
  • field: name width: '200' wrap: true
  • field: description width: '300' wrap: true
undefined

Filters | 筛选器

筛选器

yaml
undefined
yaml
undefined

Single filter

单个筛选条件

filters:
  • ["status", "=", "active"]
filters:
  • ["status", "=", "active"]

Multiple filters (AND)

多个筛选条件（逻辑与）

filters:
  • ["status", "=", "active"]
  • ["total_amount", ">", 10000]
filters:
  • ["status", "=", "active"]
  • ["total_amount", ">", 10000]

Current user

当前用户筛选

filters:
  • ["owner", "=", "{userId}"]
filters:
  • ["owner", "=", "{userId}"]

Date-based

基于日期的筛选

filters:
  • ["created", ">=", "{last_n_days(7)}"]
undefined
filters:
  • ["created", ">=", "{last_n_days(7)}"]
undefined

Filter Operators | 筛选运算符

筛选运算符

OperatorDescription
=
Equal
!=
Not equal
>
Greater than
>=
Greater than or equal
<
Less than
<=
Less than or equal
contains
Contains text
startswith
Starts with
in
In list
notin
Not in list
between
Between range
运算符描述
=
等于
!=
不等于
>
大于
>=
大于等于
<
小于
<=
小于等于
contains
包含文本
startswith
以指定文本开头
in
在列表中
notin
不在列表中
between
在范围内

Sorting | 排序

排序

yaml
sort:
  - field_name: status
    order: asc
  - field_name: created
    order: desc
yaml
sort:
  - field_name: status
    order: asc
  - field_name: created
    order: desc

Complete Examples | 完整示例

完整示例

All Records View | 全部记录视图

全部记录视图

yaml
undefined
yaml
undefined

objects/orders/listviews/all.listview.yml

objects/orders/listviews/all.listview.yml

name: all label: 所有订单 is_enable: true shared: true shared_to: space filter_scope: space crud_mode: table columns:
  • field: order_number
  • field: customer
  • field: order_date
  • field: total_amount
  • field: status
  • field: owner
  • field: created sort:
  • field_name: created order: desc searchable_fields:
  • field: order_number
  • field: customer mobile_columns:
  • field: order_number
  • field: total_amount
  • field: status
undefined
name: all label: 所有订单 is_enable: true shared: true shared_to: space filter_scope: space crud_mode: table columns:
  • field: order_number
  • field: customer
  • field: order_date
  • field: total_amount
  • field: status
  • field: owner
  • field: created sort:
  • field_name: created order: desc searchable_fields:
  • field: order_number
  • field: customer mobile_columns:
  • field: order_number
  • field: total_amount
  • field: status
undefined

My Records View | 我的记录视图

我的记录视图

yaml
undefined
yaml
undefined

objects/orders/listviews/my_orders.listview.yml

objects/orders/listviews/my_orders.listview.yml

name: my_orders label: 我的订单 is_enable: true shared: true filter_scope: mine crud_mode: table columns:
  • field: order_number
  • field: customer
  • field: total_amount
  • field: status sort:
  • field_name: created order: desc
undefined
name: my_orders label: 我的订单 is_enable: true shared: true filter_scope: mine crud_mode: table columns:
  • field: order_number
  • field: customer
  • field: total_amount
  • field: status sort:
  • field_name: created order: desc
undefined

Filtered View | 筛选视图

筛选视图

yaml
undefined
yaml
undefined

objects/orders/listviews/pending_approval.listview.yml

objects/orders/listviews/pending_approval.listview.yml

name: pending_approval label: 待审批 is_enable: true shared: true filter_scope: space crud_mode: table filters:
  • ["status", "=", "submitted"] columns:
  • field: order_number
  • field: customer
  • field: total_amount
  • field: submitted_at
  • field: owner sort:
  • field_name: submitted_at order: asc
undefined
name: pending_approval label: 待审批 is_enable: true shared: true filter_scope: space crud_mode: table filters:
  • ["status", "=", "submitted"] columns:
  • field: order_number
  • field: customer
  • field: total_amount
  • field: submitted_at
  • field: owner sort:
  • field_name: submitted_at order: asc
undefined

High Value View | 高价值视图

高价值视图

yaml
undefined
yaml
undefined

objects/orders/listviews/high_value.listview.yml

objects/orders/listviews/high_value.listview.yml

name: high_value label: 高价值订单 is_enable: true shared: true filter_scope: space crud_mode: table filters:
  • ["total_amount", ">", 50000] columns:
  • field: order_number
  • field: customer
  • field: total_amount width: '150'
  • field: status
  • field: owner sort:
  • field_name: total_amount order: desc
undefined
name: high_value label: 高价值订单 is_enable: true shared: true filter_scope: space crud_mode: table filters:
  • ["total_amount", ">", 50000] columns:
  • field: order_number
  • field: customer
  • field: total_amount width: '150'
  • field: status
  • field: owner sort:
  • field_name: total_amount order: desc
undefined

Best Practices | 最佳实践

最佳实践

  1. Limit columns: 5-8 columns for readability
  2. Add searchable_fields: Enable search on key fields
  3. Mobile columns: Only essential fields for mobile
  4. Meaningful filters: Create views that match common workflows
  5. Label follows user's language: Write 
    label
    in the language of the user's prompt. For i18n, use the translations skill
  6. Default sort: Always specify a meaningful sort order
  1. 限制列数：为保证可读性，列数控制在5-8列
  2. 添加可搜索字段：为关键字段启用搜索功能
  3. 移动端列配置：仅保留移动端必备字段
  4. 设置有意义的筛选条件：创建符合常见工作流程的视图
  5. 标签遵循用户语言：
    label
    使用用户提示的语言编写。如需国际化，请使用翻译功能
  6. 默认排序规则：始终指定有意义的排序顺序