TS: Coverted util service

This commit is contained in:
Dan Brown 2024-10-10 12:03:24 +01:00
parent a58102d6ef
commit 2e8d6ce7d9
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
9 changed files with 32 additions and 38 deletions

View File

@ -1,5 +1,5 @@
import {onChildEvent} from '../services/dom'; import {onChildEvent} from '../services/dom';
import {uniqueId} from '../services/util'; import {uniqueId} from '../services/util.ts';
import {Component} from './component'; import {Component} from './component';
/** /**

View File

@ -1,4 +1,4 @@
import {escapeHtml} from '../services/util'; import {escapeHtml} from '../services/util.ts';
import {onChildEvent} from '../services/dom'; import {onChildEvent} from '../services/dom';
import {Component} from './component'; import {Component} from './component';
import {KeyboardNavigationHandler} from '../services/keyboard-navigation'; import {KeyboardNavigationHandler} from '../services/keyboard-navigation';

View File

@ -1,4 +1,4 @@
import {debounce} from '../services/util'; import {debounce} from '../services/util.ts';
import {transitionHeight} from '../services/animations'; import {transitionHeight} from '../services/animations';
import {Component} from './component'; import {Component} from './component';

View File

@ -1,5 +1,5 @@
import {htmlToDom} from '../services/dom'; import {htmlToDom} from '../services/dom';
import {debounce} from '../services/util'; import {debounce} from '../services/util.ts';
import {KeyboardNavigationHandler} from '../services/keyboard-navigation'; import {KeyboardNavigationHandler} from '../services/keyboard-navigation';
import {Component} from './component'; import {Component} from './component';

View File

@ -1,5 +1,5 @@
import * as DOM from '../services/dom'; import * as DOM from '../services/dom';
import {scrollAndHighlightElement} from '../services/util'; import {scrollAndHighlightElement} from '../services/util.ts';
import {Component} from './component'; import {Component} from './component';
function toggleAnchorHighlighting(elementId, shouldHighlight) { function toggleAnchorHighlighting(elementId, shouldHighlight) {

View File

@ -1,5 +1,5 @@
import {onSelect} from '../services/dom'; import {onSelect} from '../services/dom';
import {debounce} from '../services/util'; import {debounce} from '../services/util.ts';
import {Component} from './component'; import {Component} from './component';
import {utcTimeStampToLocalTime} from '../services/dates.ts'; import {utcTimeStampToLocalTime} from '../services/dates.ts';

View File

@ -1,5 +1,5 @@
import {provideKeyBindings} from './shortcuts'; import {provideKeyBindings} from './shortcuts';
import {debounce} from '../services/util'; import {debounce} from '../services/util.ts';
import {Clipboard} from '../services/clipboard.ts'; import {Clipboard} from '../services/clipboard.ts';
/** /**

View File

@ -4,37 +4,39 @@
* N milliseconds. If `immediate` is passed, trigger the function on the * N milliseconds. If `immediate` is passed, trigger the function on the
* leading edge, instead of the trailing. * leading edge, instead of the trailing.
* @attribution https://davidwalsh.name/javascript-debounce-function * @attribution https://davidwalsh.name/javascript-debounce-function
* @param {Function} func
* @param {Number} waitMs
* @param {Boolean} immediate
* @returns {Function}
*/ */
export function debounce(func, waitMs, immediate) { export function debounce(func: Function, waitMs: number, immediate: boolean): Function {
let timeout; let timeout: number|null = null;
return function debouncedWrapper(...args) { return function debouncedWrapper(this: any, ...args: any[]) {
const context = this; const context: any = this;
const later = function debouncedTimeout() { const later = function debouncedTimeout() {
timeout = null; timeout = null;
if (!immediate) func.apply(context, args); if (!immediate) func.apply(context, args);
}; };
const callNow = immediate && !timeout; const callNow = immediate && !timeout;
clearTimeout(timeout); if (timeout) {
timeout = setTimeout(later, waitMs); clearTimeout(timeout);
}
timeout = window.setTimeout(later, waitMs);
if (callNow) func.apply(context, args); if (callNow) func.apply(context, args);
}; };
} }
function isDetailsElement(element: HTMLElement): element is HTMLDetailsElement {
return element.nodeName === 'DETAILS';
}
/** /**
* Scroll and highlight an element. * Scroll-to and highlight an element.
* @param {HTMLElement} element
*/ */
export function scrollAndHighlightElement(element) { export function scrollAndHighlightElement(element: HTMLElement): void {
if (!element) return; if (!element) return;
// Open up parent <details> elements if within
let parent = element; let parent = element;
while (parent.parentElement) { while (parent.parentElement) {
parent = parent.parentElement; parent = parent.parentElement;
if (parent.nodeName === 'DETAILS' && !parent.open) { if (isDetailsElement(parent) && !parent.open) {
parent.open = true; parent.open = true;
} }
} }
@ -44,15 +46,15 @@ export function scrollAndHighlightElement(element) {
const highlight = getComputedStyle(document.body).getPropertyValue('--color-link'); const highlight = getComputedStyle(document.body).getPropertyValue('--color-link');
element.style.outline = `2px dashed ${highlight}`; element.style.outline = `2px dashed ${highlight}`;
element.style.outlineOffset = '5px'; element.style.outlineOffset = '5px';
element.style.transition = null; element.style.removeProperty('transition');
setTimeout(() => { setTimeout(() => {
element.style.transition = 'outline linear 3s'; element.style.transition = 'outline linear 3s';
element.style.outline = '2px dashed rgba(0, 0, 0, 0)'; element.style.outline = '2px dashed rgba(0, 0, 0, 0)';
const listener = () => { const listener = () => {
element.removeEventListener('transitionend', listener); element.removeEventListener('transitionend', listener);
element.style.transition = null; element.style.removeProperty('transition');
element.style.outline = null; element.style.removeProperty('outline');
element.style.outlineOffset = null; element.style.removeProperty('outlineOffset');
}; };
element.addEventListener('transitionend', listener); element.addEventListener('transitionend', listener);
}, 1000); }, 1000);
@ -61,10 +63,8 @@ export function scrollAndHighlightElement(element) {
/** /**
* Escape any HTML in the given 'unsafe' string. * Escape any HTML in the given 'unsafe' string.
* Take from https://stackoverflow.com/a/6234804. * Take from https://stackoverflow.com/a/6234804.
* @param {String} unsafe
* @returns {string}
*/ */
export function escapeHtml(unsafe) { export function escapeHtml(unsafe: string): string {
return unsafe return unsafe
.replace(/&/g, '&amp;') .replace(/&/g, '&amp;')
.replace(/</g, '&lt;') .replace(/</g, '&lt;')
@ -75,10 +75,8 @@ export function escapeHtml(unsafe) {
/** /**
* Generate a random unique ID. * Generate a random unique ID.
*
* @returns {string}
*/ */
export function uniqueId() { export function uniqueId(): string {
// eslint-disable-next-line no-bitwise // eslint-disable-next-line no-bitwise
const S4 = () => (((1 + Math.random()) * 0x10000) | 0).toString(16).substring(1); const S4 = () => (((1 + Math.random()) * 0x10000) | 0).toString(16).substring(1);
return (`${S4() + S4()}-${S4()}-${S4()}-${S4()}-${S4()}${S4()}${S4()}`); return (`${S4() + S4()}-${S4()}-${S4()}-${S4()}-${S4()}${S4()}${S4()}`);
@ -86,10 +84,8 @@ export function uniqueId() {
/** /**
* Generate a random smaller unique ID. * Generate a random smaller unique ID.
*
* @returns {string}
*/ */
export function uniqueIdSmall() { export function uniqueIdSmall(): string {
// eslint-disable-next-line no-bitwise // eslint-disable-next-line no-bitwise
const S4 = () => (((1 + Math.random()) * 0x10000) | 0).toString(16).substring(1); const S4 = () => (((1 + Math.random()) * 0x10000) | 0).toString(16).substring(1);
return S4(); return S4();
@ -97,10 +93,8 @@ export function uniqueIdSmall() {
/** /**
* Create a promise that resolves after the given time. * Create a promise that resolves after the given time.
* @param {int} timeMs
* @returns {Promise}
*/ */
export function wait(timeMs) { export function wait(timeMs: number): Promise<any> {
return new Promise(res => { return new Promise(res => {
setTimeout(res, timeMs); setTimeout(res, timeMs);
}); });

View File

@ -1,5 +1,5 @@
import * as DrawIO from '../services/drawio.ts'; import * as DrawIO from '../services/drawio.ts';
import {wait} from '../services/util'; import {wait} from '../services/util.ts';
let pageEditor = null; let pageEditor = null;
let currentNode = null; let currentNode = null;