chore(core): update composable jsdocs

This commit is contained in:
braks
2024-02-15 17:46:21 +01:00
committed by Braks
parent ee8748e936
commit fbb3f63134
23 changed files with 104 additions and 18 deletions
@@ -66,6 +66,8 @@ function useKeyOrCode(code: string, keysToWatch: string | string[]) {
/**
* Reactive key press state
*
* todo: make this public?
* @internal
* @param keyFilter - Can be a boolean, a string or an array of strings. If it's a boolean, it will always return that value. If it's a string, it will return true if the key is pressed. If it's an array of strings, it will return true if any of the keys are pressed, or a combination is pressed (e.g. ['ctrl+a', 'ctrl+b'])
* @param onChange - Callback function that will be called when the key state changes
*/