refactor(core): remove useWindow (#1504)
refactor(core): remove `useWindow`
This commit is contained in:
@@ -10,5 +10,4 @@ export * from './useUpdateNodePositions'
|
|||||||
export * from './useViewportHelper'
|
export * from './useViewportHelper'
|
||||||
export * from './useVueFlow'
|
export * from './useVueFlow'
|
||||||
export * from './useWatchProps'
|
export * from './useWatchProps'
|
||||||
export * from './useWindow'
|
|
||||||
export * from './useZoomPanHelper'
|
export * from './useZoomPanHelper'
|
||||||
|
|||||||
@@ -1,12 +1,11 @@
|
|||||||
import type { MaybeRefOrGetter } from 'vue'
|
import type { MaybeRefOrGetter } from 'vue'
|
||||||
import { onMounted, ref, toValue, watch } from 'vue'
|
import { onMounted, ref, toRef, toValue, watch } from 'vue'
|
||||||
import type { KeyFilter, KeyPredicate } from '@vueuse/core'
|
import type { KeyFilter, KeyPredicate } from '@vueuse/core'
|
||||||
import { onKeyStroke, useEventListener } from '@vueuse/core'
|
import { onKeyStroke, useEventListener } from '@vueuse/core'
|
||||||
import { useWindow } from './useWindow'
|
|
||||||
|
|
||||||
export interface UseKeyPressOptions {
|
export interface UseKeyPressOptions {
|
||||||
actInsideInputWithModifier?: MaybeRefOrGetter<boolean>
|
actInsideInputWithModifier?: MaybeRefOrGetter<boolean>
|
||||||
target?: MaybeRefOrGetter<EventTarget>
|
target?: MaybeRefOrGetter<EventTarget | null | undefined>
|
||||||
}
|
}
|
||||||
|
|
||||||
export function isInputDOMNode(event: KeyboardEvent): boolean {
|
export function isInputDOMNode(event: KeyboardEvent): boolean {
|
||||||
@@ -69,8 +68,6 @@ function useKeyOrCode(code: string, keysToWatch: string | string[]) {
|
|||||||
return keysToWatch.includes(code) ? 'code' : 'key'
|
return keysToWatch.includes(code) ? 'code' : 'key'
|
||||||
}
|
}
|
||||||
|
|
||||||
const window = useWindow()
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Composable that returns a boolean value if a key is pressed
|
* Composable that returns a boolean value if a key is pressed
|
||||||
*
|
*
|
||||||
@@ -78,10 +75,11 @@ const window = useWindow()
|
|||||||
* @param keyFilter - Can be a boolean, a string, an array of strings or a function that returns a boolean. If it's a boolean, it will act as if the key is always pressed. If it's a string, it will return true if a key matching that string is pressed. If it's an array of strings, it will return true if any of the strings match a key being pressed, or a combination (e.g. ['ctrl+a', 'ctrl+b'])
|
* @param keyFilter - Can be a boolean, a string, an array of strings or a function that returns a boolean. If it's a boolean, it will act as if the key is always pressed. If it's a string, it will return true if a key matching that string is pressed. If it's an array of strings, it will return true if any of the strings match a key being pressed, or a combination (e.g. ['ctrl+a', 'ctrl+b'])
|
||||||
* @param options - Options object
|
* @param options - Options object
|
||||||
*/
|
*/
|
||||||
export function useKeyPress(
|
export function useKeyPress(keyFilter: MaybeRefOrGetter<KeyFilter | null>, options?: UseKeyPressOptions) {
|
||||||
keyFilter: MaybeRefOrGetter<KeyFilter | null>,
|
const actInsideInputWithModifier = toRef(() => toValue(options?.actInsideInputWithModifier) ?? false)
|
||||||
options: UseKeyPressOptions = { actInsideInputWithModifier: true, target: window },
|
|
||||||
) {
|
const target = toRef(() => toValue(options?.target) ?? window)
|
||||||
|
|
||||||
const isPressed = ref(toValue(keyFilter) === true)
|
const isPressed = ref(toValue(keyFilter) === true)
|
||||||
|
|
||||||
let modifierPressed = false
|
let modifierPressed = false
|
||||||
@@ -114,7 +112,7 @@ export function useKeyPress(
|
|||||||
(e) => {
|
(e) => {
|
||||||
modifierPressed = wasModifierPressed(e)
|
modifierPressed = wasModifierPressed(e)
|
||||||
|
|
||||||
const preventAction = (!modifierPressed || (modifierPressed && !options.actInsideInputWithModifier)) && isInputDOMNode(e)
|
const preventAction = (!modifierPressed || (modifierPressed && !actInsideInputWithModifier.value)) && isInputDOMNode(e)
|
||||||
|
|
||||||
if (preventAction) {
|
if (preventAction) {
|
||||||
return
|
return
|
||||||
@@ -124,14 +122,14 @@ export function useKeyPress(
|
|||||||
|
|
||||||
isPressed.value = true
|
isPressed.value = true
|
||||||
},
|
},
|
||||||
{ eventName: 'keydown', target: options.target },
|
{ eventName: 'keydown', target },
|
||||||
)
|
)
|
||||||
|
|
||||||
onKeyStroke(
|
onKeyStroke(
|
||||||
(...args) => currentFilter(...args),
|
(...args) => currentFilter(...args),
|
||||||
(e) => {
|
(e) => {
|
||||||
if (isPressed.value) {
|
if (isPressed.value) {
|
||||||
const preventAction = (!modifierPressed || (modifierPressed && !options.actInsideInputWithModifier)) && isInputDOMNode(e)
|
const preventAction = (!modifierPressed || (modifierPressed && !actInsideInputWithModifier.value)) && isInputDOMNode(e)
|
||||||
|
|
||||||
if (preventAction) {
|
if (preventAction) {
|
||||||
return
|
return
|
||||||
@@ -140,7 +138,7 @@ export function useKeyPress(
|
|||||||
reset()
|
reset()
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{ eventName: 'keyup', target: options.target },
|
{ eventName: 'keyup', target },
|
||||||
)
|
)
|
||||||
|
|
||||||
function reset() {
|
function reset() {
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ import type { Ref } from 'vue'
|
|||||||
import { onBeforeUnmount, onMounted } from 'vue'
|
import { onBeforeUnmount, onMounted } from 'vue'
|
||||||
import { ErrorCode, VueFlowError, getDimensions } from '../utils'
|
import { ErrorCode, VueFlowError, getDimensions } from '../utils'
|
||||||
import { useVueFlow } from './useVueFlow'
|
import { useVueFlow } from './useVueFlow'
|
||||||
import { useWindow } from './useWindow'
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Composable that handles the resize of the viewport.
|
* Composable that handles the resize of the viewport.
|
||||||
@@ -11,8 +10,6 @@ import { useWindow } from './useWindow'
|
|||||||
* @param viewportEl
|
* @param viewportEl
|
||||||
*/
|
*/
|
||||||
export function useResizeHandler(viewportEl: Ref<HTMLDivElement | null>): void {
|
export function useResizeHandler(viewportEl: Ref<HTMLDivElement | null>): void {
|
||||||
const window = useWindow()
|
|
||||||
|
|
||||||
const { emits, dimensions } = useVueFlow()
|
const { emits, dimensions } = useVueFlow()
|
||||||
|
|
||||||
let resizeObserver: ResizeObserver
|
let resizeObserver: ResizeObserver
|
||||||
|
|||||||
@@ -1,19 +0,0 @@
|
|||||||
type UseWindow = Window & typeof globalThis & { chrome?: any }
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the window object
|
|
||||||
*
|
|
||||||
* @internal
|
|
||||||
*/
|
|
||||||
export function useWindow(): UseWindow {
|
|
||||||
if (typeof window !== 'undefined') {
|
|
||||||
return window as UseWindow
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
chrome: false,
|
|
||||||
addEventListener(..._: Parameters<Window['addEventListener']>) {
|
|
||||||
// do nothing
|
|
||||||
},
|
|
||||||
} as UseWindow
|
|
||||||
}
|
|
||||||
@@ -21,7 +21,6 @@ import type {
|
|||||||
XYPosition,
|
XYPosition,
|
||||||
XYZPosition,
|
XYZPosition,
|
||||||
} from '../types'
|
} from '../types'
|
||||||
import { useWindow } from '../composables'
|
|
||||||
import { isDef, warn } from '.'
|
import { isDef, warn } from '.'
|
||||||
|
|
||||||
export function nodeToRect(node: GraphNode): Rect {
|
export function nodeToRect(node: GraphNode): Rect {
|
||||||
@@ -64,8 +63,6 @@ export function getHostForElement(element: HTMLElement): Document {
|
|||||||
return doc
|
return doc
|
||||||
}
|
}
|
||||||
|
|
||||||
const window = useWindow()
|
|
||||||
|
|
||||||
return window.document
|
return window.document
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user