Fix: Update documentation

documentation/docs/api/use-hotkeys.mdx

@@ -178,37 +178,14 @@ type Options = {
 
 #### Properties
 
-##### `filter`
-
-```ts
-filter: (event: KeyboardEvent) => boolean // default: undefined
-```
-
-Pass a function `filter` to determine if the callback should get triggered. Return `false` to __prevent__ the execution
-of the callback and `true` to __allow__ the callback to be triggered.
-
-##### `filterPreventDefault`
+##### `enabled`
 
 ```ts
-filterPreventDefault: boolean // default: true
+enabled: boolean | ((keyboardEvent: KeyboardEvent, hotkeysEvent: HotkeysEvent) => boolean) // default: true
 ```
 
-This flag determines if the default browser behavior should be prevented if the given `filter` function returns `false` and
-therefore prevents the execution of the callback. `true` is the default value, so each time the filter blocks the callback
-execution, the browser won't proceed with its default behavior. Setting this to `false` will allow the browser to proceed
-with the default behavior.
-
-A good example for this behavior is the override of `meta+s`, which normally triggers a save page dialog
-inside the browser.
-
-```js
-useHotkeys('meta+s', someCallback, {
-  // This will allow the browser to show the save page dialog.
-  // Setting it to true will prevent that.
-  filterPreventDefault: false,
-  filter: () => false
-});
-```
+Determines if the callback should get triggered. Return `false` to __prevent__ the execution
+of the callback and `true` to __allow__ the callback to be triggered. You can also pass a function that returns a boolean.
 
 ##### `enableOnFormTags`
 
@@ -292,6 +269,25 @@ useHotkeys('a', () => someCallback, {
 
 :::
 
+##### `preventDefault`
+
+```ts
+preventDefault: boolean | ((keyboardEvent: KeyboardEvent, hotkeysEvent: HotkeysEvent) => boolean) // default: false
+```
+
+This flag determines if the default browser behavior should be prevented. `false` is the default value, so the browser
+will proceed with its default behavior. Setting this to `true` will prevent __some__ of the default browser behavior.
+
+A good example for this behavior is the override of `meta+s`, which normally triggers a save page dialog
+inside the browser.
+
+```js
+useHotkeys('meta+s', someCallback, {
+  // This will prevent the browser from showing the save page dialog
+  preventDefault: true,
+});
+```
+
 ##### `document`
 
 if our React app uses iframes, we can pass the `document` object of the iframe to the hook. This way the hook will bind

documentation/docs/documentation/useHotkeys/basic-usage.mdx

@@ -159,6 +159,7 @@ Of course, we also want to leverage more complex keystrokes. `useHotkeys` suppor
 * `alt`
 * `ctrl`
 * `meta`
+* `mod` (which listens for `ctrl` on Windows/Linux and `cmd` on macOS)
 
 :::info macOS and Windows/Linux compatability
 Since version 4 `alt` and `option` are identical. The `meta` key is the same as `cmd` on macOS and `os` key on Windows.

src/useHotkeys.ts

@@ -36,7 +36,7 @@ export default function useHotkeys<T extends HTMLElement>(
     : !(dependencies instanceof Array)
     ? (dependencies as Options)
     : undefined
-  const _keys: string = isReadonlyArray(keys ) ? keys.join(_options?.splitKey) : keys
+  const _keys: string = isReadonlyArray(keys) ? keys.join(_options?.splitKey) : keys
   const _deps: DependencyList | undefined =
     options instanceof Array ? options : dependencies instanceof Array ? dependencies : undefined
 

src/validators.ts

@@ -20,7 +20,10 @@ export function isKeyboardEventTriggeredByInput(ev: KeyboardEvent): boolean {
   return isHotkeyEnabledOnTag(ev, ['input', 'textarea', 'select'])
 }
 
-export function isHotkeyEnabledOnTag({ target }: KeyboardEvent, enabledOnTags: readonly FormTags[] | boolean = false): boolean {
+export function isHotkeyEnabledOnTag(
+  { target }: KeyboardEvent,
+  enabledOnTags: readonly FormTags[] | boolean = false
+): boolean {
   const targetTagName = target && (target as HTMLElement).tagName
 
   if (isReadonlyArray(enabledOnTags)) {