Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: move all DOM utilities to @slickgrid-universal/utils package #1263

Merged
merged 2 commits into from
Dec 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions packages/common/src/core/slickGrid.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import Sortable, { SortableEvent } from 'sortablejs';
import DOMPurify from 'dompurify';
import { BindingEventService } from '@slickgrid-universal/binding';
import { isDefined, isPrimitiveOrHTML } from '@slickgrid-universal/utils';
import { createDomElement, emptyElement, getInnerSize, getOffset, insertAfterElement, isDefined, isPrimitiveOrHTML } from '@slickgrid-universal/utils';

import {
type BasePubSub,
Expand Down Expand Up @@ -77,7 +77,6 @@ import type {
SlickPlugin,
SlickGridEventData,
} from '../interfaces';
import { createDomElement, emptyElement, getInnerSize, getOffset, insertAfterElement } from '../services/domUtilities';
import type { SlickDataView } from './slickDataview';

/**
Expand Down
3 changes: 2 additions & 1 deletion packages/common/src/core/slickInteractions.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/* eslint-disable @typescript-eslint/ban-types */
import { windowScrollPosition } from '@slickgrid-universal/utils';

import type { DragItem, DragPosition, DraggableOption, MouseWheelOption, ResizableOption } from '../interfaces/index';
import { windowScrollPosition } from '../services/domUtilities';

/***
* Interactions, add basic behaviors to any element.
Expand Down
6 changes: 3 additions & 3 deletions packages/common/src/editors/__tests__/longTextEditor.spec.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// mocked modules
jest.mock('../../services/domUtilities', () => ({
...(jest.requireActual('../../services/domUtilities') as any),
jest.mock('@slickgrid-universal/utils', () => ({
...(jest.requireActual('@slickgrid-universal/utils') as any),
getOffset: jest.fn(),
}));

Expand All @@ -9,7 +9,7 @@ import { LongTextEditor } from '../longTextEditor';
import { AutocompleterOption, Column, ColumnEditor, EditorArguments, GridOption } from '../../interfaces/index';
import { SlickEvent, type SlickDataView, type SlickGrid } from '../../core/index';
import { TranslateServiceStub } from '../../../../../test/translateServiceStub';
import { getOffset } from '../../services/domUtilities';
import { getOffset } from '@slickgrid-universal/utils';

const containerId = 'demo-container';

Expand Down
4 changes: 2 additions & 2 deletions packages/common/src/editors/autocompleterEditor.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import autocompleter from 'autocompleter';
import type { AutocompleteItem, AutocompleteResult, AutocompleteSettings } from 'autocompleter';
import { BindingEventService } from '@slickgrid-universal/binding';
import { isObject, isPrimitiveValue, setDeepValue, toKebabCase } from '@slickgrid-universal/utils';
import { createDomElement, isObject, isPrimitiveValue, setDeepValue, toKebabCase } from '@slickgrid-universal/utils';

import { Constants } from './../constants';
import { FieldType } from '../enums/index';
Expand All @@ -22,7 +22,7 @@ import type {
} from '../interfaces/index';
import { textValidator } from '../editorValidators/textValidator';
import { addAutocompleteLoadingByOverridingFetch } from '../commonEditorFilter';
import { createDomElement, sanitizeTextByAvailableSanitizer, } from '../services/domUtilities';
import { sanitizeTextByAvailableSanitizer, } from '../services/domUtilities';
import { findOrDefault, getDescendantProperty, } from '../services/utilities';
import type { TranslaterService } from '../services/translater.service';
import { SlickEventData, type SlickGrid } from '../core/index';
Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/editors/checkboxEditor.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import { BindingEventService } from '@slickgrid-universal/binding';
import { setDeepValue, toSentenceCase } from '@slickgrid-universal/utils';
import { createDomElement, setDeepValue, toSentenceCase } from '@slickgrid-universal/utils';

import { Constants } from './../constants';
import type { Column, ColumnEditor, CompositeEditorOption, Editor, EditorArguments, EditorValidator, EditorValidationResult, GridOption } from './../interfaces/index';
import { createDomElement } from '../services/domUtilities';
import { getDescendantProperty, } from '../services/utilities';
import { SlickEventData, type SlickGrid } from '../core/index';

Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/editors/dateEditor.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { BindingEventService } from '@slickgrid-universal/binding';
import { setDeepValue } from '@slickgrid-universal/utils';
import { createDomElement, destroyAllElementProps, emptyElement, setDeepValue } from '@slickgrid-universal/utils';
import flatpickr from 'flatpickr';
import type { BaseOptions as FlatpickrBaseOptions } from 'flatpickr/dist/types/options';
import type { Instance as FlatpickrInstance } from 'flatpickr/dist/types/instance';
Expand All @@ -18,7 +18,6 @@ import type {
FlatpickrOption,
GridOption,
} from './../interfaces/index';
import { createDomElement, destroyAllElementProps, emptyElement, } from '../services/domUtilities';
import { getDescendantProperty, mapFlatpickrDateFormatWithFieldType, mapMomentDateFormatWithFieldType, } from './../services/utilities';
import type { TranslaterService } from '../services/translater.service';
import { SlickEventData, type SlickGrid } from '../core/index';
Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/editors/dualInputEditor.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { BindingEventService } from '@slickgrid-universal/binding';
import { setDeepValue, toSentenceCase } from '@slickgrid-universal/utils';
import { createDomElement, setDeepValue, toSentenceCase } from '@slickgrid-universal/utils';

import type {
DOMEvent,
Expand All @@ -15,7 +15,6 @@ import type {
} from '../interfaces/index';
import { getDescendantProperty } from '../services/utilities';
import { floatValidator, integerValidator, textValidator } from '../editorValidators';
import { createDomElement } from '../services/domUtilities';
import { SlickEventData, SlickEventHandler, type SlickGrid } from '../core';

/*
Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/editors/floatEditor.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import { toSentenceCase } from '@slickgrid-universal/utils';
import { createDomElement, toSentenceCase } from '@slickgrid-universal/utils';

import type { EditorArguments, EditorValidationResult } from '../interfaces/index';
import { floatValidator } from '../editorValidators/floatValidator';
import { InputEditor } from './inputEditor';
import { createDomElement } from '../services/domUtilities';
import { getDescendantProperty } from '../services/utilities';

const DEFAULT_DECIMAL_PLACES = 0;
Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/editors/inputEditor.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { BindingEventService } from '@slickgrid-universal/binding';
import { setDeepValue, toSentenceCase } from '@slickgrid-universal/utils';
import { createDomElement, setDeepValue, toSentenceCase } from '@slickgrid-universal/utils';

import type {
Column,
Expand All @@ -13,7 +13,6 @@ import type {
} from '../interfaces/index';
import { getDescendantProperty } from '../services/utilities';
import { textValidator } from '../editorValidators/textValidator';
import { createDomElement } from '../services/domUtilities';
import { SlickEventData, type SlickGrid } from '../core/index';

/*
Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/editors/integerEditor.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import { toSentenceCase } from '@slickgrid-universal/utils';
import { createDomElement, toSentenceCase } from '@slickgrid-universal/utils';

import type { EditorArguments, EditorValidationResult } from '../interfaces/index';
import { integerValidator } from '../editorValidators/integerValidator';
import { InputEditor } from './inputEditor';
import { createDomElement } from '../services/domUtilities';
import { getDescendantProperty } from '../services/utilities';

export class IntegerEditor extends InputEditor {
Expand Down
4 changes: 1 addition & 3 deletions packages/common/src/editors/longTextEditor.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { BindingEventService } from '@slickgrid-universal/binding';
import { setDeepValue, toSentenceCase } from '@slickgrid-universal/utils';
import { createDomElement, getOffset, type HtmlElementPosition, setDeepValue, toSentenceCase } from '@slickgrid-universal/utils';

import { Constants } from './../constants';
import type {
Expand All @@ -12,11 +12,9 @@ import type {
EditorValidationResult,
ElementPosition,
GridOption,
HtmlElementPosition,
Locale,
LongTextEditorOption,
} from '../interfaces/index';
import { createDomElement, getOffset, } from '../services/domUtilities';
import { getDescendantProperty, getTranslationPrefix, } from '../services/utilities';
import type { TranslaterService } from '../services/translater.service';
import { textValidator } from '../editorValidators/textValidator';
Expand Down
4 changes: 2 additions & 2 deletions packages/common/src/editors/selectEditor.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { setDeepValue } from '@slickgrid-universal/utils';
import { emptyElement, setDeepValue } from '@slickgrid-universal/utils';
import { dequal } from 'dequal/lite';
import { multipleSelect, MultipleSelectInstance, MultipleSelectOption, OptionRowData } from 'multiple-select-vanilla';

Expand All @@ -19,7 +19,7 @@ import type {
Locale,
SelectOption,
} from './../interfaces/index';
import { buildMsSelectCollectionList, CollectionService, emptyElement, findOrDefault, sanitizeTextByAvailableSanitizer, type TranslaterService } from '../services/index';
import { buildMsSelectCollectionList, CollectionService, findOrDefault, sanitizeTextByAvailableSanitizer, type TranslaterService } from '../services/index';
import { getDescendantProperty, getTranslationPrefix, } from '../services/utilities';
import { SlickEventData, type SlickGrid } from '../core/index';

Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/editors/sliderEditor.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { BindingEventService } from '@slickgrid-universal/binding';
import { setDeepValue, toSentenceCase } from '@slickgrid-universal/utils';
import { createDomElement, setDeepValue, toSentenceCase } from '@slickgrid-universal/utils';

import { Constants } from '../constants';
import type {
Expand All @@ -16,7 +16,6 @@ import type {
} from '../interfaces/index';
import { getDescendantProperty } from '../services/utilities';
import { sliderValidator } from '../editorValidators/sliderValidator';
import { createDomElement } from '../services/domUtilities';
import { SlickEventData, type SlickGrid } from '../core/index';

/*
Expand Down
6 changes: 0 additions & 6 deletions packages/common/src/enums/infer.type.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
export type InferType<T> = T extends infer R ? R : any;

/* eslint-disable @typescript-eslint/indent */
export type InferDOMType<T> =
T extends CSSStyleDeclaration ? Partial<CSSStyleDeclaration> :
T extends infer R ? R : any;
/* eslint-enable @typescript-eslint/indent */

export type MergeTypes<A, B> = {
[key in keyof A]: key extends keyof B ? B[key] : A[key];
} & B;
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ jest.mock('sortablejs', () => sortableMock);
import 'jest-extended';
import { SortableOptions } from 'sortablejs';
import { EventPubSubService } from '@slickgrid-universal/event-pub-sub';
import { deepCopy } from '@slickgrid-universal/utils';
import { createDomElement, deepCopy } from '@slickgrid-universal/utils';

import { Aggregators } from '../../aggregators/aggregators.index';
import { SlickDraggableGrouping } from '../slickDraggableGrouping';
import { ExtensionUtility } from '../../extensions/extensionUtility';
import type { Column, DraggableGroupingOption, GridOption } from '../../interfaces/index';
import { BackendUtilityService, createDomElement, } from '../../services';
import { BackendUtilityService, } from '../../services';
import { SharedService } from '../../services/shared.service';
import { TranslateServiceStub } from '../../../../../test/translateServiceStub';
import { SortDirectionNumber } from '../../enums/index';
Expand Down Expand Up @@ -268,18 +268,10 @@ describe('Draggable Grouping Plugin', () => {
gridContainerDiv.appendChild(mockDivPaneContainerElm);
gridContainerDiv.appendChild(mockDivPaneContainerElm2);
dropEvent = new Event('mouseup');
headerColumnDiv1 = createDomElement('div', {
className: 'slick-header-column', id: `${GRID_UID}firstName`, dataset: { id: 'firstName' },
}, preHeaderDiv);
headerColumnDiv2 = createDomElement('div', {
className: 'slick-header-column', id: `${GRID_UID}lastName`, dataset: { id: 'lastName' },
}, preHeaderDiv);
headerColumnDiv3 = createDomElement('div', {
className: 'slick-header-column', id: `${GRID_UID}age`, dataset: { id: 'age' },
}, preHeaderDiv);
headerColumnDiv4 = createDomElement('div', {
className: 'slick-header-column', id: `${GRID_UID}medals`, dataset: { id: 'medals' },
}, preHeaderDiv);
headerColumnDiv1 = createDomElement('div', { className: 'slick-header-column', id: `${GRID_UID}firstName`, dataset: { id: 'firstName' } }, preHeaderDiv);
headerColumnDiv2 = createDomElement('div', { className: 'slick-header-column', id: `${GRID_UID}lastName`, dataset: { id: 'lastName' } }, preHeaderDiv);
headerColumnDiv3 = createDomElement('div', { className: 'slick-header-column', id: `${GRID_UID}age`, dataset: { id: 'age' } }, preHeaderDiv);
headerColumnDiv4 = createDomElement('div', { className: 'slick-header-column', id: `${GRID_UID}medals`, dataset: { id: 'medals' } }, preHeaderDiv);
headerColumnDiv1.appendChild(createDomElement('span', { className: 'slick-column-name', textContent: 'First Name' }));
headerColumnDiv2.appendChild(createDomElement('span', { className: 'slick-column-name', textContent: 'Last Name' }));
headerColumnDiv3.appendChild(createDomElement('span', { className: 'slick-column-name', textContent: 'Age' }));
Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/extensions/extensionCommonUtils.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
/* eslint-disable @typescript-eslint/no-this-alias */
import { titleCase } from '@slickgrid-universal/utils';
import { createDomElement, titleCase } from '@slickgrid-universal/utils';

import type { Column, ColumnPickerOption, DOMEvent, GridMenuOption } from '../interfaces/index';
import { createDomElement } from '../services/domUtilities';
import { SlickColumnPicker } from './slickColumnPicker';
import { SlickGridMenu } from './slickGridMenu';

Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/extensions/menuBaseClass.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { BindingEventService } from '@slickgrid-universal/binding';
import type { BasePubSubService } from '@slickgrid-universal/event-pub-sub';
import { hasData } from '@slickgrid-universal/utils';
import { createDomElement, emptyElement, hasData } from '@slickgrid-universal/utils';

import type {
CellMenu,
Expand All @@ -18,7 +18,6 @@ import type {
} from '../interfaces/index';
import type { ExtensionUtility } from '../extensions/extensionUtility';
import type { SharedService } from '../services/shared.service';
import { createDomElement, emptyElement } from '../services/domUtilities';
import { SlickEventHandler, type SlickGrid } from '../core/index';

export type MenuType = 'command' | 'option';
Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/extensions/menuFromCellBaseClass.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { BasePubSubService } from '@slickgrid-universal/event-pub-sub';
import { titleCase } from '@slickgrid-universal/utils';
import { calculateAvailableSpace, createDomElement, findWidthOrDefault, getOffset, titleCase } from '@slickgrid-universal/utils';

import type {
CellMenu,
Expand All @@ -13,7 +13,6 @@ import type {
MenuOptionItemCallbackArgs,
} from '../interfaces/index';
import type { ExtensionUtility } from '../extensions/extensionUtility';
import { calculateAvailableSpace, createDomElement, findWidthOrDefault, getOffset, } from '../services/domUtilities';
import { type ExtendableItemTypes, type ExtractMenuType, MenuBaseClass, type MenuType } from './menuBaseClass';
import type { SharedService } from '../services/shared.service';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { stripTags } from '@slickgrid-universal/utils';
import { createDomElement, stripTags } from '@slickgrid-universal/utils';

import type { Column, ExcelCopyBufferOption, ExternalCopyClipCommand } from '../interfaces/index';
import { createDomElement } from '../services/domUtilities';
import { SlickEvent, SlickEventData, SlickEventHandler, type SlickGrid, SlickRange } from '../core/index';

// using external SlickGrid JS libraries
Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/extensions/slickCellRangeDecorator.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { deepMerge } from '@slickgrid-universal/utils';
import { createDomElement, deepMerge } from '@slickgrid-universal/utils';

import { createDomElement } from '../services/domUtilities';
import type { CellRangeDecoratorOption, CSSStyleDeclarationWritable } from '../interfaces/index';
import type { SlickGrid, SlickRange } from '../core/index';

Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/extensions/slickCellRangeSelector.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { deepMerge } from '@slickgrid-universal/utils';
import { deepMerge, emptyElement, getOffset, } from '@slickgrid-universal/utils';

import type {
CellRangeSelectorOption,
Expand All @@ -10,7 +10,6 @@ import type {
MouseOffsetViewport,
OnScrollEventArgs,
} from '../interfaces/index';
import { emptyElement, getOffset, } from '../services/domUtilities';
import { SlickCellRangeDecorator } from './index';
import { SlickEvent, SlickEventData, SlickEventHandler, type SlickGrid, SlickRange } from '../core/index';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { BindingEventService } from '@slickgrid-universal/binding';
import type { BasePubSubService } from '@slickgrid-universal/event-pub-sub';
import { createDomElement, emptyElement } from '@slickgrid-universal/utils';

import { type SlickDataView, SlickEventHandler, type SlickGrid } from '../core/index';
import type { CheckboxSelectorOption, Column, DOMMouseOrTouchEvent, GridOption, OnHeaderClickEventArgs, SelectableOverrideCallback } from '../interfaces/index';
import { SlickRowSelectionModel } from './slickRowSelectionModel';
import { createDomElement, emptyElement } from '../services/domUtilities';
import { SelectionModel } from '../enums/index';

export class SlickCheckboxSelectColumn<T = any> {
Expand Down
2 changes: 1 addition & 1 deletion packages/common/src/extensions/slickColumnPicker.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { BindingEventService } from '@slickgrid-universal/binding';
import type { BasePubSubService } from '@slickgrid-universal/event-pub-sub';
import { createDomElement, emptyElement, findWidthOrDefault } from '@slickgrid-universal/utils';

import type { Column, ColumnPickerOption, DOMMouseOrTouchEvent, GridOption, OnColumnsChangedArgs } from '../interfaces/index';
import type { ExtensionUtility } from '../extensions/extensionUtility';
import type { SharedService } from '../services/shared.service';
import { createDomElement, emptyElement, findWidthOrDefault } from '../services/domUtilities';
import {
addColumnTitleElementWhenDefined,
addCloseButtomElement,
Expand Down
3 changes: 1 addition & 2 deletions packages/common/src/extensions/slickDraggableGrouping.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { BindingEventService } from '@slickgrid-universal/binding';
import type { BasePubSubService, EventSubscription } from '@slickgrid-universal/event-pub-sub';
import { isEmptyObject } from '@slickgrid-universal/utils';
import { createDomElement, emptyElement, isEmptyObject } from '@slickgrid-universal/utils';
import Sortable, { type Options as SortableOptions, type SortableEvent } from 'sortablejs';

import type { ExtensionUtility } from '../extensions/extensionUtility';
Expand All @@ -15,7 +15,6 @@ import type {
GroupingGetterFunction,
} from '../interfaces/index';
import type { SharedService } from '../services/shared.service';
import { createDomElement, emptyElement } from '../services/domUtilities';
import { sortByFieldType } from '../sortComparers';
import { type SlickDataView, SlickEvent, SlickEventData, SlickEventHandler, type SlickGrid } from '../core/index';

Expand Down
3 changes: 2 additions & 1 deletion packages/common/src/extensions/slickGridMenu.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { BasePubSubService } from '@slickgrid-universal/event-pub-sub';
import { calculateAvailableSpace, createDomElement, emptyElement, findWidthOrDefault, getOffset, } from '@slickgrid-universal/utils';

import type {
Column,
Expand All @@ -14,7 +15,7 @@ import type {
} from '../interfaces/index';
import { DelimiterType, FileType } from '../enums/index';
import type { ExtensionUtility } from '../extensions/extensionUtility';
import { calculateAvailableSpace, createDomElement, emptyElement, findWidthOrDefault, getOffset, getTranslationPrefix, } from '../services/index';
import { getTranslationPrefix, } from '../services/index';
import type { ExcelExportService } from '../services/excelExport.service';
import type { FilterService } from '../services/filter.service';
import type { SharedService } from '../services/shared.service';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { createDomElement } from '@slickgrid-universal/utils';

import { SlickEventHandler, Utils as SlickUtils, type SlickDataView, SlickGroup, type SlickGrid } from '../core/index';
import type {
Column,
Expand All @@ -8,7 +10,6 @@ import type {
ItemMetadata,
OnClickEventArgs,
} from '../interfaces/index';
import { createDomElement } from '../services/domUtilities';

/**
* Provides item metadata for group (SlickGroup) and totals (SlickTotals) rows produced by the DataView.
Expand Down
Loading