Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions e2e/testcafe-devextreme/tests/dataGrid/common/toast.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import DataGrid from 'devextreme-testcafe-models/dataGrid';
import { createScreenshotsComparer } from 'devextreme-screenshot-comparer';
import url from '../../../helpers/getPageUrl';
import { createWidget } from '../../../helpers/createWidget';

fixture.disablePageReloads`Toasts in DataGrid`.page(
url(__dirname, '../../container.html'),
);

test('Toast should be visible after calling and should be not visible after default display time', async (t) => {
const dataGrid = new DataGrid('#container');
const { takeScreenshot, compareResults } = createScreenshotsComparer(t);
await dataGrid.isReady();
await dataGrid.apiShowToast();
await t.expect(dataGrid.getToast().exists).ok();
await t
.expect(await takeScreenshot('ai-column__toast__at-the-right-position.png', dataGrid.element))
.ok()
.expect(compareResults.isValid())
.ok(compareResults.errorMessages());
await t.expect(dataGrid.getToast().exists).notOk();
}).before(async () => {
createWidget('dxDataGrid', {});
});
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,6 @@ import './module_not_extended/virtual_columns';
import './export/m_export';
import './focus/m_focus';
import './module_not_extended/row_dragging';
import './module_not_extended/toast';

export default DataGrid;
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ gridCore.registerModulesOrder([
'summary',
'columnFixing',
'export',
'gridView']);
'toast',
'gridView',
]);

