匯入

import-command.ts
import { type NuiCommand, NuiCommandPalette } from '@needless-ui/angular/command';

NuiCommandPalette

附有命令搜尋欄位的強制回應對話框。

選擇器
nui-command-palette
NuiCommandPalette: 屬性
名稱型別預設值說明
commands輸入NuiCommand[]命令,以 NuiCommand 物件的形式提供。
open雙向繫結booleanfalse面板是否開啟。
hotkey輸入string | null'mod+k'隨處開啟和關閉面板的快速鍵;設為 null 則不使用。mod 在 Apple 裝置上是 ⌘,在其他裝置上是 Ctrl。
bindShortcuts輸入booleanfalse也能在頁面的任何地方透過命令各自的快速鍵執行命令。
loop輸入booleantrue在最後一個命令上按向下鍵會回到第一個,在第一個命令上按向上鍵會跳到最後一個。
filtering輸入booleantrue在輸入時進行篩選。由伺服器篩選命令時請關閉。
loading輸入booleanfalse在結果送達前顯示載入提示列。
hints輸入booleantrue在底部顯示可用的按鍵。
virtual輸入boolean | 'auto''auto'只渲染可見的列:一律、從不,或 auto(超過 200 列時啟用)。
label輸入string'Command palette'對話框及其搜尋欄位的無障礙名稱。
placeholder輸入string'Type a command or search…'搜尋欄位為空時顯示的文字。
run輸出NuiCommand每執行一個命令就發出該命令。
queryChange輸出string在輸入時發出文字,用於伺服器端搜尋。
show方法() => void開啟面板。
hide方法() => void關閉面板。
toggle方法() => void開啟面板,或將它關閉。
back方法() => void返回上一頁。

它顯示或朗讀的所有文字也都是輸入屬性,因此可以翻譯: emptyLabel loadingLabel backLabel closeLabel moveLabel chooseLabel

NuiCommand

一個命令,或一頁命令。

NuiCommand: 屬性
名稱型別預設值說明
label屬性string顯示並用於搜尋的文字。
description屬性string顯示在主要文字下方的次要文字。
group屬性string群組相同的命令會列在該群組標題下。
keywords屬性string[]搜尋時額外比對的詞,例如同義詞。
shortcut屬性string隨命令一起顯示的按鍵,例如 mod+shift+p。
disabled屬性boolean會顯示,但無法執行。
children屬性NuiCommand[]下一層的命令:選擇此命令會將它們以頁面開啟。
run屬性() => void被選取時,在面板關閉後執行。
id屬性string供你自行使用,例如在 (run) 中區分命令。