Cerca...

Cerca nella documentazione...

Command

Command

Una palette dei comandi basata su cmdk — elenco di azioni filtrabile in modo fuzzy. La base per ThemePalettePicker e per il pattern globale di ricerca command-K.

import { Command, CommandInput, CommandList, CommandEmpty, CommandGroup, CommandItem, CommandSeparator, CommandShortcut } from "@pompeitech/vesuvius-ui";

Default

API

Command

PropTipoDefaultDescrizione
filter(value: string, search: string, keywords?: string[]) => numberil matcher fuzzy integrato di cmdkSovrascrivilo per personalizzare il ranking, o restituisci un 1/0 fisso per disabilitare del tutto il matching fuzzy.
shouldFilterbooleantrueImposta false se filtri tu stesso l'elenco degli elementi (ad es. ricerca lato server) invece di lasciare che lo faccia cmdk lato client.
value / onValueChangestring / (value: string) => voidElemento attualmente evidenziato, controllato o non controllato.
loopbooleanfalseSe la navigazione con le frecce torna all'inizio/fine della lista.

CommandInput — ogni prop nativa di <input>; collegato automaticamente per filtrare la lista mentre l'utente digita.

CommandList — ogni prop nativa di <div>; il viewport scrollabile che contiene gruppi/elementi.

CommandEmpty — ogni prop nativa di <div>; renderizzato solo quando nessun elemento corrisponde alla ricerca corrente.

CommandGroup

PropTipoDescrizione
headingReactNodeEtichetta renderizzata sopra gli elementi del gruppo.

CommandItem

PropTipoDescrizione
valuestringCiò che viene confrontato con la query di ricerca — di default il contenuto testuale dell'elemento se omesso.
onSelect(value: string) => voidChiamata al click o su Invio mentre è evidenziato.
disabledbooleanEsclude l'elemento dalla navigazione da tastiera e lo filtra fuori dalla selezione.

CommandSeparator — ogni prop nativa di <div>; un divisore visivo tra gruppi.

CommandShortcut — ogni prop nativa di <span>; testo allineato a destra con l'indicazione della scorciatoia (⌘P, ⌘B, ...) dentro un CommandItem.

Per una versione apribile da qualsiasi punto dell'app tramite una scorciatoia da tastiera, avvolgi Command in un Dialog.

Accessibilità

cmdk implementa automaticamente il pattern ARIA combobox/listbox — ↑/↓ spostano l'evidenziazione, Invio seleziona, digitare filtra in tempo reale, e l'elemento evidenziato viene annunciato agli screen reader tramite aria-activedescendant. Nessun collegamento ARIA manuale necessario da parte tua.