このページは機械翻訳のため、誤りを含む場合があります。 英語の原文を読む

要素

Command

コマンドパレットは、コマンドの一覧に対する検索フィールドです。ユーザーが数文字入力すると、一覧は一致するコマンドに絞り込まれ、矢印キーでハイライトが移動し、Return でハイライトされたコマンドが実行されます。Command は、フィルタリング、セクション、ハイライト、キーボード、スクリーンリーダーが読み上げる内容といった、パレットの動作を担います。フィルタリングはネイティブで実行され、行は仮想化されます。表示範囲の行だけが作成されるため、数千件のコマンド、ファイル、絵文字を含むパレットでも、キー入力のたびにフィルタリングできます。見た目はアプリ側が決めます。コマンド自体は何も描画せず、アプリが各パーツ(itemClass、groupClass、searchClass など)にスタイルを適用し、行の内容(renderItem:アイコン、ラベル、ショートカットのキー)を描画します。

el-command.tsx
el-command.tsxLive
import { keymap, mount, signal, Text, View } from "nsh";
import { Command, type CommandItem, type CommandRef } from "nsh/base";
import {
  CommandEmpty,
  CommandHeading,
  CommandRow,
  commandClasses,
  desktop,
  Icon,
  type IconName,
  Log,
  Panel,
  Split,
  ui,
  wide,
} from "./palette";

// A command palette: sections with headings, shortcuts shown as the
// platform writes them, a disabled command, the appearance in effect
// checked, keywords that find a command by another word. The command owns
// the filtering, the highlight, the keys and the semantics; every pixel is
// `commandClasses` and `CommandRow`.
const icons: Record<string, IconName> = {
  new: "plus",
  open: "folder",
  save: "download",
  share: "share",
  find: "search",
  replace: "replace",
  terminal: "terminal",
  sidebar: "sidebar",
  dark: "moon",
  light: "sun",
  docs: "document",
  feedback: "chat",
};

const appearance = signal<"dark" | "light">("dark");
const highlighted = signal<string | null>(null);
const query = signal("");
const events = signal<string[]>([]);
const log = (line: string) => events.set([line, ...events()].slice(0, 4));
let palette: CommandRef | undefined;

const items = (): CommandItem[] => [
  { id: "new", label: "New File", group: "File", shortcut: "mod+n" },
  { id: "open", label: "Open Folder…", group: "File", shortcut: "mod+o" },
  { id: "save", label: "Save All", group: "File", shortcut: "mod+alt+s" },
  { id: "share", label: "Share Project", group: "File", disabled: true },
  { id: "find", label: "Find in Files", group: "Edit", shortcut: "mod+shift+f", keywords: ["search", "grep"] },
  { id: "replace", label: "Replace in Files", group: "Edit", shortcut: "mod+shift+h" },
  { id: "terminal", label: "Toggle Terminal", group: "View", shortcut: "ctrl+j", keywords: ["console", "shell"] },
  { id: "sidebar", label: "Toggle Sidebar", group: "View", shortcut: "mod+b" },
  { id: "dark", label: "Dark Appearance", group: "View", keywords: ["theme"], checked: appearance() === "dark" },
  { id: "light", label: "Light Appearance", group: "View", keywords: ["theme"], checked: appearance() === "light" },
  { id: "docs", label: "Open Documentation", group: "Help", keywords: ["guide", "manual"] },
  { id: "feedback", label: "Send Feedback", group: "Help" },
];

