API du composant Palette de commandes

Import

import-command.ts

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

NuiCommandPalette

Une boîte de dialogue modale avec un champ de recherche parmi vos commandes.

Sélecteur: nui-command-palette

NuiCommandPalette: Propriétés
Nom	Type	Par défaut	Description
`commands`Input	`NuiCommand[]`		Les commandes, sous forme d’objets `NuiCommand`.
`open`Bidirectionnel	`boolean`	`false`	Indique si la palette est ouverte.
`hotkey`Input	`string \| null`	`'mod+k'`	Le raccourci qui l’ouvre et la ferme depuis n’importe où, ou `null` pour aucun. `mod` vaut ⌘ sur les appareils Apple et Ctrl ailleurs.
`bindShortcuts`Input	`boolean`	`false`	Exécute aussi les commandes par leurs propres raccourcis, partout sur la page.
`loop`Input	`boolean`	`true`	Descendre depuis la dernière commande mène à la première, et monter depuis la première, à la dernière.
`filtering`Input	`boolean`	`true`	Filtre pendant la saisie. Désactivez-le quand un serveur filtre les commandes.
`loading`Input	`boolean`	`false`	Affiche une ligne de chargement en attendant les résultats.
`hints`Input	`boolean`	`true`	Affiche en bas les touches à utiliser.
`virtual`Input	`boolean \| 'auto'`	`'auto'`	Ne rend que les lignes visibles : toujours, jamais, ou `auto` au-delà de 200 lignes.
`label`Input	`string`	`'Command palette'`	Nom accessible de la boîte de dialogue et de son champ de recherche.
`placeholder`Input	`string`	`'Type a command or search…'`	Texte affiché dans le champ de recherche vide.
`run`Output	`NuiCommand`		Émet chaque commande exécutée.
`queryChange`Output	`string`		Émet le texte au fil de la saisie, pour une recherche côté serveur.
`show`Méthode	`() => void`		Ouvre la palette.
`hide`Méthode	`() => void`		Ferme la palette.
`toggle`Méthode	`() => void`		Ouvre la palette, ou la ferme.
`back`Méthode	`() => void`		Revient à la page précédente.

Chaque texte qu’il affiche ou annonce est aussi un input, que vous pouvez traduire : emptyLabel loadingLabel backLabel closeLabel moveLabel chooseLabel

NuiCommand

Une commande, ou une page de commandes.

NuiCommand: Propriétés
Nom	Type	Description
`label`Propriété	`string`	Le texte affiché et recherché.
`description`Propriété	`string`	Texte secondaire sous le libellé.
`group`Propriété	`string`	Les commandes du même groupe sont listées sous ce titre.
`keywords`Propriété	`string[]`	D’autres mots trouvés par la recherche, comme des synonymes.
`shortcut`Propriété	`string`	Les touches affichées avec elle, par exemple `mod+shift+p`.
`disabled`Propriété	`boolean`	Affichée, mais ne peut pas s’exécuter.
`children`Propriété	`NuiCommand[]`	Les commandes du niveau inférieur : choisir celle-ci les ouvre sous forme de page.
`run`Propriété	`() => void`	S’exécute quand on la choisit, une fois la palette fermée.
`id`Propriété	`string`	Pour votre propre usage, par exemple distinguer les commandes dans `(run)`.