میان‌برهای صفحه‌کلید
useKeymap، توالی‌ها، لایهٔ راهنمای ?، راهنمای کلیدها و پالت فرمان.
میان‌برها را یک بار با هوک useKeymap تعریف کنید. Text.js آن‌ها را مسیریابی می‌کند، در یک لایهٔ رویی ? فهرست می‌کند، در پابرگ شما نمایش می‌دهد و امکان جست‌وجوی آن‌ها را در پالت فرمان فراهم می‌کند.
useKeymap( { "j, down": { label: "Next", run: next, hint: true }, "k, up": { label: "Previous", run: previous }, "g g": { label: "Go to top", run: top }, "ctrl+s": { label: "Save", run: save, hint: true }, }, { group: "Navigation" },);return ( <> <StatusBar right={<Text color="subtle">main</Text>}> <KeyHints /> </StatusBar> <CommandPalette commands={commands} /> <KeyHelp /> </>);useKeymap
| نحو | معنی |
|---|---|
ctrl+k | کلیدهای تغییردهنده: ctrl alt shift meta mod |
mod+k | ⌘ یا Ctrl، هرکدام که نگه داشته شود |
j, down | گزینه‌های جایگزین |
g g | یک توالی (1 ثانیه فاصله بین کلیدها) |
G | حرف بزرگ به معنی استفاده از Shift است |
? | کلیدهای چاپ‌پذیر با نویسه تطبیق داده می‌شوند |
مقدارها یک تابع رسیدگی یا یک اتصال کلید با فیلدهای label، group، hint، disabled و noRepeat هستند. اتصال‌های بدون برچسب کار می‌کنند اما در لایهٔ راهنما نمایش داده نمی‌شوند.
هوک useKeymapBindings() اتصال‌های برچسب‌داری را که در حال حاضر فعال هستند، برای استفاده در پابرگ‌ها و منوهای خودتان برمی‌گرداند.
نقشه‌های کلیدها از طریق هوک useInput اجرا می‌شوند، پس قواعد معمول برقرار است: ورودی‌های دارای تمرکز اولویت دارند، کلید منطبق انتشار رویداد را متوقف می‌کند و یک <Modal> باز، اتصال‌های بیرون از خود را غیرفعال می‌کند. برای تغییر این رفتار، مقدار { priority, global, isActive } را ارسال کنید.
<KeyHelp>
برای دیدن همهٔ اتصال‌های برچسب‌دار به‌صورت گروه‌بندی‌شده، کلید ? را فشار دهید. این راهنما موارد فعال در محل باز شدن خود را فهرست می‌کند.
<KeyHelp keys="?" title="Keyboard shortcuts" /><KeyHints> و <StatusBar>
کامپوننت <KeyHints /> اتصال‌های دارای hint: true یا موارد صریح items را نمایش می‌دهد. کامپوننت <StatusBar> یک پابرگ تک‌ردیفی با جایگاه right است.
<StatusBar right={<Text color="subtle">▼ iad1</Text>}> <KeyHints items={[{ keys: "ctrl+k", label: "commands" }]} /></StatusBar>کامپوننت <Kbd>mod+k</Kbd> یک کلید را رندر می‌کند. تابع formatKeys("ctrl+shift+p") در macOS مقدار ⌃⇧P و در محیط‌های دیگر مقدار ctrl+shift+P را می‌دهد.
<CommandPalette>
میان‌بر Ctrl+K (یا Ctrl+P) یک اجراگر با جست‌وجوی فازی برای فرمان‌های شما و همهٔ اتصال‌های برچسب‌دار باز می‌کند و حروف منطبق را برجسته نشان می‌دهد.
<CommandPalette commands={[{ id: "theme", label: "Toggle theme", group: "View", run: toggleTheme }]}/>| Prop | توضیح |
|---|---|
commands | { id, label, group?, keys?, keywords?, run }[] |
keys | میان‌بر باز کردن (پیش‌فرض ctrl+k, ctrl+p؛ مقدار null برای غیرفعال کردن) |
includeKeymap | فهرست کردن اتصال‌های نقشهٔ کلیدها (پیش‌فرض true) |
open / onOpenChange | کنترل‌شده |
پالت پیش از اجرای فرمان بسته می‌شود، بنابراین فرمان‌ها می‌توانند پنجره‌های مودال خود را باز کنند. توابع fuzzyMatch و fuzzyFilter برای استفاده در فهرست‌های خودتان صادر می‌شوند.