function App() {
  keymap.bind("mod+k", () => palette?.focus());
  return (
    <View style={{ flex: 1, backgroundColor: ui().page, padding: 20, paddingTop: 24, gap: 14 }}>
      <Text style={{ fontSize: 22, fontWeight: "700", color: ui().text }}>command</Text>
      <Text style={{ color: ui().muted }}>
        {desktop
          ? `Type to filter, the arrows to move, Return to run, Escape to clear; ${keymap.label("mod+k")} focuses it`
          : "Type to filter, tap a command to run it"}
      </Text>

      <Split
        gap={14}
        inspector={
          <>
            <Panel title="highlighted">
              <Text style={{ fontSize: 13, color: ui().text }}>{highlighted() ?? "none"}</Text>
            </Panel>
            <Panel title="query">
              <Text style={{ fontSize: 13, color: ui().text }}>{query() ? `“${query()}”` : "empty"}</Text>
            </Panel>
            <Log title="events" lines={events()} minHeight={92} />
          </>
        }
      >
        <View style={{ width: wide() ? 380 : undefined, alignSelf: wide() ? "center" : "stretch" }}>
          <Command
            ref={(r) => (palette = r)}
            items={items()}
            query={query()}
            onQueryChange={({ query: next }) => query.set(next)}
            onHighlightChange={({ highlighted: next }) => highlighted.set(next)}
            onCancel={() => log("onCancel()")}
            onSelect={({ id }) => {
              if (id === "dark" || id === "light") appearance.set(id);
              log(`onSelect({ id: "${id}" })`);
            }}
            placeholder="Type a command or search…"
            accessibilityLabel="Commands"
            searchAccessibilityLabel="Search commands"
            class={commandClasses.root}
            searchBarClass={commandClasses.searchBar}
            searchClass={commandClasses.search}
            listClass={commandClasses.list}
            groupClass={commandClasses.group}
            separatorClass={commandClasses.separator}
            itemClass={commandClasses.item}
            style={{ height: desktop ? 360 : 400 }}
            searchPrefix={<Icon name="search" size={16} tint={ui().muted} />}
            empty={<CommandEmpty label="No commands match" />}
            renderGroup={(group) => <CommandHeading group={group} />}
            renderItem={(entry) => <CommandRow entry={entry} icon={icons[entry.id]} note={entry.disabled ? "Pro" : undefined} />}
          />
        </View>
      </Split>
    </View>
  );
}

mount(App);
use nsh_base::{CommandEntry, CommandItem, command, theme};
use nsh_core::prelude::*;

fn palette() -> impl IntoElement {
    let items = vec![
        CommandItem::new("new", "New File").group("File").shortcut("mod+n"),
        CommandItem::new("open", "Open…").group("File").shortcut("mod+o"),
        CommandItem::new("theme", "Toggle Theme").group("View").keywords(["dark", "light"]),
        CommandItem::new("settings", "Settings").group("View").shortcut("mod+,"),
    ];
    let chosen = signal(SharedString::from("none"));
    command()
        .items(items)
        .placeholder("Type a command or search…")
        .accessibility_label("Commands")
        .auto_focus(true)
        .on_select(move |id: &SharedString| chosen.set(id.clone()))
        .empty(text("No results.").text_color(move || theme().muted_foreground))
        .h(px(360.0))
        .render_item(|entry: &CommandEntry| {
            view()
                .flex_row()
                .items_center()
                .h_8()
                .px_2()
                .child(text(entry.label.clone()).flex_1())
                .child(
                    text(entry.shortcut_label.clone().unwrap_or_default())
                        .text_color(move || theme().muted_foreground),
                )
        })
}

Command は、Rust の nsh-base クレートである nsh/base に由来します。query を設定すると、クエリはアプリが管理し、アプリは onQueryChange で更新します。設定しない場合は、検索フィールドが自身でクエリを保持し、defaultQuery から始まります。アイテムは、ラベルではなく、アプリ独自の id で識別されます。onSelect({ id }) は、ユーザーがどれを選んだかを伝えます。Rust では command() が作成し、prop ごとのセッター(.items(..)、.query(..)、.render_item(..))、イベントごとのリスナーメソッド、型付きのスタイルメソッドを備えます。

#アイテム

items はコマンドを順番に並べたもので、それぞれが CommandItem です。

フィールド型説明
idstringonSelect と onHighlightChange でそのアイテムを識別するもの。アイテム間で一意です。
labelstringrenderItem が行を描画しない場合に行に表示される内容、スクリーンリーダーが読み上げる内容、クエリが照合する対象。
keywordsstring[]クエリが照合する追加の語。同義語や、翻訳済みラベルと並べる英語名など。
groupstringそのアイテムのセクション。同じグループの隣接するアイテムは、この見出しを持つヘッダーの下に表示されます。
shortcutstring同じコマンドのキーストローク。keymap が定める名前表記("mod+shift+p")で指定し、行に表示されます。アプリは keymap.bind でバインドします。
disabledboolean選択できません。キー操作では飛ばされ、押しても何も起こらず、disabled: スタイルが適用されます。
checkedboolean現在有効なもの(テーマ、言語など)。checked: スタイルが適用され、スクリーンリーダーはチェック済みと読み上げます。

クエリは、アイテムのラベルまたはキーワードのいずれかにクエリが含まれていれば、大文字小文字と前後の空白を無視して一致します。アイテムの順序は保たれ、一致するものがないセクションはヘッダーごと消えます。renderItem は、表示範囲の各行に対して CommandEntry を受け取ります。これにはアイテムのフィールドと、shortcutLabel(shortcut をここでのヒントの表示形式にしたもので、Apple のプラットフォームでは ⇧⌘P、それ以外では Ctrl+Shift+P)が含まれます。これはアイテムそのものを表し、ハイライトは行の focus: です。描画はアイテムごとに一度だけ行われ、ハイライトが移動してもビューは保持されます。

