hotkey-engine 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 HotkeyEngine contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,344 @@
-# Temporary Holding Version
+# hotkey-engine
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+hotkey-engine یک موتور میانبر کیبورد برای React 18+ و Next.js 13+ است. API بدون رابط کاربری، دکمهٔ شناور و پنجرهٔ آماده برای مدیریت میانبرها را در یک پکیج ارائه می‌کند. کاربر می‌تواند میانبرها را ویرایش، غیرفعال یا به پیش‌فرض بازنشانی کند و انتخاب او در مرورگر ذخیره می‌شود.
+
+## امکانات
+
+- میانبرهای فیزیکی و مستقل از زبان کیبورد؛ تغییر زبان کیبورد، Ctrl + K را تغییر نمی‌دهد.
+- نگاشت mod به ⌘ Command در macOS و Ctrl در Windows/Linux.
+- Scopeهای اولویت‌دار، جلوگیری از تداخل و تشخیص میانبرهای رزرو مرورگر/سیستم‌عامل.
+- جلوگیری از اجرا داخل input، textarea و contenteditable، مگر با اجازهٔ صریح هر Action.
+- ذخیره‌سازی نسخه‌دار در localStorage و سازگاری با SSR.
+- پنجرهٔ قابل دسترس: focus trap، بازگردانی focus، Escape و roleهای مناسب.
+- رابط آماده با تم light، dark و system، به‌همراه انگلیسی/LTR و فارسی/RTL.
+- CSS مستقل و قابل شخصی‌سازی، بدون وابستگی UI خارجی.
+
+## نصب
+
+~~~bash
+npm install hotkey-engine
+~~~
+
+CSS را یک‌بار، پس از CSS پایهٔ پروژه، import کنید:
+
+~~~tsx
+import "hotkey-engine/styles.css";
+~~~
+
+## شروع سریع در React
+
+~~~tsx
+import {
+  HotkeyProvider,
+  HotkeySettingsTrigger,
+  type HotkeyAction,
+} from "hotkey-engine";
+import "hotkey-engine/styles.css";
+
+const actions: HotkeyAction[] = [
+  {
+    id: "site-search",
+    label: "Open site search",
+    defaultShortcut: "mod+k",
+    editable: true,
+    onTrigger: () => document.getElementById("site-search")?.focus(),
+  },
+  {
+    id: "save-draft",
+    label: "Save draft",
+    defaultShortcut: "mod+s",
+    editable: true,
+    preventDefault: true,
+    onTrigger: () => saveDraft(),
+  },
+];
+
+export function App() {
+  return (
+    <HotkeyProvider actions={actions}>
+      <input id="site-search" placeholder="Search" />
+      <HotkeySettingsTrigger>Keyboard shortcuts</HotkeySettingsTrigger>
+    </HotkeyProvider>
+  );
+}
+~~~
+
+دکمهٔ شناور تنظیمات به‌صورت پیش‌فرض پایینِ چپ صفحه است. HotkeySettingsTrigger اختیاری است و برای متصل‌کردن دکمه یا منوی اختصاصی شما به پنجرهٔ تنظیمات استفاده می‌شود.
+
+## استفاده در Next.js 13+ (App Router)
+
+Provider را در یک Client Component بگذارید. پکیج هنگام SSR به window یا localStorage دسترسی ندارد.
+
+~~~tsx
+// app/shortcut-provider.tsx
+"use client";
+
+import { HotkeyProvider, type HotkeyAction } from "hotkey-engine";
+
+const actions: HotkeyAction[] = [
+  {
+    id: "search",
+    label: "Open search",
+    defaultShortcut: "mod+k",
+    editable: true,
+    onTrigger: () => console.log("open search"),
+  },
+];
+
+export function ShortcutProvider({ children }: { children: React.ReactNode }) {
+  return <HotkeyProvider actions={actions}>{children}</HotkeyProvider>;
+}
+~~~
+
+~~~tsx
+// app/layout.tsx
+import "hotkey-engine/styles.css";
+import { ShortcutProvider } from "./shortcut-provider";
+
+export default function RootLayout({ children }: { children: React.ReactNode }) {
+  return (
+    <html lang="en">
+      <body><ShortcutProvider>{children}</ShortcutProvider></body>
+    </html>
+  );
+}
+~~~
+
+## تعریف Action
+
+~~~ts
+type HotkeyAction = {
+  id: string;
+  label: string;
+  defaultShortcut: string;
+  onTrigger: (event: KeyboardEvent) => void;
+  editable?: boolean;
+  scope?: string;
+  allowInEditable?: boolean;
+  preventDefault?: boolean;
+};
+~~~
+
+| فیلد | توضیح |
+| --- | --- |
+| id | شناسهٔ یکتا و پایدار. |
+| label | نام Action در پنجرهٔ تنظیمات. |
+| defaultShortcut | مانند mod+k، ctrl+shift+n یا alt+arrowleft. |
+| onTrigger | تابع اجراشونده پس از تطابق میانبر. |
+| editable | اگر false باشد، کاربر نمی‌تواند آن را ویرایش یا غیرفعال کند. |
+| scope | نام Scope؛ اگر مشخص نشود global است. |
+| allowInEditable | اجازهٔ اجرا هنگام تمرکز روی input، textarea یا contenteditable. پیش‌فرض: false. |
+| preventDefault | پیش از اجرا event.preventDefault() را فراخوانی می‌کند. |
+
+کلیدهای پشتیبانی‌شده: حروف، اعداد، F1 تا F12، enter، escape، space، tab، backspace، delete، arrowup، arrowdown، arrowleft، arrowright و slash. Modifierها: ctrl، alt، shift، meta و mod.
+
+## باز و بسته کردن پنجره
+
+~~~tsx
+import { useHotkeySettings } from "hotkey-engine";
+
+function ShortcutMenuItem() {
+  const { openSettings, closeSettings, open } = useHotkeySettings();
+
+  return (
+    <>
+      <button onClick={openSettings}>Manage shortcuts</button>
+      {open && <button onClick={closeSettings}>Close settings</button>}
+    </>
+  );
+}
+~~~
+
+useHotkeySettings() باید زیر HotkeyProvider استفاده شود.
+
+## Scope و اولویت
+
+میانبرهای Scope فعال از global اولویت بیشتری دارند. اگر چند Scope فعال باشند، آخرین Scope فعال‌شده اول بررسی می‌شود.
+
+~~~tsx
+import { useHotkeyScope } from "hotkey-engine";
+
+function Editor() {
+  useHotkeyScope("editor");
+  return <textarea />;
+}
+
+const actions = [
+  { id: "global-save", label: "Save", defaultShortcut: "mod+s", onTrigger: saveSite },
+  { id: "editor-save", label: "Save editor", defaultShortcut: "mod+s", scope: "editor", onTrigger: saveEditor },
+];
+~~~
+
+دو Action با یک میانبر در Scopeهای هم‌پوشان قابل ذخیره نیستند و پنجره، تداخل را به کاربر اعلام می‌کند.
+
+## میانبرهای رزرو مرورگر و سیستم‌عامل
+
+به‌صورت پیش‌فرض، کاربر نمی‌تواند Ctrl/Cmd + K، L، R، W، T، N، P یا Alt + F4 را در Recorder ثبت کند؛ این‌ها معمولاً به مرورگر یا سیستم‌عامل تعلق دارند. پیام خطا کنار همان Action نشان داده می‌شود و میانبر قبلی حفظ می‌شود.
+
+اگر توسعه‌دهنده آگاهانه بخواهد این امکان را بدهد:
+
+~~~tsx
+<HotkeyProvider actions={actions} allowReservedShortcuts>
+  <App />
+</HotkeyProvider>
+~~~
+
+در این حالت، پکیج برای میانبر رزروشده preventDefault() اجرا می‌کند تا سایت بیشترین اولویت ممکن را داشته باشد. با این حال، مرورگر یا سیستم‌عامل ممکن است همچنان فرمان را کنترل کند؛ override آن در وب تضمین‌پذیر نیست.
+
+## تم
+
+~~~tsx
+<HotkeyProvider actions={actions} theme="dark">
+  <App />
+</HotkeyProvider>
+~~~
+
+| مقدار | رفتار |
+| --- | --- |
+| light | رابط روشن. |
+| dark | رابط تیره. |
+| system | پیش‌فرض؛ براساس prefers-color-scheme. |
+
+تم فقط UI پکیج را تغییر می‌دهد و تم سایت شما را دست‌کاری نمی‌کند.
+
+## زبان و RTL
+
+انگلیسی/LTR پیش‌فرض است. برای فارسی، locale="fa" بگذارید؛ پنجره RTL می‌شود و فونت Vazir داخلی برای متن فارسی استفاده می‌شود.
+
+~~~tsx
+<HotkeyProvider actions={actions} locale="fa">
+  <App />
+</HotkeyProvider>
+~~~
+
+برای تغییر زبان در زمان اجرا:
+
+~~~tsx
+import { useHotkeyLocale } from "hotkey-engine";
+
+function LanguageSwitch() {
+  const { locale, setLocale } = useHotkeyLocale();
+  return (
+    <button onClick={() => setLocale(locale === "en" ? "fa" : "en")}>
+      {locale === "en" ? "فارسی" : "English"}
+    </button>
+  );
+}
+~~~
+
+برای تعیین جهت مستقل از زبان، از dir="rtl" یا dir="ltr" استفاده کنید.
+
+## دکمهٔ شناور
+
+~~~tsx
+<HotkeyProvider
+  actions={actions}
+  showFloatingButton
+  position="bottom-right"
+  offset={{ x: 32, y: 24 }}
+  zIndex={2000}
+>
+  <App />
+</HotkeyProvider>
+~~~
+
+- showFloatingButton: پیش‌فرض true.
+- position: bottom-left (پیش‌فرض)، bottom-right، top-left یا top-right.
+- offset: عدد یا { x, y } برحسب پیکسل.
+- zIndex: پیش‌فرض 1000.
+
+## شخصی‌سازی UI
+
+رابط پکیج قابل تغییر است. ابتدا CSS پکیج و سپس stylesheet پروژهٔ خود را import کنید تا overrideها اعمال شوند.
+
+~~~tsx
+<HotkeyProvider actions={actions} className="my-product">
+  <HotkeySettingsTrigger className="my-shortcut-button">
+    Shortcuts
+  </HotkeySettingsTrigger>
+  <App />
+</HotkeyProvider>
+~~~
+
+className روی Provider، wrapper محتوای شما و className روی HotkeySettingsTrigger، Trigger اختصاصی شماست. پنجرهٔ تنظیمات با portal در document.body رندر می‌شود؛ پس برای استایل آن از selectorهای پکیج استفاده کنید، نه selector وابسته به .my-product.
+
+### مثال: رنگ و گردی اختصاصی
+
+~~~css
+/* app.css — بعد از hotkey-engine/styles.css import شود */
+.hotkey-dialog[data-hotkey-theme="light"] {
+  --hk-header: linear-gradient(110deg, #075985, #0f766e);
+  --hk-text: #17324d;
+  --hk-muted: #52718f;
+  --hk-line: rgba(15, 118, 110, .18);
+  --hk-control: rgba(255, 255, 255, .72);
+  --hk-control-hover: rgba(236, 253, 245, .9);
+  border-radius: 24px;
+}
+
+.hotkey-floating-trigger {
+  background: #0f766e;
+  color: #fff;
+  border-color: transparent;
+  border-radius: 14px;
+}
+
+.hotkey-action-edit,
+.hotkey-action-disable,
+.hotkey-action-reset {
+  border-radius: 8px;
+}
+~~~
+
+| selector | بخش |
+| --- | --- |
+| .hotkey-floating-trigger | دکمهٔ شناور |
+| .hotkey-overlay | لایهٔ پشت پنجره |
+| .hotkey-dialog | پنجرهٔ تنظیمات |
+| .hotkey-glass-header | هدر |
+| .hotkey-search-wrap، .hotkey-search | جست‌وجو |
+| .hotkey-action-item | ردیف هر Action |
+| .hotkey-action-edit، .hotkey-action-disable، .hotkey-action-reset | دکمه‌های Action |
+| .hotkey-inline-feedback | خطای تداخل/رزرو |
+| .hotkey-recorder | وضعیت ثبت میانبر |
+
+متغیرهای اصلی CSS: --hk-header، --hk-panel، --hk-control، --hk-control-hover، --hk-text، --hk-muted و --hk-line. برای تم تیره، selector را به .hotkey-dialog[data-hotkey-theme="dark"] تغییر دهید.
+
+## ذخیره‌سازی و بازنشانی
+
+تنظیمات کاربر پس از mount در localStorage با کلید نسخه‌دار hotkey-engine:v1 ذخیره می‌شوند. ویرایش‌ها بلافاصله اجرا و ذخیره می‌شوند. آیکن بازنشانی هدر، همهٔ میانبرها را فوراً به حالت پیش‌فرض برمی‌گرداند.
+
+Storage Adapter عمومی، همگام‌سازی چنددستگاهی و میانبرهای چندمرحله‌ای در این نسخه وجود ندارند.
+
+## API Provider
+
+| prop | پیش‌فرض | توضیح |
+| --- | --- | --- |
+| actions | — | آرایهٔ Actionها؛ الزامی. |
+| showFloatingButton | true | نمایش دکمهٔ شناور. |
+| position | bottom-left | محل دکمهٔ شناور. |
+| offset | { x: 24, y: 24 } | فاصله از لبه‌ها. |
+| zIndex | 1000 | z-index دکمه. |
+| theme | system | light، dark یا system. |
+| locale | en | en یا fa. |
+| dir | طبق locale | ltr یا rtl. |
+| className | — | کلاس wrapper فرزندان Provider. |
+| allowReservedShortcuts | false | اجازهٔ ثبت میانبرهای رزرو. |
+
+## بررسی و توسعه
+
+~~~bash
+npm test
+npm run build
+npm run storybook
+~~~
+
+برای ساخت Storybook ایستا:
+
+~~~bash
+npm run build-storybook
+~~~
+
+## License
+
+[MIT](./LICENSE)