API der Komponente Befehlspalette

Import

import-command.ts

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

NuiCommandPalette

Ein modaler Dialog mit einem Suchfeld für deine Befehle.

Selektor: nui-command-palette

NuiCommandPalette: Eigenschaften
Name	Typ	Standardwert	Beschreibung
`commands`Input	`NuiCommand[]`		Die Befehle als `NuiCommand`-Objekte.
`open`Two-Way	`boolean`	`false`	Ob die Palette geöffnet ist.
`hotkey`Input	`string \| null`	`'mod+k'`	Das Tastenkürzel, das sie von überall öffnet und schließt, oder `null` für keines. `mod` ist ⌘ auf Apple-Geräten und sonst Ctrl.
`bindShortcuts`Input	`boolean`	`false`	Führt Befehle auch über ihre eigenen Tastenkürzel aus, überall auf der Seite.
`loop`Input	`boolean`	`true`	Pfeil nach unten auf dem letzten Befehl springt zum ersten, Pfeil nach oben auf dem ersten zum letzten.
`filtering`Input	`boolean`	`true`	Filtert beim Tippen. Schalte es aus, wenn ein Server die Befehle filtert.
`loading`Input	`boolean`	`false`	Zeigt eine Ladezeile, solange Ergebnisse unterwegs sind.
`hints`Input	`boolean`	`true`	Zeigt unten die Tasten, die du verwenden kannst.
`virtual`Input	`boolean \| 'auto'`	`'auto'`	Rendert nur die sichtbaren Zeilen: immer, nie oder `auto` bei mehr als 200 Zeilen.
`label`Input	`string`	`'Command palette'`	Zugänglicher Name des Dialogs und seines Suchfelds.
`placeholder`Input	`string`	`'Type a command or search…'`	Text im leeren Suchfeld.
`run`Output	`NuiCommand`		Emittiert jeden ausgeführten Befehl.
`queryChange`Output	`string`		Emittiert den Text während der Eingabe, für eine Suche auf dem Server.
`show`Methode	`() => void`		Öffnet die Palette.
`hide`Methode	`() => void`		Schließt die Palette.
`toggle`Methode	`() => void`		Öffnet die Palette oder schließt sie.
`back`Methode	`() => void`		Geht zur vorherigen Seite zurück.

Auch jeder Text, den die Komponente anzeigt oder ansagt, ist ein Input und lässt sich so übersetzen: emptyLabel loadingLabel backLabel closeLabel moveLabel chooseLabel

NuiCommand

Ein Befehl oder eine Seite voller Befehle.

NuiCommand: Eigenschaften
Name	Typ	Beschreibung
`label`Eigenschaft	`string`	Der angezeigte und durchsuchte Text.
`description`Eigenschaft	`string`	Zusätzlicher Text unter der Beschriftung.
`group`Eigenschaft	`string`	Befehle mit derselben Gruppe stehen unter dieser Überschrift.
`keywords`Eigenschaft	`string[]`	Weitere Wörter, die die Suche findet, etwa Synonyme.
`shortcut`Eigenschaft	`string`	Tasten, die daneben angezeigt werden, etwa `mod+shift+p`.
`disabled`Eigenschaft	`boolean`	Wird angezeigt, lässt sich aber nicht ausführen.
`children`Eigenschaft	`NuiCommand[]`	Befehle eine Ebene tiefer: Wählst du diesen Befehl, öffnen sie sich als Seite.
`run`Eigenschaft	`() => void`	Wird beim Auswählen ausgeführt, sobald die Palette geschlossen ist.
`id`Eigenschaft	`string`	Für deine eigenen Zwecke, etwa um Befehle in `(run)` zu unterscheiden.