Communitygithub.com

YepAPI/skills

cmdk 整合、Cmd+K 觸發、模糊搜尋、分組動作、鍵盤導航與動態動作註冊。

skills 是什麼?

此技能描述如何利用 `cmdk` 函式庫,在應用程式中建立一個強大且可存取的指令面板(Command Palette)。其主要優點是提供使用者一個快速、統一的介面,透過鍵盤快捷鍵(Mac 上的 Cmd+K 或 Windows/Linux 上的 Ctrl+K)即可觸發,實現模糊搜尋、分組動作與快速導航。此技能支援各種前端平台(如 React/Next.js),並說明了清晰的實作模式,包括全域鍵盤監聽、使用 `cmdk` 內建的模糊搜尋與分組功能、最近使用項目儲存(localStorage),以及根據頁面上下文動態註冊動作。開發者可直接採用提供的程式碼模式,無需自行實作複雜的模糊搜尋演算法,從而提升開發效率與使用者體驗。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/YepAPI/skills/tree/HEAD/skills/command-palette

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

指令面板

規則

  • 使用 cmdk 函式庫 — 內建可組合、可存取、快速的模糊搜尋
  • 觸發方式:Cmd+K (Mac) / Ctrl+K (Windows/Linux) — 註冊全域鍵盤監聽器
  • 分組動作:導航(頁面)、指令(動作)、最近使用(最近選取)— 顯示群組標題
  • 鍵盤導航:使用方向鍵移動、Enter 選取、Escape 關閉 — 全部由 cmdk 處理
  • 模糊搜尋:cmdk 自動過濾 — 根據分數排名比對並高亮顯示
  • 最近項目:在 localStorage 儲存最近選取的 5-10 個項目 — 輸入框為空時顯示在最上方
  • 動態動作:從應用程式不同部分註冊動作 — 具情境感知(不同頁面顯示不同動作)
  • 載入狀態:非同步搜尋結果(例如 API 搜尋)— 在結果區域顯示載入指示器

模式

import { Command } from "cmdk";
import { useEffect, useState } from "react";
import { useRouter } from "next/navigation";

function CommandPalette() {
  const [open, setOpen] = useState(false);
  const router = useRouter();

  // 全域鍵盤快捷鍵
  useEffect(() => {
    const handleKeyDown = (e: KeyboardEvent) => {
      if (e.key === "k" && (e.metaKey || e.ctrlKey)) {
        e.preventDefault();
        setOpen((prev) => !prev);
      }
    };
    document.addEventListener("keydown", handleKeyDown);
    return () => document.removeEventListener("keydown", handleKeyDown);
  }, []);

  return (
    <Command.Dialog open={open} onOpenChange={setOpen} label="指令面板">
      <Command.Input placeholder="搜尋或輸入指令..." />
      <Command.List>
        <Command.Empty>找不到結果。</Command.Empty>

        <Command.Group heading="最近使用">
          {recentItems.map((item) => (
            <Command.Item key={item.id} onSelect={() => { router.push(item.href); setOpen(false); }}>
              {item.label}
            </Command.Item>
          ))}
        </Command.Group>

        <Command.Group heading="導航">
          <Command.Item onSelect={() => { router.push("/dashboard"); setOpen(false); }}>
            儀表板
          </Command.Item>
          <Command.Item onSelect={() => { router.push("/settings"); setOpen(false); }}>
            設定
          </Command.Item>
        </Command.Group>

        <Command.Group heading="指令">
          <Command.Item onSelect={() => { toggleTheme(); setOpen(false); }}>
            切換深色模式
          </Command.Item>
          <Command.Item onSelect={() => { logout(); setOpen(false); }}>
            登出
          </Command.Item>
        </Command.Group>
      </Command.List>
    </Command.Dialog>
  );
}

避免事項

  • 自行建立模糊搜尋 — cmdk 已內建處理過濾、評分與排名
  • 忘記在 Cmd+K 上呼叫 e.preventDefault() — 否則瀏覽器預設的搜尋/網址列會開啟
  • 遺漏 Escape 按鍵處理 — cmdk 透過 onOpenChange 處理,但請確保焦點回到先前的元素
  • 僅使用靜態動作 — 應根據頁面上下文動態註冊動作(例如「編輯這篇文章」僅在文章頁面顯示)
  • 沒有空狀態 — 當搜尋沒有符合結果時,務必顯示「找不到結果」

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

YepAPI/skills

WCAG 2.1 AA — semantic HTML, keyboard navigation, screen readers.

YepAPI/skills

Experiment setup, variant splitting, statistical significance, and feature flag integration.

YepAPI/skills

CRUD generators, data tables, user management, role-based access, and bulk operations.

YepAPI/skills

Monitor what ChatGPT and Gemini say about your brand using YepAPI.

YepAPI/skills

Queue workers with BullMQ/Inngest/Trigger.dev, job retries, dead letter queues, concurrency.

YepAPI/skills

Commander.js, interactive prompts with Clack, spinners, colors, config files, exit codes, and npm publishing.

YepAPI/skills

Content planning with trend and sentiment data from YepAPI.

YepAPI/skills

Content calendar, keyword-driven planning, and content briefs.

YepAPI/skills

Theme switching with CSS variables, system preference detection, next-themes, and persistence.

YepAPI/skills

Threaded comments, @mentions, reactions, moderation queue, optimistic UI, and cursor pagination.

YepAPI/skills

Competitive analysis between domains using YepAPI.

YepAPI/skills

Layout grids, KPI cards, data tables with sorting/filtering, sidebar navigation, and responsive breakpoints.

YepAPI/skills

Data encryption — TLS everywhere, AES-256-GCM for PII, bcrypt passwords, encrypted backups.

YepAPI/skills

Chart patterns with Recharts/Nivo/D3, responsive containers, color scales, and accessibility.

YepAPI/skills

Drizzle schema definition, push vs migrate, type-safe queries, relations, transactions, and prepared statements.

YepAPI/skills

Upload handling, resize/compress, CDN delivery, blur placeholders, and next/image patterns.

YepAPI/skills

Local business and Google Maps research using YepAPI.

YepAPI/skills

Cursor-based pagination, IntersectionObserver, virtualized lists with @tanstack/react-virtual, and scroll position restoration.

YepAPI/skills

Tenant isolation (row-level vs schema), subdomain routing, per-tenant config, and data partitioning.

YepAPI/skills

Chat UI components, streaming responses with AI SDK, context window management, and RAG patterns.

相關技能