پرتوپرتو

پالت دستورات (Command)

یک کامپوننت جستجو و پالت دستورات سریع

معرفی

کامپوننت Command یک پالت دستورات قدرتمند برای جستجو و اجرای دستورات است. معمولا با کلید ترکیبی Cmd+K یا Ctrl+K فعال می‌شود.

استفاده

import {
  Command,
  CommandDialog,
  CommandEmpty,
  CommandGroup,
  CommandInput,
  CommandItem,
  CommandList,
} from '@parto/ui';

export default function MyComponent() {
  return (
    <Command>
      <CommandInput placeholder="جستجو کنید..." />
      <CommandList>
        <CommandEmpty>نتیجه‌ای یافت نشد.</CommandEmpty>
        <CommandGroup heading="پیشنهادات">
          <CommandItem>تقویم</CommandItem>
          <CommandItem>نشانه‌ها</CommandItem>
          <CommandItem>تنظیمات</CommandItem>
        </CommandGroup>
      </CommandList>
    </Command>
  );
}

به صورت Dialog

import { CommandDialog } from '@parto/ui';
import { useEffect, useState } from 'react';

export default function MyComponent() {
  const [open, setOpen] = useState(false);

  useEffect(() => {
    const down = (e: KeyboardEvent) => {
      if (e.key === 'k' && (e.metaKey || e.ctrlKey)) {
        e.preventDefault();
        setOpen((open) => !open);
      }
    };
    document.addEventListener('keydown', down);
    return () => document.removeEventListener('keydown', down);
  }, []);

  return (
    <CommandDialog open={open} onOpenChange={setOpen}>
      <CommandInput placeholder="جستجو کنید..." />
      <CommandList>
        <CommandEmpty>نتیجه‌ای یافت نشد.</CommandEmpty>
        <CommandGroup heading="پیشنهادات">
          <CommandItem>تقویم</CommandItem>
          <CommandItem>نشانه‌ها</CommandItem>
        </CommandGroup>
      </CommandList>
    </CommandDialog>
  );
}

با Separator

<Command>
  <CommandInput />
  <CommandList>
    <CommandGroup heading="گروه اول">
      <CommandItem>آیتم 1</CommandItem>
    </CommandGroup>
    <CommandSeparator />
    <CommandGroup heading="گروه دوم">
      <CommandItem>آیتم 2</CommandItem>
    </CommandGroup>
  </CommandList>
</Command>

با کلید میانبر

<CommandItem>
  <span>تنظیمات</span>
  <CommandShortcut>⌘S</CommandShortcut>
</CommandItem>

ویژگی‌ها

  • جستجوی فازی (Fuzzy search)
  • فیلتر کردن خودکار
  • پشتیبانی از کیبورد
  • گروه‌بندی دستورات
  • کلیدهای میانبر
  • سازگار با RTL