@hyperbind-lib/vue

Vue 3アプリケーションでキーボードショートカットを簡単に実装するためのComposablesとコンポーネントライブラリ。

インストール

``bash
npm install @hyperbind-lib/vue
`

前提条件:
- Vue 3.0.0以上
- @hyperbind-lib/core（自動的にインストールされます）

クイックスタート

`vue



`

機能一覧

$3

#### useKeybind(keyCombo: string, callback: () => void)

シンプルなキーバインドを登録するComposable。コンポーネントのマウント時に登録し、アンマウント時に自動的に解除します。

`vue

`

引数:
- keyCombo: キーの組み合わせ（例: "ctrl+s", "cmd+k", "f1"）
- callback: キー押下時に実行される関数

#### usePresetKeybind(presetId: string, callback: () => void)

プリセットキーバインドを使用するComposable。プリセットIDを指定するだけで、キーの組み合わせとpreventDefault設定が自動的に適用されます。

`vue

`

引数:
- presetId: プリセットキーバインドのID（例: "common-help", "search-show"）
- callback: キー押下時に実行される関数

利用可能なプリセット:
- common-help: F1 - ヘルプ表示
- common-palette: F2 - パレットを表示
- search-show: F3 - 検索
- common-reference: F4 - 項目の参照
- その他多数（@hyperbind-lib/coreのALL_PRESET_KEYBINDSを参照）

#### useInputKeybind(options: UseInputKeybindOptions)

入力フィールド専用のキーバインドComposable。特定の入力要素にフォーカスがある場合のみ実行されます。

`vue



`

オプション:
- elementRef: 対象となる入力要素への参照
- keyCombo: キーの組み合わせ（デフォルト: "Enter"）
- onTrigger: キー押下時に実行される関数
- enabled: キーバインドを有効にするか（デフォルト: true）
- preventDefault: デフォルトのブラウザ動作を防ぐか（デフォルト: true）

#### useCustomKeybinds(options?: UseCustomKeybindsOptions)

カスタムキーバインドを管理するComposable。ユーザーが定義したキーバインドの追加、削除、更新、有効/無効の切り替えを提供します。localStorageへの自動保存も行います。

`vue



`

戻り値:
- keybinds: キーバインドの配列（ref）
- addKeybind: キーバインドを追加する関数
- removeKeybind: キーバインドを削除する関数
- updateKeybind: キーバインドを更新する関数
- toggleKeybind: キーバインドの有効/無効を切り替える関数
- togglePreventDefault: preventDefaultの有効/無効を切り替える関数

オプション:
- storageKey: localStorageのキー名（デフォルト: "hyperbind_custom_keybinds"）
- onTrigger: キーバインドが実行されたときに呼ばれる関数

#### useModalKeybind(options: UseModalKeybindOptions)

モーダルやダイアログの開閉をキーバインドで制御するComposable。同じキーで開閉を切り替えるトグル動作を提供します。

`vue



`

オプション:
- keyCombo: キーの組み合わせ（例: "f1", "escape"）
- onOpen: モーダルを開くときに実行される関数
- onClose: モーダルを閉じるときに実行される関数（省略可能）
- isOpen: モーダルが現在開いているかどうか（デフォルト: false）
- preventDefault: デフォルトのブラウザ動作を防ぐか（デフォルト: true）

#### useGlobalKeybindToggle()

すべてのキーバインドをグローバルにON/OFFするComposable。

`vue



`

戻り値:
- isEnabled: キーバインドが有効かどうか（ref）
- enable: キーバインドを有効化する関数
- disable: キーバインドを無効化する関数
- toggle: キーバインドの有効/無効を切り替える関数

#### useDisableKeyBindsWhileMounted()

コンポーネントがマウントされている間、すべてのキーバインドを無効化するComposable。モーダルやフォームで、キーバインドの干渉を防ぎたい場合に使用します。

`vue



`

#### useDisableCustomKeybindsWhileMounted()

コンポーネントがマウントされている間、カスタムキーバインドのみを無効化するComposable。タブ移動などの標準的なキーバインドは有効のままです。モーダルやダイアログで、カスタムキーバインドの干渉を防ぎたい場合に使用します。

`vue



