File size: 5,016 Bytes
ae01f49 | 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 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | /////////////////////////////////////////////////////////////
//
// pgAdmin 4 - PostgreSQL Tools
//
// Copyright (C) 2013 - 2024, The pgAdmin Development Team
// This software is released under the PostgreSQL Licence
//
//////////////////////////////////////////////////////////////
import {useRef, useEffect, useState, useCallback, useLayoutEffect} from 'react';
import moment from 'moment';
import { isMac } from './keyboard_shortcuts';
/* React hook for setInterval */
export function useInterval(callback, delay) {
const savedCallback = useRef();
savedCallback.current = callback;
useEffect(() => {
function tick() {
savedCallback.current();
}
if(delay > -1) {
tick();
let id = setInterval(tick, delay);
return () => clearInterval(id);
}
}, [delay]);
}
export function useDelayedCaller(callback) {
let timer;
useEffect(() => {
return () => clearTimeout(timer);
}, []);
return (delay)=>{
timer = setTimeout(() => {
callback();
}, delay);
};
}
export function usePrevious(value) {
const ref = useRef();
useEffect(() => {
ref.current = value;
});
return ref.current;
}
export function useDelayDebounce(callback, args, delay) {
useEffect(() => {
const delayDebounceFn = setTimeout(() => {
if (args) {
callback(args);
}
}, delay);
return () => clearTimeout(delayDebounceFn);
}, [args]);
}
export function useOnScreen(ref) {
const [intersecting, setIntersecting] = useState(false);
const observer = new IntersectionObserver(
([entry]) => {
setIntersecting(entry.intersecting);
}
);
useEffect(() => {
if(ref?.current) {
observer.observe(ref.current);
}
// Remove the observer as soon as the component is unmounted
return () => { observer.disconnect(); };
}, []);
return intersecting;
}
export function useIsMounted() {
const ref = useRef(true);
useEffect(() => {
return () => {
ref.current = false;
};
}, []);
return useCallback(() => ref.current, []);
}
export function useStopwatch() {
const prevTime = useRef(new Date());
const [totalMsec, setTotalMsec] = useState(0);
const [isRunning, setIsRunning] = useState(false);
useInterval(() => {
setTotalMsec(moment(new Date()).diff(prevTime.current));
}, isRunning ? 100 : -1);
function start(startTime) {
prevTime.current = startTime || new Date();
setIsRunning(true);
}
const pause = (endTime)=>{
setIsRunning(false);
setTotalMsec(moment(endTime || new Date()).diff(prevTime.current));
};
function reset() {
setTotalMsec(0);
}
let msec = totalMsec;
/* Extract seconds from millisecs */
let seconds = parseInt(msec/1000);
msec = msec%1000;
/* Extract mins from seconds */
let minutes = parseInt(seconds/60);
seconds = seconds%60;
/* Extract hrs from mins */
let hours = parseInt(minutes/60);
minutes = minutes%60;
return {
hours: hours,
minutes: minutes,
seconds: seconds,
msec: msec,
start, pause, reset, isRunning,
};
}
/*
shortcuts = [
{
// From the preferences
shortcut: {
'control': true,
'shift': false,
'alt': true,
'key': {
'key_code': 73,
'char': 'I',
},
},
options: {
callback: ()=>{}
enabled?: boolean optional
}
}
]
*/
export function useKeyboardShortcuts(shortcuts, eleRef) {
const shortcutsRef = useRef(shortcuts);
const matchFound = (shortcut, e)=>{
if(!shortcut) return false;
let keyCode = e.which || e.keyCode;
const ctrlKey = (isMac() && shortcut.ctrl_is_meta) ? e.metaKey : e.ctrlKey;
return Boolean(shortcut.alt) == e.altKey &&
Boolean(shortcut.shift) == e.shiftKey &&
Boolean(shortcut.control) == ctrlKey &&
shortcut.key.key_code == keyCode;
};
useEffect(()=>{
let ele = eleRef.current ?? document;
const keydownCallback = (e)=>{
Promise.resolve(0).then(()=>{
let allListeners = _.filter(shortcutsRef.current, (s)=>matchFound(s.shortcut, e));
for(const {options} of allListeners) {
Promise.resolve(0).then(()=>{
if(options.callback && (options.enabled ?? true)) {
e.preventDefault();
e.stopPropagation();
options.callback(e);
}
});
}
});
};
ele.addEventListener('keydown', keydownCallback);
return ()=>{
ele.removeEventListener('keydown', keydownCallback);
};
}, [eleRef.current]);
useEffect(()=>{
shortcutsRef.current = shortcuts;
}, [shortcuts]);
}
export function useWindowSize() {
const [size, setSize] = useState([999999, 999999]);
useLayoutEffect(() => {
function updateSize() {
setSize([window.innerWidth, window.innerHeight]);
}
window.addEventListener('resize', updateSize);
updateSize();
return () => window.removeEventListener('resize', updateSize);
}, []);
return size;
}
|