API do componente Paleta de comandos

Importação

import-command.ts

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

NuiCommandPalette

Um diálogo modal com um campo para buscar entre os seus comandos.

Seletor: nui-command-palette

NuiCommandPalette: Propriedades
Nome	Tipo	Padrão	Descrição
`commands`Input	`NuiCommand[]`		Os comandos, como objetos `NuiCommand`.
`open`Bidirecional	`boolean`	`false`	Indica se a paleta está aberta.
`hotkey`Input	`string \| null`	`'mod+k'`	O atalho que a abre e fecha de qualquer lugar, ou `null` para nenhum. `mod` é ⌘ em dispositivos Apple e Ctrl nos demais.
`bindShortcuts`Input	`boolean`	`false`	Também executa os comandos pelos próprios atalhos, em qualquer lugar da página.
`loop`Input	`boolean`	`true`	Descer a partir do último comando leva ao primeiro, e subir a partir do primeiro leva ao último.
`filtering`Input	`boolean`	`true`	Filtra enquanto você digita. Desative quando um servidor filtrar os comandos.
`loading`Input	`boolean`	`false`	Mostra uma linha de carregamento enquanto os resultados estão a caminho.
`hints`Input	`boolean`	`true`	Mostra embaixo as teclas que você pode usar.
`virtual`Input	`boolean \| 'auto'`	`'auto'`	Renderiza só as linhas visíveis: sempre, nunca, ou `auto` acima de 200 linhas.
`label`Input	`string`	`'Command palette'`	Nome acessível do diálogo e do campo de busca dele.
`placeholder`Input	`string`	`'Type a command or search…'`	Texto mostrado no campo de busca vazio.
`run`Output	`NuiCommand`		Emite cada comando executado.
`queryChange`Output	`string`		Emite o texto enquanto ele é digitado, para uma busca no servidor.
`show`Método	`() => void`		Abre a paleta.
`hide`Método	`() => void`		Fecha a paleta.
`toggle`Método	`() => void`		Abre a paleta, ou a fecha.
`back`Método	`() => void`		Volta para a página anterior.

Todo texto que ele mostra ou anuncia também é um input, então você pode traduzi-lo: emptyLabel loadingLabel backLabel closeLabel moveLabel chooseLabel

NuiCommand

Um comando, ou uma página de comandos.

NuiCommand: Propriedades
Nome	Tipo	Descrição
`label`Propriedade	`string`	O texto mostrado e buscado.
`description`Propriedade	`string`	Texto secundário abaixo do rótulo.
`group`Propriedade	`string`	Comandos com o mesmo grupo aparecem sob esse título.
`keywords`Propriedade	`string[]`	Mais palavras que a busca encontra, como sinônimos.
`shortcut`Propriedade	`string`	Teclas mostradas junto com ele, como `mod+shift+p`.
`disabled`Propriedade	`boolean`	Aparece, mas não pode ser executado.
`children`Propriedade	`NuiCommand[]`	Comandos um nível abaixo: escolher este os abre como uma página.
`run`Propriedade	`() => void`	É executado ao ser escolhido, depois que a paleta fecha.
`id`Propriedade	`string`	Para uso próprio, como distinguir comandos em `(run)`.