Импорт
import { type NuiCommand, NuiCommandPalette } from '@needless-ui/angular/command';NuiCommandPalette
Модальный диалог с полем поиска по вашим командам.
| Имя | Тип | По умолчанию | Описание |
|---|---|---|---|
commandsInput | NuiCommand[] | Команды в виде объектов NuiCommand. | |
openДвусторонний | boolean | false | Открыта ли палитра. |
hotkeyInput | string | null | 'mod+k' | Сочетание клавиш, которое открывает и закрывает палитру из любого места, или null, если оно не нужно. mod — это ⌘ на устройствах Apple и Ctrl на остальных. |
bindShortcutsInput | boolean | false | Выполняет команды и по их собственным сочетаниям клавиш в любом месте страницы. |
loopInput | boolean | true | Стрелка вниз на последней команде ведёт к первой, а вверх на первой — к последней. |
filteringInput | boolean | true | Фильтрует по мере ввода. Отключите, если команды фильтрует сервер. |
loadingInput | boolean | false | Показывает строку загрузки, пока результаты не пришли. |
hintsInput | boolean | true | Показывает внизу подсказки по клавишам. |
virtualInput | boolean | 'auto' | 'auto' | Рендерит только видимые строки: всегда, никогда или auto — свыше 200 строк. |
labelInput | string | 'Command palette' | Доступное имя диалога и его поля поиска. |
placeholderInput | string | 'Type a command or search…' | Текст в пустом поле поиска. |
runOutput | NuiCommand | Передаёт каждую выполненную команду. | |
queryChangeOutput | string | Передаёт текст по мере ввода — для поиска на сервере. | |
showМетод | () => void | Открывает палитру. | |
hideМетод | () => void | Закрывает палитру. | |
toggleМетод | () => void | Открывает или закрывает палитру. | |
backМетод | () => void | Возвращает на предыдущую страницу. |
Все видимые и озвучиваемые тексты — тоже входные свойства, так что их можно перевести: emptyLabel loadingLabel backLabel closeLabel moveLabel chooseLabel
NuiCommand
Одна команда или страница команд.
| Имя | Тип | По умолчанию | Описание |
|---|---|---|---|
labelСвойство | string | Видимый текст, по которому идёт поиск. | |
descriptionСвойство | string | Второстепенный текст под подписью. | |
groupСвойство | string | Команды с одинаковой группой выводятся под её заголовком. | |
keywordsСвойство | string[] | Дополнительные слова для поиска, например синонимы. | |
shortcutСвойство | string | Клавиши, показанные рядом с командой, например mod+shift+p. | |
disabledСвойство | boolean | Показывается, но не выполняется. | |
childrenСвойство | NuiCommand[] | Команды уровнем ниже: выбор этой команды открывает их как страницу. | |
runСвойство | () => void | Вызывается при выборе, после закрытия палитры. | |
idСвойство | string | Для ваших нужд, например чтобы различать команды в (run). |