@tb-dev/vue 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,4 @@
1
+ import { MaybeNilRef } from '../../types/ref';
1
2
  import { Fn, MaybePromise, Option } from '@tb-dev/utils';
2
3
  import { KeyFilter, OnKeyStrokeOptions } from '@vueuse/core';
3
4
  export type KeyDownEventHandler = Option<(event: KeyboardEvent) => MaybePromise<unknown>>;
@@ -5,6 +6,7 @@ export type OnKeyDownOptions = Omit<OnKeyStrokeOptions, 'eventName'> & {
5
6
  altKey?: boolean;
6
7
  ctrlKey?: boolean;
7
8
  detached?: boolean;
9
+ enabled?: MaybeNilRef<boolean>;
8
10
  metaKey?: boolean;
9
11
  prevent?: boolean;
10
12
  shiftKey?: boolean;
@@ -13,3 +15,5 @@ export type OnKeyDownOptions = Omit<OnKeyStrokeOptions, 'eventName'> & {
13
15
  export declare function onKeyDown(key: KeyFilter, handler?: KeyDownEventHandler, options?: OnKeyDownOptions): Fn;
14
16
  export declare function onAltKeyDown(key: KeyFilter, handler?: KeyDownEventHandler, options?: Omit<OnKeyDownOptions, 'altKey' | 'eventName'>): Fn;
15
17
  export declare function onCtrlKeyDown(key: KeyFilter, handler?: KeyDownEventHandler, options?: Omit<OnKeyDownOptions, 'ctrlKey' | 'eventName'>): Fn;
18
+ export declare function onShiftKeyDown(key: KeyFilter, handler?: KeyDownEventHandler, options?: Omit<OnKeyDownOptions, 'eventName' | 'shiftKey'>): Fn;
19
+ export declare function onCtrlShiftKeyDown(key: KeyFilter, handler?: KeyDownEventHandler, options?: Omit<OnKeyDownOptions, 'eventName' | 'ctrlKey' | 'shiftKey'>): Fn;
package/dist/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
1
  export * from './components';
2
2
  export * from './composables';
3
3
  export * from './utils';
4
+ export type * from './types';
package/dist/index.js CHANGED
@@ -1,4 +1,4 @@
1
- import { defineComponent, createBlock, openBlock, unref, withCtx, createElementBlock, renderSlot, toDisplayString, toRef, effectScope, computed, toValue } from 'vue';
1
+ import { defineComponent, createBlock, openBlock, unref, withCtx, createElementBlock, renderSlot, toDisplayString, toRef, effectScope, toValue, computed } from 'vue';
2
2
  import { RouterLink } from 'vue-router';
3
3
  import { computedAsync, useAsyncState, useElementSize as useElementSize$1, tryOnScopeDispose, onKeyStroke, useLocalStorage, useWindowSize } from '@vueuse/core';
4
4
  import { isNil } from '@tb-dev/utils';
@@ -85,6 +85,7 @@ function onKeyDown(key, handler, options = {}) {
85
85
  altKey = false,
86
86
  ctrlKey = false,
87
87
  detached = false,
88
+ enabled = true,
88
89
  metaKey = false,
89
90
  prevent = true,
90
91
  shiftKey = false,
@@ -100,7 +101,7 @@ function onKeyDown(key, handler, options = {}) {
100
101
  if (stopPropagation) {
101
102
  e.stopPropagation();
102
103
  }
103
- if (handler) {
104
+ if (toValue(enabled) && handler) {
104
105
  Promise.try(handler, e).catch(handleError);
105
106
  }
106
107
  };
@@ -130,6 +131,12 @@ function onAltKeyDown(key, handler, options) {
130
131
  function onCtrlKeyDown(key, handler, options) {
131
132
  return onKeyDown(key, handler, { ...options, ctrlKey: true });
132
133
  }
134
+ function onShiftKeyDown(key, handler, options) {
135
+ return onKeyDown(key, handler, { ...options, shiftKey: true });
136
+ }
137
+ function onCtrlShiftKeyDown(key, handler, options) {
138
+ return onKeyDown(key, handler, { ...options, ctrlKey: true, shiftKey: true });
139
+ }
133
140
 
134
141
  function localRef(key, initial, options) {
135
142
  const defaultValue = { inner: initial };
@@ -163,4 +170,4 @@ function maybe(value, fn) {
163
170
  return isNil(_value) ? null : fn(_value);
164
171
  }
165
172
 
166
- export { _sfc_main as Link, asyncComputed, asyncRef, getErrorHandler, handleError, localRef, maybe, onAltKeyDown, onCtrlKeyDown, onKeyDown, setErrorHandler, useElementSize, useHeight, useWidth, useWindowHeight, useWindowWidth };
173
+ export { _sfc_main as Link, asyncComputed, asyncRef, getErrorHandler, handleError, localRef, maybe, onAltKeyDown, onCtrlKeyDown, onCtrlShiftKeyDown, onKeyDown, onShiftKeyDown, setErrorHandler, useElementSize, useHeight, useWidth, useWindowHeight, useWindowWidth };
@@ -0,0 +1,2 @@
1
+ export type * from './ref';
2
+ export type * from './symbol';
@@ -0,0 +1,3 @@
1
+ import { MaybeRefOrGetter } from 'vue';
2
+ import { Option } from '@tb-dev/utils';
3
+ export type MaybeNilRef<T> = MaybeRefOrGetter<Option<T>>;
@@ -0,0 +1,6 @@
1
+ import { ComputedRef, InjectionKey, Ref, ShallowRef } from 'vue';
2
+ export type ComputedSymbol<T> = InjectionKey<ComputedRef<T>>;
3
+ export type RefSymbol<T> = InjectionKey<Readonly<Ref<T>>>;
4
+ export type ShallowRefSymbol<T> = InjectionKey<Readonly<ShallowRef<T>>>;
5
+ export type WritableRefSymbol<T> = InjectionKey<Ref<T>>;
6
+ export type WritableShallowRefSymbol<T> = InjectionKey<ShallowRef<T>>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tb-dev/vue",
3
- "version": "0.1.2",
3
+ "version": "0.1.4",
4
4
  "description": "Vue utilities",
5
5
  "license": "MIT",
6
6
  "type": "module",