API del componente Paleta de comandos

Importación

import-command.ts

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

NuiCommandPalette

Un diálogo modal con un campo para buscar entre tus comandos.

Selector: nui-command-palette

NuiCommandPalette: Propiedades
Nombre	Tipo	Predeterminado	Descripción
`commands`Input	`NuiCommand[]`		Los comandos, como objetos `NuiCommand`.
`open`Bidireccional	`boolean`	`false`	Indica si la paleta está abierta.
`hotkey`Input	`string \| null`	`'mod+k'`	El atajo que la abre y la cierra desde cualquier sitio, o `null` para ninguno. `mod` es ⌘ en dispositivos Apple y Ctrl en los demás.
`bindShortcuts`Input	`boolean`	`false`	También ejecuta los comandos con sus propios atajos, en cualquier parte de la página.
`loop`Input	`boolean`	`true`	Bajar desde el último comando lleva al primero, y subir desde el primero, al último.
`filtering`Input	`boolean`	`true`	Filtra mientras escribes. Desactívalo cuando un servidor filtre los comandos.
`loading`Input	`boolean`	`false`	Muestra una fila de carga mientras llegan los resultados.
`hints`Input	`boolean`	`true`	Muestra abajo las teclas que puedes usar.
`virtual`Input	`boolean \| 'auto'`	`'auto'`	Renderiza solo las filas visibles: siempre, nunca, o `auto` con más de 200 filas.
`label`Input	`string`	`'Command palette'`	Nombre accesible del diálogo y de su campo de búsqueda.
`placeholder`Input	`string`	`'Type a command or search…'`	Texto que se muestra en el campo de búsqueda vacío.
`run`Output	`NuiCommand`		Emite cada comando que se ejecuta.
`queryChange`Output	`string`		Emite el texto a medida que se escribe, para una búsqueda en el servidor.
`show`Método	`() => void`		Abre la paleta.
`hide`Método	`() => void`		Cierra la paleta.
`toggle`Método	`() => void`		Abre la paleta, o la cierra.
`back`Método	`() => void`		Vuelve a la página anterior.

Todos los textos que muestra o anuncia también son inputs, así que puedes traducirlos: emptyLabel loadingLabel backLabel closeLabel moveLabel chooseLabel

NuiCommand

Un comando, o una página de comandos.

NuiCommand: Propiedades
Nombre	Tipo	Descripción
`label`Propiedad	`string`	El texto que se muestra y se busca.
`description`Propiedad	`string`	Texto secundario bajo la etiqueta.
`group`Propiedad	`string`	Los comandos del mismo grupo se listan bajo ese encabezado.
`keywords`Propiedad	`string[]`	Más palabras con las que coincide la búsqueda, como sinónimos.
`shortcut`Propiedad	`string`	Teclas que se muestran junto a él, como `mod+shift+p`.
`disabled`Propiedad	`boolean`	Se muestra, pero no se puede ejecutar.
`children`Propiedad	`NuiCommand[]`	Comandos un nivel más abajo: elegir este los abre como una página.
`run`Propiedad	`() => void`	Se ejecuta al elegirlo, una vez cerrada la paleta.
`id`Propiedad	`string`	Para tu propio uso, como distinguir comandos en `(run)`.