Skip to content
Open
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
25 changes: 10 additions & 15 deletions packages/devextreme/js/__internal/core/widget/dom_component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { cleanDataRecursive } from '@js/core/element_data';
import errors from '@js/core/errors';
import type { dxElementWrapper } from '@js/core/renderer';
import $ from '@js/core/renderer';
import type { FunctionTemplate } from '@js/core/templates/function_template';
import { noop } from '@js/core/utils/common';
import { extend } from '@js/core/utils/extend';
import { each } from '@js/core/utils/iterator';
Expand All @@ -15,7 +16,7 @@ import { addShadowDomStyles } from '@js/core/utils/shadow_dom';
import { isDefined, isFunction, isString } from '@js/core/utils/type';
import { hasWindow } from '@js/core/utils/window';
import license, { peekValidationPerformed } from '@ts/core/license/license_validation';
import type { IntegrationOptions } from '@ts/core/template_manager';
import type { IntegrationOptions, TemplateManager } from '@ts/core/template_manager';
import TemplateManagerModule from '@ts/core/template_manager';
import { uiLayerInitialized } from '@ts/core/utils/common';
import type { ComponentProperties, DefaultActionArgs, DefaultActionConfig } from '@ts/core/widget/component';
Expand Down Expand Up @@ -62,8 +63,7 @@ class DOMComponent<

private _requireRefresh?: boolean;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
_templateManager!: any;
_templateManager!: TemplateManager;

// eslint-disable-next-line @typescript-eslint/no-useless-constructor
constructor(element: Element | dxElementWrapper, options?: unknown) {
Expand Down Expand Up @@ -581,21 +581,16 @@ class DOMComponent<
}
}

// eslint-disable-next-line @stylistic/max-len
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type, @typescript-eslint/explicit-module-boundary-types
_getTemplateByOption(optionName) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
_getTemplateByOption(optionName: string): FunctionTemplate {
return this._getTemplate(this.option(optionName));
}

// eslint-disable-next-line @stylistic/max-len
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type, @typescript-eslint/explicit-module-boundary-types
_getTemplate(templateSource) {
const templates = this.option('integrationOptions.templates');
const isAsyncTemplate = this.option('templatesRenderAsynchronously');
const skipTemplates = this.option('integrationOptions.skipTemplates');
_getTemplate(templateSource: unknown): FunctionTemplate {
const { integrationOptions } = this.option();
const templates = integrationOptions?.templates as Record<string, unknown>;
const skipTemplates = integrationOptions?.skipTemplates;
const isAsyncTemplate = Boolean(this.option('templatesRenderAsynchronously'));

// eslint-disable-next-line @typescript-eslint/no-unsafe-return
return this._templateManager.getTemplate(
templateSource,
templates,
Expand All @@ -604,7 +599,7 @@ class DOMComponent<
skipTemplates,
},
this,
);
) as FunctionTemplate;
}

// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
Expand Down
3 changes: 0 additions & 3 deletions packages/devextreme/js/__internal/scheduler/scheduler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -380,9 +380,6 @@ class Scheduler extends SchedulerOptionsBaseWidget {

declare _dataSource: DataSource | undefined;

// eslint-disable-next-line @typescript-eslint/naming-convention -- inherited Widget API
declare _getTemplate: (template: unknown) => FunctionTemplate;

// TODO: used externally in m_subscribes.ts,
// view_model/preparation/prepare_appointments.ts,
// view_model/filtration/utils/get_filter_options/get_filter_options.ts
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { template } from '@js/common';
import { name as clickEventName } from '@js/common/core/events/click';
import { start as hoverStartEventName } from '@js/common/core/events/hover';
import { addNamespace } from '@js/common/core/events/utils/index';
Expand All @@ -9,6 +8,7 @@ import { getPublicElement } from '@js/core/element';
import { data as elementData } from '@js/core/element_data';
import type { dxElementWrapper } from '@js/core/renderer';
import $ from '@js/core/renderer';
import type { FunctionTemplate } from '@js/core/templates/function_template';
import coreDateUtils from '@js/core/utils/date';
import dateSerialization from '@js/core/utils/date_serialization';
import type { DxEvent } from '@js/events';
Expand Down Expand Up @@ -101,9 +101,7 @@ export interface BaseViewProperties extends WidgetProperties {

hoveredRange: Date[];

cellTemplate?: template | (
(itemData: CellTemplateData, itemIndex: number, itemElement: Element) => dxElementWrapper
);
cellTemplate?: FunctionTemplate;

onCellClick?: (e: CellEvent) => void;
onCellHover?: (e: CellEvent) => void;
Expand Down Expand Up @@ -365,7 +363,6 @@ class BaseView<
$(row).append(cell);

if (cellTemplate) {
// @ts-expect-error ts-error
cellTemplate.render(this._prepareCellTemplateData(cellDate, cellIndex, $cell));
} else {
cell.innerHTML = this._getCellText(cellDate);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import Guid from '@js/core/guid';
import type { DefaultOptionsRule } from '@js/core/options/utils';
import type { dxElementWrapper } from '@js/core/renderer';
import $ from '@js/core/renderer';
import { FunctionTemplate } from '@js/core/templates/function_template';
import dateUtils from '@js/core/utils/date';
import dateSerialization from '@js/core/utils/date_serialization';
import { inRange, sign } from '@js/core/utils/math';
Expand All @@ -29,6 +28,7 @@ import type {
CalendarZoomLevel, DateLike, Properties,
} from '@js/ui/calendar';
import { current, isFluent } from '@js/ui/themes';
import { FunctionTemplate } from '@ts/core/templates/function_template';
import type { OptionChanged } from '@ts/core/widget/types';
import type { SupportedKeys } from '@ts/core/widget/widget';
import eventsEngine from '@ts/events/core/events_engine';
Expand Down
3 changes: 2 additions & 1 deletion packages/devextreme/js/__internal/ui/drawer/drawer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import type {
PointerInteractionEvent,
} from '@js/events';
import type { PanelLocation, Properties } from '@js/ui/drawer';
import type { TemplateBase } from '@ts/core/templates/template_base';
import type { OptionChanged } from '@ts/core/widget/types';
import Widget from '@ts/core/widget/widget';
import eventsEngine from '@ts/events/core/events_engine';
Expand Down Expand Up @@ -304,7 +305,7 @@ class Drawer extends Widget<DrawerProperties> {

_renderViewContent(): void {
const contentTemplateOption = this.option('contentTemplate');
const contentTemplate = this._getTemplate(contentTemplateOption);
const contentTemplate = this._getTemplate(contentTemplateOption) as unknown as TemplateBase;

if (contentTemplate) {
const $viewTemplate = contentTemplate.render({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ export default class DropDownButton<
const { editor } = this;
const { dropDownButtonTemplate } = editor?.option() ?? {};

options.template = this.editor?._getTemplateByOption('dropDownButtonTemplate');
options.template = this.editor?._getTemplateByOption('dropDownButtonTemplate') as unknown as DropDownButtonOptions['template'];
this.currentTemplate = dropDownButtonTemplate;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ export interface FieldTemplate {
}

interface FieldAddonsTemplates {
beforeTemplate?: FieldTemplate;
afterTemplate?: FieldTemplate;
beforeTemplate: FieldTemplate | null;
afterTemplate: FieldTemplate | null;
}

type PopupToolbarItemConfig = ToolbarItem & { shortcut?: string };
Expand Down Expand Up @@ -414,7 +414,7 @@ class DropDownEditor<
return;
}

// eslint-disable-next-line @typescript-eslint/no-unsafe-return, consistent-return
// eslint-disable-next-line consistent-return
return this._getTemplate(fieldTemplate);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export type LabelOptions = SimpleItem['label'] & {
isRequired: boolean;

markOptions: LabelMarkOptions;
labelTemplate: FunctionTemplate;
labelTemplate: FunctionTemplate | null;
labelTemplateData?: SimpleItemLabelTemplateData;
onLabelTemplateRendered: () => void;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ export interface ConvertToRenderFieldItemOptions {
) => Editor);

item: Required<SimpleItem>;
template: FunctionTemplate;
labelTemplate: FunctionTemplate;
template: FunctionTemplate | null;
labelTemplate: FunctionTemplate | null;
name: string;
formLabelLocation: LabelLocation | undefined;
requiredMessageTemplate: FunctionTemplate;
Expand Down Expand Up @@ -109,7 +109,7 @@ export interface FieldItemOptions {
item: Required<SimpleItem>;
isSimpleItem: boolean;
isRequired: boolean;
template: FunctionTemplate;
template: FunctionTemplate | null;
helpID: string | null;
labelID?: string | null;
name: string;
Expand All @@ -127,7 +127,7 @@ export interface ConvertToLabelOptions {
managerMarkOptions: LabelMarkOptions;
showColonAfterLabel: boolean;
labelLocation: LabelLocation | undefined;
labelTemplate: FunctionTemplate;
labelTemplate: FunctionTemplate | null;
formLabelMode?: FormLabelMode;
onLabelTemplateRendered: () => void;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/devextreme/js/__internal/ui/form/form.ts
Original file line number Diff line number Diff line change
Expand Up @@ -687,7 +687,7 @@ class Form extends Widget<FormProperties> {
item: PreparedItem,
): void {
if (item.template) {
item.template = this._getTemplate(item.template);
item.template = this._getTemplate(item.template) as unknown as PreparedItem['template'];
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import $ from '@js/core/renderer';
import type { TemplateBase } from '@ts/core/templates/template_base';
import type { FunctionTemplate } from '@js/core/templates/function_template';
import Quill from 'devextreme-quill';

import type {
Expand All @@ -15,7 +15,7 @@ import TemplatesStorage from '../utils/templates_storage';
interface MentionBlotConstructor extends EmbedBlotConstructor<MentionData> {
create: (data: MentionData) => HTMLElement;
value: (node: HTMLElement) => MentionData;
addTemplate: (data: MentionTemplateKey, template: TemplateBase) => void;
addTemplate: (data: MentionTemplateKey, template: FunctionTemplate) => void;
removeTemplate: (data: MentionTemplateKey) => void;
_templatesStorage: TemplatesStorage;
}
Expand Down Expand Up @@ -80,7 +80,7 @@ if (Quill) {
.append(data.value);
}

static addTemplate(data: MentionTemplateKey, template: TemplateBase): void {
static addTemplate(data: MentionTemplateKey, template: FunctionTemplate): void {
this._templatesStorage.set(data, template);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import type { DxEvent } from '@js/events';
import type { Properties as FormProperties } from '@js/ui/form';
import type { Converter, HtmlEditorFormat, Properties } from '@js/ui/html_editor';
import type { Properties as PopupProperties } from '@js/ui/popup';
import type { TemplateBase } from '@ts/core/templates/template_base';
import { getNextFocusableElement, getPreviousFocusableElement } from '@ts/core/utils/focus';
import type { OptionChanged } from '@ts/core/widget/types';
import { Event as dxEvent } from '@ts/events/core/events';
Expand Down Expand Up @@ -221,7 +222,7 @@ class HtmlEditor extends Editor<Properties> {

this._renderStylingMode();

const template = this._getTemplate(ANONYMOUS_TEMPLATE_NAME);
const template = this._getTemplate(ANONYMOUS_TEMPLATE_NAME) as unknown as TemplateBase;
const transclude = true;

this._$templateResult = template?.render({
Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
import type { FunctionTemplate } from '@js/core/templates/function_template';
import { isDefined, isEmptyObject } from '@js/core/utils/type';
import type { TemplateBase } from '@ts/core/templates/template_base';

import type { MentionTemplateKey, MentionTemplateLookupKey } from '../types';

export default class TemplatesStorage {
_storage: Record<string, Record<string, TemplateBase>>;
_storage: Record<string, Record<string, FunctionTemplate>>;

constructor() {
this._storage = {};
}

set({ editorKey, marker }: MentionTemplateKey, value: TemplateBase): void {
set({ editorKey, marker }: MentionTemplateKey, value: FunctionTemplate): void {
this._storage[editorKey] ??= {};
this._storage[editorKey][marker] = value;
}

get({ editorKey, marker }: MentionTemplateLookupKey): TemplateBase | undefined {
get({ editorKey, marker }: MentionTemplateLookupKey): FunctionTemplate | undefined {
const isQuillFormatCall = !isDefined(editorKey);

// NOTE: If anonymous templates are used, mentions are parsed from the markup.
Expand Down
4 changes: 2 additions & 2 deletions packages/devextreme/js/__internal/ui/lookup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -772,7 +772,7 @@ class Lookup extends DropDownList<LookupProperties> {
maxHeight: dropDownOptions.maxHeight,
showTitle: dropDownOptions.showTitle,
title: dropDownOptions.title,
titleTemplate: this._getTemplateByOption('dropDownOptions.titleTemplate'),
titleTemplate: this._getTemplateByOption('dropDownOptions.titleTemplate') as unknown as PopupProperties['titleTemplate'],
// @ts-expect-error fix on PopoverProperties level
onTitleRendered: dropDownOptions.onTitleRendered,
fullScreen: dropDownOptions.fullScreen,
Expand Down Expand Up @@ -1053,7 +1053,7 @@ class Lookup extends DropDownList<LookupProperties> {
...{
tabIndex: searchEnabled ? -1 : 0,
grouped,
groupTemplate: this._getTemplateByOption('groupTemplate'),
groupTemplate: this._getTemplateByOption('groupTemplate') as unknown as ListBaseProperties['groupTemplate'],
pullRefreshEnabled,
useNativeScrolling,
pullingDownText,
Expand Down
3 changes: 2 additions & 1 deletion packages/devextreme/js/__internal/ui/overlay/overlay.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ import type {
import type dxOverlay from '@js/ui/overlay';
import type { dxOverlayAnimation, dxOverlayOptions, Properties } from '@js/ui/overlay';
import uiErrors from '@js/ui/widget/ui.errors';
import type { TemplateBase } from '@ts/core/templates/template_base';
import documentSizeCallbacks from '@ts/core/utils/document_size_callbacks';
import domUtils from '@ts/core/utils/dom';
import selectors from '@ts/core/utils/selectors';
Expand Down Expand Up @@ -1302,7 +1303,7 @@ class Overlay<
const { contentTemplate: contentTemplateOption } = this.option();

const whenContentRendered = Deferred();
const contentTemplate = this._getTemplate(contentTemplateOption);
const contentTemplate = this._getTemplate(contentTemplateOption) as unknown as TemplateBase;
const transclude = this._templateManager.anonymousTemplateName === contentTemplateOption;

contentTemplate?.render({
Expand Down
4 changes: 2 additions & 2 deletions packages/devextreme/js/__internal/ui/popup/popup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import type { dxElementWrapper } from '@js/core/renderer';
import $ from '@js/core/renderer';
import resizeObserverSingleton from '@js/core/resize_observer';
import { EmptyTemplate } from '@js/core/templates/empty_template';
import type { TemplateBase } from '@js/core/templates/template_base';
import type { FunctionTemplate } from '@js/core/templates/function_template';
import { noop } from '@js/core/utils/common';
import type { DeferredObj } from '@js/core/utils/deferred';
import { contains } from '@js/core/utils/dom';
Expand Down Expand Up @@ -770,7 +770,7 @@ class Popup<
}

_renderByTemplate(
template: TemplateBase,
template: FunctionTemplate,
$container: dxElementWrapper,
): dxElementWrapper {
const $result = $(template.render({ container: getPublicElement($container) }));
Expand Down
2 changes: 1 addition & 1 deletion packages/devextreme/js/__internal/ui/responsive_box.ts
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ class ResponsiveBox extends CollectionWidget<ResponsiveBoxProperties> {
width: '100%',
height: '100%',
items: rootItems,
itemTemplate: this._getTemplateByOption('itemTemplate'),
itemTemplate: this._getTemplateByOption('itemTemplate') as unknown as BoxOptions['itemTemplate'],
itemHoldTimeout,
onItemHold: this._createActionByOption('onItemHold'),
onItemClick: this._createActionByOption('onItemClick'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ class TabPanel extends MultiView<TabPanelProperties> {
this._refreshActiveDescendant();
},
onItemRendered: this._titleRenderedAction.bind(this),
itemTemplate: this._getTemplateByOption('itemTitleTemplate'),
itemTemplate: this._getTemplateByOption('itemTitleTemplate') as unknown as TabsProperties['itemTemplate'],
items,
// @ts-expect-error ts-error
noDataText: null,
Expand Down
4 changes: 2 additions & 2 deletions packages/devextreme/js/__internal/ui/tag_box.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import Guid from '@js/core/guid';
import type { dxElementWrapper } from '@js/core/renderer';
import $ from '@js/core/renderer';
import { BindableTemplate } from '@js/core/templates/bindable_template';
import type { TemplateBase } from '@js/core/templates/template_base';
import type { FunctionTemplate } from '@js/core/templates/function_template';
import { getIntersection, removeDuplicates } from '@js/core/utils/array';
import { ensureDefined, equalByValue } from '@js/core/utils/common';
import type { DeferredObj } from '@js/core/utils/deferred';
Expand Down Expand Up @@ -109,7 +109,7 @@ class TagBox<

_isDataSourceChanged?: boolean;

_tagTemplate?: TemplateBase;
_tagTemplate?: FunctionTemplate;

_isDataSourceOptionChanged?: boolean;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ export class SingleLineStrategy {
this._menu = this._toolbar._createComponent($menu, DropDownMenu, {
disabled,
allowKeyboardNavigation,
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
itemTemplate: () => menuItemTemplate,
onItemClick: (e) => { itemClickAction(e); },
container: menuContainer,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
} from '@js/ui/themes';
import type { Item, Properties } from '@js/ui/toolbar';
import { BindableTemplate } from '@ts/core/templates/bindable_template';
import type { TemplateBase } from '@ts/core/templates/template_base';
import type { OptionChanged } from '@ts/core/widget/types';
import type { SupportedKeys } from '@ts/core/widget/widget';
import CollectionWidgetAsync from '@ts/ui/collection/collection_widget.async';
Expand Down Expand Up @@ -144,7 +145,7 @@ class ToolbarBase<
$container.text(String(data));
}

this._getTemplate('dx-polymorph-widget').render({
(this._getTemplate('dx-polymorph-widget') as unknown as TemplateBase).render({
container: $container,
model: rawModel,
parent: this,
Expand Down
Loading