#Props

PropRust型デフォルト説明
items.items(..)CommandItem[][]コマンドを順番に並べたもの。
query.query(..)stringなしクエリ(制御)。アプリが onQueryChange で設定します。
defaultQuery.default_query(..)stringなしquery が設定されていない間の、最初のクエリ。
searchable.searchable(..)booleantrue行の上に置く検索フィールド。これがない場合はすべてのアイテムが表示され、コマンドはタイプアヘッド付きのキーボードフォーカスの停止位置の一つになります。
filterable.filterable(..)booleantrueクエリでアイテムを絞り込みます。オフにするとすべてのアイテムが表示されます。アプリ自身が応答する検索向けです(サーバーの結果を items として設定するなど)。新しいクエリでも最初のアイテムはハイライトされます。
loading.loading(..)booleanfalse検索中です。empty は待機し、スクリーンリーダーに対してリストはビジー状態になります。インジケーターは searchSuffix に表示してください。
placeholder.placeholder(..)stringなし検索フィールドのプレースホルダー。
autoFocus.auto_focus(..)booleanfalse表示されると検索フィールドがキーボードフォーカスを受け取ります。入力するために開くパレット向けです。
separator.separator(..)booleantrue表示されている2つのセクションの間のセパレーター行。separatorClass でスタイル指定され、先頭、末尾、連続には現れません。
accessibilityLabel.accessibility_label(..)stringなしスクリーンリーダーがリストを呼ぶ名前(「Commands」)。searchAccessibilityLabel が設定されていない間は、検索フィールドの名前にも使われます。
searchAccessibilityLabel.search_accessibility_label(..)stringaccessibilityLabelスクリーンリーダーが検索フィールドを呼ぶ名前。何を検索するかを表します(「Search commands」)。
header, footer.header(..), .footer(..)JSX.Elementなし検索フィールドの上(タイトルなど)と行の下(キーのヒント、件数など)に表示される内容。
empty.empty(..)JSX.Elementなし表示するアイテムがないときに表示される内容。何にも一致しないクエリや、アイテムがない場合など。
searchPrefix, searchSuffix.search_prefix(..), .search_suffix(..)JSX.Elementなし検索バー内で検索フィールドの前と後に表示される内容。検索アイコンや、loading の間のスピナーなど。
renderItem.render_item(..)(entry: CommandEntry) => JSX.Elementなし表示範囲の行の内容。これがない場合、行にはアイテムのラベルが表示されます。
renderGroup.render_group(..)(group: CommandGroup) => JSX.Elementなしセクションのヘッダー({ heading })。これがない場合、ヘッダーには見出しが表示されます。
class, styleスタイルメソッドstring, StyleProp<ViewStyle>なしコマンド自体のサイズ、フレーム、サーフェス。
searchBarClass, searchBarStyle.search_bar_class(..), .search_bar_style(..)string, StyleProp<ViewStyle>なしsearchPrefix、検索フィールド、searchSuffix を含む行。
searchClass, searchStyle.search_class(..), .search_style(..)string, StyleProp<TextStyle>なし検索フィールド。
listClass, listStyle.list_class(..), .list_style(..)string, StyleProp<ViewStyle>なし行のスクロールビュー。高さを指定してください(max-h-80、またはサイズを指定したコマンド)。行はその内側でスクロールし、表示範囲のものだけが作成されます。
itemClass, itemStyle.item_class(..), .item_style(..)string, StyleProp<TextStyle>なし各アイテムの行とその状態(下記)。テキストスタイルはラベルに反映されます。
groupClass, groupStyle.group_class(..), .group_style(..)string, StyleProp<TextStyle>なし各セクションのヘッダー。
separatorClass, separatorStyle.separator_class(..), .separator_style(..)string, StyleProp<ViewStyle>なし各セパレーター。罫線の高さと色。

#イベント

イベントRustペイロードタイミング
onSelect.on_select(..){ id: string }ユーザーがアイテムを選択した。Return、または行の押下。
onHighlightChange.on_highlight_change(..){ highlighted: string | null }ハイライトが移動した(キー、ポインター、新しいクエリや新しいアイテム、highlight)。Return で何が実行されるかをプレビューするためのものです。
onQueryChange.on_query_change(..){ query: string }ユーザーが検索フィールドに入力した、または Escape でクリアした。
onCancel.on_cancel(..)なしクエリが空の状態での Escape。コマンドを保持しているもの(ダイアログの open など)を閉じます。