`

$3

####

フォーム内の入力フィールド間を自動的にナビゲートするコンポーネント。Tab/Shift+TabとEnterキーで、指定された入力フィールド間を循環的に移動できます。IME入力中の動作も適切に処理します。

`vue



`

プロパティ:
- inputRefs: フォーム内の入力要素への参照の配列

動作:
- Tabキー: 次のフィールドへ移動
- Shift+Tabキー: 前のフィールドへ移動
- Enterキー: 次のフィールドへ移動（テキストエリアの場合は無効）

####

キーボード入力を記録するコンポーネント。ユーザーがキーを押すと、その組み合わせ（"ctrl+s"など）を記録します。予約キー（ブラウザやOSで使用されるキー）の使用時には警告を表示します。

`vue



`

プロパティ:
- modelValue: 現在のキーの組み合わせ（v-model）
- showWarning: 警告メッセージを表示するかどうか（デフォルト: false）
- @warning: 警告状態が変化したときに呼ばれるイベント

####

カスタムキーバインドの一覧を表示・編集するコンポーネント。各キーバインドに対して以下の操作が可能です：
- 有効/無効の切り替え
- ラベルとキーの組み合わせの編集
- preventDefaultの切り替え
- 削除

予約キーを使用している場合は、視覚的に警告を表示します。

`vue



`

プロパティ:
- keybinds: 表示するキーバインドの配列
- onToggle: キーバインドの有効/無効を切り替えるときに呼ばれる関数
- onTogglePreventDefault: preventDefaultの有効/無効を切り替えるときに呼ばれる関数
- onRemove: キーバインドを削除するときに呼ばれる関数
- onUpdate: キーバインドを更新するときに呼ばれる関数

####

キーバインド機能付きの入力フィールドコンポーネント。標準のHTML input要素に、カスタムキーバインド機能を追加したコンポーネントです。通常のinputプロパティ（placeholder、value、@inputなど）もすべて使用可能です。

`vue



`

プロパティ:
- すべての標準的な要素のプロパティ
- triggerKey: キーの組み合わせ（デフォルト: "Enter"）
- @keyPress: キーが押されたときに実行されるイベント
- keybindEnabled: キーバインドを有効にするか（デフォルト: true）
- preventDefault: デフォルトのブラウザ動作を防ぐか（デフォルト: true）

$3

#### isReservedKey(keyCombo: string): boolean

指定されたキーの組み合わせが予約キーかどうかを判定します。

`typescript
import { isReservedKey } from "@hyperbind-lib/vue";

if (isReservedKey("ctrl+s")) {
console.log("このキーは予約されています");
}
`

#### getReservedKeyWarning(keyCombo: string): string | null

指定されたキーの組み合わせが予約キーの場合、警告メッセージを返します。

`typescript
import { getReservedKeyWarning } from "@hyperbind-lib/vue";

const warning = getReservedKeyWarning("ctrl+s");
if (warning) {
console.warn(warning); // "Ctrl+S はブラウザの保存機能で使用されています"
}
`

使用例

$3

`vue

`

$3

`vue

`

$3

`vue



`

$3

`vue



`

`vue




`

$3

`vue



`

$3

`vue



`

クロスプラットフォーム対応

Mac と Windows/Linux のキーボードの違いを自動的に吸収します：

- Mac の Cmd キー（⌘）と Windows/Linux の Ctrl キーを統一的に扱えます
- "ctrl+s" または "cmd+s" のどちらで登録しても、両方のプラットフォームで動作します

`vue

`

予約キー

ブラウザやOSで使用されるキーは予約キーとして扱われ、使用時に警告が表示されます：

- Ctrl+S: ブラウザの保存機能
- Ctrl+R, F5: ページのリロード
- Ctrl+F: ブラウザの検索機能
- Ctrl+P: 印刷
- その他多数

予約キーを使用する場合は、preventDefault: true`を設定してブラウザのデフォルト動作を防ぐことを推奨します。

ライセンス

MIT