Application design frequently asked questions（应用设计常见问题）¶

When should I embed other modules in my Workshop module?¶

Embed Workshop modules to separate logic and reduce the number of variables contained in one large module with many distinct components or independent pages that users must navigate. If you reuse an interface across multiple pages in a single module, then you should consider using embedded modules to streamline module maintenance over time.

Use a centered pop-up window for critical tasks or decisions that require a user's undivided attention, such as confirmations, alerts, or action forms.

Use a drawer popover for secondary tasks that contain supplementary information, such as details about a component, settings, or secondary actions. Drawer popovers keep the module's main content visible, as users may need to reference that content to help them complete a secondary task you embed in the popover.

When should I use an Object Table versus an Object List?¶

Use an Object Table to display data with multiple attributes or columns, enabling comparison, sorting, and bulk actions.

Use an Object List for simpler, linear content with few attributes, enabling fast review or single-item actions.

When should I use a collapsible section versus a completely hidden section that a user opens by selecting a button?¶

Use a collapsible section when you want users to be able to render and hide content while keeping the section's location visible. Collapsible sections are most compatible with side panels and filters that contain supplementary information. You can configure visibility through a user toggle or through variable-based logic.

Hide a section that a user makes visible through button selection when the section's content is only relevant for certain actions or use cases within your module. This can also be useful for modules with dense user interfaces or limited screen space when a collapsible section is already used.

If you are building an application for use on a mobile device, then you should review the mobile design best practices documentation.

:::callout{theme="neutral"} You should avoid stacking collapsible sections. :::

When should I show the side panel by default?¶

Show a side panel by default when:

Its content is essential or frequently used, such as content that aids in module navigation or provides critical metrics.
The panel's user interface is simple.
Users will primarily use your module on larger screens, meaning space is not a constraint.

You should use a collapsible or hidden section when the panel is optional, contains secondary information, or when users will primarily use your module on smaller screens.

When should I create a page overlay?¶

Review the overlays section of the core concepts documentation to determine if an overlay is appropriate for your specific workflow.

中文翻译¶

应用设计常见问题¶

何时应在我的 Workshop 模块中嵌入其他模块？¶

嵌入 Workshop 模块可以分离逻辑，并减少包含众多不同组件或用户必须导航的独立页面的大型模块中的变量数量。如果您在单个模块的多个页面中重复使用某个界面，则应考虑使用嵌入模块，以便随着时间的推移简化模块维护工作。

对于需要用户全神贯注处理的关键任务或决策（如确认、警报或操作表单），请使用居中弹出窗口。

对于包含补充信息的次要任务（如组件详情、设置或次要操作），请使用抽屉式弹出窗口。抽屉式弹出窗口能保持模块主要内容可见，因为用户可能需要参考这些内容来协助完成您嵌入在弹出窗口中的次要任务。

何时应使用对象表(Object Table)，何时应使用对象列表(Object List)？¶

使用对象表来显示具有多个属性或列的数据，从而支持比较、排序和批量操作。

使用对象列表来显示属性较少、更简单的线性内容，从而支持快速浏览或单项操作。

何时应使用可折叠区域(Collapsible section)，何时应使用用户通过点击按钮打开的完全隐藏区域？¶

当您希望用户能够显示和隐藏内容，同时保持该区域位置可见时，请使用可折叠区域。可折叠区域最适合与包含补充信息的侧边面板(Side panel)和筛选器配合使用。您可以通过用户切换开关或基于变量的逻辑来配置可见性。

当区域内容仅与模块中的某些特定操作或用例相关时，应将其完全隐藏，让用户通过点击按钮来显示。对于用户界面密集或屏幕空间有限且已使用可折叠区域的模块，这种方法也非常有用。

如果您正在构建用于移动设备的应用程序，则应查阅移动设计最佳实践文档。

:::callout{theme="neutral"} 应避免堆叠可折叠区域。 :::

何时应默认显示侧边面板？¶

在以下情况下，应默认显示侧边面板：

其内容至关重要或经常使用，例如辅助模块导航或提供关键指标的内容。
面板的用户界面简洁。
用户主要在大屏幕上使用您的模块，即空间不受限制。

当面板为可选、包含次要信息，或用户主要在小屏幕上使用您的模块时，您应使用可折叠或隐藏区域。

何时应创建页面覆盖层(Page overlay)？¶

请查阅核心概念文档中的覆盖层部分，以确定覆盖层是否适合您的特定工作流。