#パーツ

パーツ内側スタイル指定状態
コマンドclass, style
headerコマンドアプリの要素
検索バーコマンドsearchBarClass, searchBarStyle
searchPrefix、検索フィールド、searchSuffix検索バーアプリの要素。searchClass, searchStyleフィールドの focus:
リストコマンドlistClass, listStyle
セクションのヘッダーリストgroupClass, groupStyle, renderGroup
セパレーターリストseparatorClass, separatorStyle
行リストitemClass, itemStylefocus:(ハイライト)、checked:, disabled:, hover:, active:
行の内容行renderItemitemClass 内の group 配下の group-focus:, group-checked:, group-disabled:
emptyコマンドアプリの要素
footerコマンドアプリの要素

ハイライトされた行は focus: で表示します(デザインガイドを参照)。

#Ref

メソッド説明
focus()検索フィールドにキーボードフォーカスを与えます(検索フィールドがない場合はコマンドに与えます)。
highlight(id)id のアイテムをハイライトし、その行を表示範囲にスクロールします。表示されていないアイテムや無効なアイテムは、そのままです。
matchedCount()Promise<number>:クエリが表示するアイテムの数。無効なアイテムも含みます。
let palette: CommandRef | undefined;

<Command ref={(r) => (palette = r)} items={items} />;
palette?.focus();

#ダイアログ内のパレット

コマンドを Dialog に入れ、アプリのショートカットで開きます。Escape はまずクエリをクリアし、クエリが空のときは onCancel となり、アプリがダイアログを閉じます。

import { keymap } from "nsh";

const open = signal(false);
keymap.bind("mod+k", () => open.set(!open()));

<Dialog open={open()} onOpenChange={({ open: next }) => open.set(next)}>
  <Command
    items={commands}
    autoFocus
    onCancel={() => open.set(false)}
    onSelect={({ id }) => {
      open.set(false);
      run(id);
    }}
  />
</Dialog>;

#アプリが応答する検索

filterable={false} を指定すると、アプリが渡したアイテムがすべて表示されます。アプリは onQueryChange(サーバー、データベース)で検索し、結果を items に設定し、待機中は loading にします。

<Command
  items={results()}
  filterable={false}
  loading={searching()}
  onQueryChange={({ query }) => search(query)}
  searchSuffix={searching() ? <Spinner /> : undefined}
  empty={<Text>No matches</Text>}
/>

#アクセシビリティ

  • リストのロールは "listbox" で、accessibilityLabel によって名前が付けられます。各行は、アイテムのラベルを名前とする "option" で、チェック状態と無効状態はアイテムに従います。セクションのヘッダーは "header" で、セパレーターは非表示です。
  • 検索フィールドは、searchAccessibilityLabel(なければ accessibilityLabel)を名前とするテキストフィールドです。プレースホルダーは、フィールドが空の間に表示されるヒントです。
  • 矢印キーでハイライトが移動している間も、検索フィールドはキーボードフォーカスを保ち、スクリーンリーダーはハイライトされたラベルを読み上げます。検索フィールドがない場合は、ハイライトされた行がスクリーンリーダーのフォーカスを受け取ります。
  • loading の間、リストはビジー状態になります。

ラベル、ロール、アナウンス全般については、アクセシビリティを参照してください。

#キーボード

キー動作
文字入力アイテムを絞り込み、最初の有効な一致項目をハイライトします。
Down, Up次または前のアイテムをハイライトします。無効なアイテムは飛ばし、最後から最初へ、またその逆へと循環します。
Page Down, Page Up表示範囲の行数分だけハイライトを移動します。
Returnハイライトされたアイテムを選択します(onSelect)。
Escapeクエリをクリアします。クエリが空の場合は onCancel を通知します。
Home, End検索フィールドがない場合は、最初または最後のアイテムに移動します(フィールド内ではキャレットが移動します)。
Space、文字、数字検索フィールドがない場合:Space で選択し、文字と数字はタイプアヘッドでハイライトします。

#プラットフォームに関する注記

  • デスクトップ(macOS、Windows、Linux、GPUI)と Web:ポインターが移動した行がハイライトされ、クリックはボタンを押した時点で選択されるため、検索フィールドはキーボードフォーカスを保ちます。
  • iOS、Android、Mac Catalyst:タップで行を選択し、キーボードのリターンキーでハイライトされたアイテムを選択して、次のクエリのためにフィールドを保持します。
  • すべてのプラットフォームで、アプリがスタイルを指定したものが描画されます。コマンド、その検索バー、行、行の内容です。