# @directus-labs/command-palette-module 中文文档

规范地址：https://npmcn.com/package/%40directus-labs/command-palette-module/

版本：2\.0\.0
npm 元数据更新时间：2026-10-28T21:21:43.887Z
中文译文更新时间：2026-11-12T12:00:30.685Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40directus-labs/command-palette-module
原文对照：https://npmcn.com/package/%40directus-labs/command-palette-module/?lang=original
项目主页：https://github.com/directus-labs/extensions#readme
源码仓库：https://github.com/directus-labs/extensions

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：236 kB，3 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：11 个
- peer 依赖：zod 4\.1\.12
- 首次发布：2024-09-03T16:46:06.352Z
- 最新版本发布：2026-10-28T21:21:43.490Z
- 近 30 天下载量：6132（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 2 个）

## 中文简介

Directus的命令调色板模块.

## 安装

```sh
npm install @directus-labs/command-palette-module
```

也可以使用：`pnpm add @directus-labs/command-palette-module`、`yarn add @directus-labs/command-palette-module`、`bun add @directus-labs/command-palette-module`

## README

# 命令调色板模块

一个命令调色板和可配置的全球搜索 Directus Studio.

![Search Demo](https://raw.githubusercontent.com/directus-labs/extensions/main/packages/command-palette-module/docs/search-demo.gif)

## 特征

-   从任何地方打开 `Cmd/Ctrl + K`
-   模糊命令匹配、 键盘导航、 命令最近、 最近的搜索和最近选定的收藏项
-   导航内容、文件、用户、见解、数据模型设置、项目设置和部署
-   搜索个人收藏
-   从调色板直接搜索所选择的收藏
-   创建项目, 上传文件, 复制版本的 API URL, 运行上下文的手动流程
-   在项目页面上:切换内容版本,打开现场预览或视觉编辑器,并复制项目链接或ID
-   打开您的书签, 转到您的档案, 切换光/ 暗主题, 并签名
-   对所有配置的收藏使用专用全局搜索页面
-   配置每个收集字段、模板、说明、过滤器、排序、结果限制和跳出率
-   询问 Directus AI 助理关于您的查询( Directus 11. 14+ 并配置了 AI 提供者)

## 所需资源

Directus 11.6或更新,包括Directus 12.

## 安装

参见 [正式扩展安装指南](https://docs.directus.io/extensions/installing-extensions.html) 用于市场和人工安装选项.

## 配置

1.  在 Directus 项目设置中启用模块 . ![Enable Module](https://raw.githubusercontent.com/directus-labs/extensions/main/packages/command-palette-module/docs/configuration-modules.png)
2.  打开模块设置, 并创建命令调色板设置字段 . ![Module Settings](https://raw.githubusercontent.com/directus-labs/extensions/main/packages/command-palette-module/docs/configuration-settings.png)
3.  配置可搜索的收藏和字段 . ![Search Setup](https://raw.githubusercontent.com/directus-labs/extensions/main/packages/command-palette-module/docs/configuration-collections.png)
4.  启用 **全球可用** 仅用于在调色板中直接返回结果的集合.

Global调色板搜索运行浏览器对权限-意识项目的请求. 它从两个字符开始,最多搜索20个可选择的可读集,同时有5个请求,每个集封顶25个结果. 保持所选入的设定,并限制大型项目.

Directus 12只允许非管理员用户读取一组已允许的列表工程设置,因此无法读取命令调色板设置字段. 为了继续搜索它们,扩展名保留了全局预设中配置的只读副本(没有收藏,布局) `command-palette`) (中文(简体) ). 当管理员保存设置或加载工作室时,它会自动创建和更新,并出现在下面 **设置 – 预设和书签**。如果删除,下一位管理员将重新创建它.

最近的搜索和所选的收藏项在当地被存储,范围被扩大至目前的Directus项目和用户.

在提供内置命令调色板的 Directus 版本上禁用此扩展;否则两个调色板都会响应相同的快捷键和开放事件.

## 常见问题

### @directus-labs/command-palette-module 是什么？

Directus的命令调色板模块\.

### 如何安装 @directus-labs/command-palette-module？

在项目目录运行 npm install @directus-labs/command-palette-module，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（4\.1\.12）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @directus-labs/command-palette-module 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/directus-labs\_\_command-palette-module 是否存在。

### @directus-labs/command-palette-module 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @directus-labs/command-palette-module 可以商用吗？

@directus-labs/command-palette-module 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @directus-labs/command-palette-module 的下载量有多少？

根据 npm 官方下载统计，@directus-labs/command-palette-module 在 2026/10/13 – 2026/11/11 这 30 天内被下载 6,132 次，日均约 204 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @directus-labs/command-palette-module 还在维护吗？

最新版本 2\.0\.0 发布于 2026/10/29（14 天前）；至今共发布 5 个版本，其中过去 12 个月发布了 2 个；首次发布于 2024/09/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。