File size: 4,511 Bytes
bc20498 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
/**
* Listen for keyboard event and trigger `shortcut` {@link https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent | CustomEvent }
* @example Typical usage
*
* ```svelte
* <script lang="ts">
* import { shortcut, type ShortcutEventDetail } from '@svelte-put/shortcut';
*
* let commandPalette = false;
*
* function onOpenCommandPalette() {
* commandPalette = true;
* }
* function onCloseCommandPalette() {
* commandPalette = false;
* }
*
* function doSomethingElse(details: ShortcutEventDetail) {
* console.log('Action was placed on:', details.node);
* console.log('Trigger:', details.trigger);
* }
*
* function onShortcut(event: CustomEvent<ShortcutEventDetail>) {
* if (event.detail.trigger.id === 'do-something-else') {
* console.log('Same as doSomethingElse()');
* // be careful here doSomethingElse would have been called too
* }
* }
* </script>
*
* <svelte:window
* use:shortcut={{
* trigger: [
* {
* key: 'k',
*
* // trigger if either ctrl or meta is pressed
* modifier: ['ctrl', 'meta'],
*
* callback: onOpenCommandPalette,
* preventDefault: true,
* },
* {
* key: 'Escape',
*
* // preferably avoid arrow functions here for better performance
* // with arrow functions the action has to be updated more frequently
* callback: onCloseCommandPalette,
*
* enabled: commandPalette,
* preventDefault: true,
* },
* {
* key: 'k',
*
* // trigger if both ctrl & shift are pressed
* modifier: [['ctrl', 'shift']],
* id: 'do-something-else',
* callback: doSomethingElse,
* },
* ],
* }}
* on:shortcut={onShortcut}
* />
* ```
*
*
*
* As with any svelte action, `shortcut` should be use with element and not component.
*
* ```html
* <-- correct usage-->
* <div use:intersect />
*
* <-- incorrect usage-->
* <Component use:intersect/>
* ```
*
* You can either:
*
* - pass multiple callbacks to their associated triggers, or
*
* - pass one single handler to the `on:shortcut` event, in which case you should
* provide an ID to each trigger to be able to distinguish what trigger was activated
* in the event handler.
*
* Either way, only use `callback` or `on:shortcut` and not both to
* avoid handler duplication.
* @param {HTMLElement} node - HTMLElement to add event listener to
* @param {import('./public').ShortcutParameter} param - svelte action parameters
* @returns {import('./public').ShortcutActionReturn}
*/
export function shortcut(node, param) {
let { enabled = true, trigger, type = 'keydown' } = param;
/**
* @param {KeyboardEvent} event
*/
function handler(event) {
const normalizedTriggers = Array.isArray(trigger) ? trigger : [trigger];
/** @type {Record<import('./public').ShortcutModifier, boolean>} */
const modifiedMap = {
alt: event.altKey,
ctrl: event.ctrlKey,
shift: event.shiftKey,
meta: event.metaKey,
};
for (const trigger of normalizedTriggers) {
const mergedTrigger = {
modifier: [],
preventDefault: false,
enabled: true,
...trigger,
};
const { modifier, key, callback, preventDefault, enabled: triggerEnabled } = mergedTrigger;
if (triggerEnabled) {
if (modifier.length) {
const modifierDefs = (Array.isArray(modifier) ? modifier : [modifier]).map((def) =>
typeof def === 'string' ? [def] : def,
);
const modified = modifierDefs.some((def) =>
def.every((modifier) => modifiedMap[modifier]),
);
if (!modified) continue;
}
if (event.key === key) {
if (preventDefault) event.preventDefault();
/** @type {import('./public').ShortcutEventDetail} */
const detail = {
node,
trigger: mergedTrigger,
originalEvent: event,
};
node.dispatchEvent(new CustomEvent('shortcut', { detail }));
callback?.(detail);
}
}
}
}
if (enabled) node.addEventListener(type, handler);
return {
update: (update) => {
const { enabled: newEnabled = true, type: newType = 'keydown' } = update;
if (enabled && (!newEnabled || type !== newType)) {
node.removeEventListener(type, handler);
} else if (!enabled && newEnabled) {
node.addEventListener(newType, handler);
}
enabled = newEnabled;
type = newType;
trigger = update.trigger;
},
destroy: () => {
node.removeEventListener(type, handler);
},
};
}
|