Skip to main content

Module palette

Module palette 

Source
Expand description

⌘K 面板公共部分:打开句柄、全局快捷键、文本匹配与面板外壳(前台搜索与后台命令面板共用)。 ⌘K 面板公共部分:打开句柄、全局快捷键、文本匹配,以及前台搜索面板与后台命令面板 共用的状态、对话框外壳和行组件。两个面板只提供各自的数据、条目映射与选中动作。 样式见 styles/components/palette.css。

Structs§

PaletteEntry
面板一行的展示内容。
PaletteGroup
面板中的一组条目(组标签 + 若干行)。
PaletteRowProps 🔒
Props for the PaletteRow component.
PaletteShellProps 🔒
Props for the PaletteShell component.
PaletteState
面板的公共状态:打开、输入、当前项、请求进度与焦点归还。由面板组件经 use_palette_state 创建,交给 PaletteShell 渲染。
SearchPaletteHandle
打开 ⌘K 面板的句柄。前台布局挂搜索面板,后台布局挂命令面板(admin_palette), 两边的触发按钮与快捷键共用这个句柄。

Constants§

DEBOUNCE_MS 🔒
输入防抖与进度点出现的延迟(毫秒)。
EXIT_MS 🔒
关闭淡出时长(毫秒),与 palette.css 的 palette-out 时长一致。
PROGRESS_DELAY_MS 🔒

Functions§

PaletteRow 🔒
面板中的一行:左侧图标块,中间标题(可带摘要片段),右侧元信息或 ↵ 键帽。
PaletteShell 🔒
面板对话框外壳:scrim、输入行、列表、空结果与页脚。只在面板打开时渲染。
contains_ci
忽略大小写的子串匹配,空查询视为匹配。
highlight
按忽略大小写的命中切分文本,true 段需要高亮。按字符比较,中文与西文都适用。
highlighted 🔒
把文本按命中切成纯文本与 <mark> 片段。
snippet
摘要片段:截取第一处命中前后 radius 个字,两端被截断时加省略号; 没有命中时取开头。
use_palette_shortcut
全局 ⌘K / Ctrl+K:焦点在可编辑区域时不拦截。
use_palette_state
创建面板状态:打开时记下原焦点并聚焦输入框。全局快捷键由各面板的生产入口 自己用 use_palette_shortcut 注册,这里不注册。
use_search_palette
读取面板句柄;图鉴等不在前台布局内的场景返回 None。
use_search_palette_provider
在布局中提供面板句柄。
viewport_center
视口中心:从面板切换外观时,圆形扩散以此为圆心。