class DataGrid extends GridCoreWidget<Properties> {
private _defaultOptionsRules() {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { ToastViewController } from '@ts/grids/grid_core/toast/m_toast_controller';
import { ToastView } from '@ts/grids/grid_core/toast/m_toast_view';

import gridCore from '../m_core';

gridCore.registerModule('toast', {
defaultOptions() {
return {};
},
controllers: {
toastViewController: ToastViewController,
},
views: {
toastView: ToastView,
},
});
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import type { ColumnHeadersView } from '../column_headers/m_column_headers';
import type { DataController } from '../data_controller/m_data_controller';
import modules from '../m_modules';
import type { ModuleType } from '../m_types';
import type { ToastViewController } from '../toast/m_toast_controller';
import type { RowsView } from '../views/m_rows_view';

const ERROR_ROW_CLASS = 'dx-error-row';
Expand All @@ -27,10 +28,13 @@ export class ErrorHandlingController extends modules.ViewController {

private _rowsView!: RowsView;

private _toastViewController!: ToastViewController;

public init() {
this._resizingController = this.getController('resizing');
this._columnsController = this.getController('columns');
this._columnHeadersView = this.getView('columnHeadersView');
this._toastViewController = this.getController('toastViewController');
this._rowsView = this.getView('rowsView');
}

Expand Down Expand Up @@ -152,6 +156,10 @@ export class ErrorHandlingController extends modules.ViewController {
super.optionChanged(args);
}
}

public showError(message: string) {
this._toastViewController.showToast(message, { type: 'error' });
}
}

const data = (Base: ModuleType<DataController>) => class ErrorHandlingDataControllerExtends extends Base {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ export interface Controllers {
stateStoring: import('./state_storing/m_state_storing_core').StateStoringController;
synchronizeScrolling: import('./views/m_grid_view').SynchronizeScrollingController;
tablePosition: import('./columns_resizing_reordering/m_columns_resizing_reordering').TablePositionViewController;
toastViewController: import('./toast/m_toast_controller').ToastViewController;
aiColumn: import('./ai_column/m_ai_column_controller').AiColumnController;
}

Expand All @@ -221,6 +222,7 @@ export interface Views {
gridView: import('./views/m_grid_view').GridView;
filterBuilderView: import('./filter/m_filter_builder').FilterBuilderView;
filterPanelView: import('./filter/m_filter_panel').FilterPanelView;
toastView: import('./toast/m_toast_view').ToastView;
}

export interface EditingControllerRequired {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import type { Properties as ToastProperties } from '@js/ui/toast';

import modules from '../m_modules';
import type { ToastView } from './m_toast_view';

export class ToastViewController extends modules.ViewController {
private _toastView: ToastView | null = null;

public init(): void {
this._toastView = this.getView('toastView');
}

public showToast(message: string, options: ToastProperties = {}): void {
this._toastView?.showToast(message, options);
}

public async hideToast(): Promise<void> {
await this._toastView?.hideToast();
}

public dispose(): void {
this._toastView?.dispose();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
import $ from '@js/core/renderer';
import type { Properties as ToastProperties } from '@js/ui/toast';
import type dxToast from '@js/ui/toast';

import modules from '../m_modules';

const DEFAULT_POSITION = { my: 'center bottom', at: 'center bottom' };

export class ToastView extends modules.View {
private _toastInstance: dxToast | null = null;

private _$toastContainer: any | null = null;

private _ensureToastContainer(): void {
if (!this._$toastContainer) {
this._$toastContainer = $('<div>').appendTo(this.component.$element());
}
}

private _createToastInstance(options: ToastProperties = {}): dxToast | null {
this._ensureToastContainer();

if (this._toastInstance) {
return this._toastInstance;
}

this._toastInstance = this._$toastContainer.dxToast({
position: {
...DEFAULT_POSITION,
of: this.component.$element(),
},
...options,
visible: false,
}).dxToast('instance');

return this._toastInstance;
}

public showToast(message: string, options: ToastProperties = {}): void {
const toast = this._createToastInstance(options);
toast?.option({
message,
...options,
visible: true,
});
}

public async hideToast(): Promise<void> {
if (this._toastInstance) {
await this._toastInstance.hide();
}
}

public dispose(): void {
if (this._toastInstance) {
this._toastInstance.dispose();
this._toastInstance = null;
}
if (this._$toastContainer) {
this._$toastContainer.remove();
this._$toastContainer = null;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,24 @@ const GROUP_ROW_SELECTOR = 'tr.dx-group-row';

const HIDDEN_COLUMNS_WIDTH = 'adaptiveHidden';

const VIEW_NAMES = ['columnsSeparatorView', 'blockSeparatorView', 'trackerView', 'headerPanel', 'columnHeadersView', 'rowsView', 'footerView', 'columnChooserView', 'filterPanelView', 'pagerView', 'draggingHeaderView', 'contextMenuView', 'errorView', 'headerFilterView', 'filterBuilderView'];
const VIEW_NAMES = [
'columnsSeparatorView',
'blockSeparatorView',
'trackerView',
'headerPanel',
'columnHeadersView',
'rowsView',
'footerView',
'columnChooserView',
'filterPanelView',
'pagerView',
'draggingHeaderView',
'contextMenuView',
'errorView',
'headerFilterView',
'filterBuilderView',
'toastView',
];

const E2E_ATTRIBUTES = {
a11yStatusContainer: 'e2e-a11y-general-status-container',
Expand Down
15 changes: 15 additions & 0 deletions packages/testcafe-models/dataGrid/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ export const CLASS = {
summaryTotal: 'dx-datagrid-summary-item',
scrollableContainer: 'dx-scrollable-container',
columnsSeparator: 'dx-datagrid-columns-separator',
toast: 'dx-toast-wrapper',
dragHeader: 'drag-header',
};

Expand Down Expand Up @@ -285,6 +286,10 @@ export default class DataGrid extends GridCore {
return new ContextMenu(this.body.find(`.${CLASS.contextMenu}.${this.addWidgetPrefix()}`));
}

getToast(): Selector {
return this.body.find(`.${CLASS.toast}`);
}

async scrollTo(
t: TestController,
options: { x?: number; y?: number; top?: number },
Expand Down Expand Up @@ -902,6 +907,16 @@ export default class DataGrid extends GridCore {
)();
}

apiShowToast(): Promise<void> {
const { getInstance } = this;
return ClientFunction(() => {
const gridInstance = getInstance() as any;
gridInstance.getController('errorHandling').showError('Error');
},
{ dependencies: { getInstance } },
)();
}

getDraggableHeader() {
return this.body.find(`.${this.addWidgetPrefix(CLASS.dragHeader)}`);
}
Expand Down
Loading