分类： 桌面

桌面

桌面是你登录后看到的第一个屏幕。它会为你可以使用的每个应用显示一个图标，例如 ERPNext、Frappe HR 和 Framework。选择某个应用即可打开它。

桌面是工作台导航的顶层，导航分三步进行：

  1. 应用，位于桌面上。选择你想在其中工作的应用。
  2. 模块，位于停靠栏上。选择该应用中的区域。
  3. 模块中的所有内容，位于侧边栏上。选择要打开的内容。

从更早的 Version 16 版本升级而来的站点可能仍会显示较旧的桌面图标网格。该网格仅作为过渡期间的备用方案保留；请参阅桌面图标网格。

关于桌面如何与工作台的其他部分配合，请参阅工作台导航。

开始之前

  • 每个人都能看到桌面。它只显示你有权限使用的应用。

打开应用

  1. 登录。桌面随即打开。
  2. 选择一个应用。它会在该应用选定的页面上打开，通常是它的第一个模块。

顶部的搜索栏会搜索整个站点，铃铛和你的个人资料图片会打开通知和你的用户菜单。

返回桌面

从工作台的任何位置，你可以：

  • 选择停靠栏顶部的应用徽标（其工具提示显示为所有应用）；或者
  • 选择侧边栏顶部的模块名称，然后选择所有应用。

停靠栏顶部高亮显示的应用徽标可返回桌面。

登录后跳过桌面

如果你始终在一个应用中工作，可以在登录后直接打开它。在你的用户记录上设置默认应用。系统管理员可以在系统设置中为所有尚未选择默认应用的人设置默认应用。

哪些应用会出现

当满足以下条件时，应用会出现在应用屏幕上：

  • 它声明自己出现在应用屏幕上（请参阅面向开发者）；
  • 你通过了该应用自身的权限检查（如果它有的话）；并且
  • 该应用的设置已完成，除非你是系统管理员。

配套应用——即将其模块添加到另一个应用的停靠栏的应用——不会获得自己的图标。它的模块会改为出现在宿主应用的停靠栏上。请参阅配套应用。

应用按各自声明的编号排序，编号最小的排在最前，Framework 始终排在最后。

桌面图标网格

更早的 Version 16 版本打开时会显示一个桌面图标网格，这些图标可以指向工作区、侧边栏或链接，并可以整理到文件夹中。该网格现在是一个备用方案，保留它是为了让升级后站点的主屏幕不会在用户不知情的情况下发生变化。新站点从不使用它，并且在大多数站点迁移到应用屏幕后，它将在未来的版本中被移除。

从更早的 Version 16 版本升级而来的站点上的桌面图标网格。

在升级后的站点上，系统管理员和工作区管理员会被邀请一次尝试应用屏幕。系统管理员也可以随时将站点迁移过来：

  1. 在搜索栏中搜索桌面设置并打开它。
  2. 将桌面页面设置为应用。
  3. 保存。

这会在站点上的每个人下次加载工作台时更改他们的桌面。不会删除任何内容：图标及其排列方式都会保留，因此站点在完成迁移之前可以返回桌面图标。只有桌面会改变；停靠栏和侧边栏在两种情况下工作方式相同。请参阅迁移到新导航。

面向开发者：将你的应用放到桌面上

在你的应用的 hooks.py 中声明 add_to_apps_screen。关于钩子如何工作，请参阅 hooks。

add_to_apps_screen = [
    {
        "name": "my_app",
        "logo": "/assets/my_app/images/logo.svg",
        "title": "My App",
        "route": "/desk/my-module",
        "has_permission": "my_app.utils.check_app_permission",
        "sequence_id": 50,
    }
]
键 作用
name 应用的名称，与 hooks.py 中一致
logo 显示在应用屏幕上和应用停靠栏顶部的图标
title 显示在图标下方的名称
route 图标将用户带到哪里，通常是应用的第一个模块
has_permission 可选。一个函数，返回当前用户是否可以使用该应用。未通过检查的用户既看不到图标，也看不到该应用的停靠栏
sequence_id 可选。应用在应用屏幕上的位置；数值越小越靠前。没有设置的应用默认为 100，Framework 固定排在最后，为 1000

对于某个用户未通过 has_permission 的应用，工作台仍然知道它的名称，因此任何引用它的内容都能被正确标注。

要在你的应用打开后为它提供模块停靠栏，请随应用一起发布一个停靠栏。请参阅面向开发者：发布你的应用的停靠栏。

疑难解答

应用屏幕上缺少某个应用。 你可能未通过它的权限检查，它的设置可能尚未完成，或者它可能是一个配套应用，其模块位于另一个应用的停靠栏上。开发者可以检查该应用是否声明了 add_to_apps_screen。

我看到的是图标网格，而不是应用图标。 该站点已升级，但仍处于备用网格上。系统管理员可以在桌面设置中将其迁移到应用屏幕。

升级后，部分图标从图标网格中消失了。 如果某个图标打开的是没有自己工作区的侧边栏，它可能不再显示。请参阅已知问题。

登录后打开的是某个应用而不是桌面。 你的用户记录或系统设置中设置了默认应用。

常见问题

新站点应该使用图标网格吗？
不应该。应用屏幕才是预期的桌面，图标网格仅为升级后的站点在迁移期间保留。

每个用户可以自己选择桌面吗？
不可以。桌面页面适用于整个站点。每个用户可以设置自己的默认应用来跳过桌面。

为什么 Framework 总是排在最后？
Framework 声明的编号是 1000，所以它排在你日常使用的应用之后。

  • Desk 导航
  • Dock
  • 侧边栏
  • 迁移到新导航
  • 工作区