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

DataGrid: Fix duplicate headers when headerCellTemplate is given (T1155453) #24531

Merged
merged 3 commits into from
May 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
4 changes: 4 additions & 0 deletions js/ui/grid_core/ui.grid_core.column_fixing.js
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,10 @@ const baseFixedColumns = {
return $cell;
},

_getContent: function(isFixedTableRendering) {
return isFixedTableRendering ? this._fixedTableElement?.parent() : this.callBase.apply(this, arguments);
},

_wrapTableInScrollContainer: function($table, isFixedTableRendering) {
const $scrollContainer = this.callBase.apply(this, arguments);

Expand Down
13 changes: 13 additions & 0 deletions js/ui/grid_core/ui.grid_core.columns_view.js
Original file line number Diff line number Diff line change
Expand Up @@ -891,6 +891,18 @@ const columnsViewMembers = {
}
},

_getContent: function() {
return this._tableElement?.parent();
},

_removeContent: function(isFixedTableRendering) {
const $scrollContainer = this._getContent(isFixedTableRendering);

if($scrollContainer?.length) {
$scrollContainer.remove();
}
},

_wrapTableInScrollContainer: function($table) {
const $scrollContainer = $('<div>');
const useNative = this.option('scrolling.useNative');
Expand Down Expand Up @@ -949,6 +961,7 @@ const columnsViewMembers = {

_updateContent: function($newTableElement, change, isFixedTableRendering) {
return this.waitAsyncTemplates().done(() => {
this._removeContent(isFixedTableRendering);
this.setTableElement($newTableElement, isFixedTableRendering);
this._wrapTableInScrollContainer($newTableElement, isFixedTableRendering);
});
Expand Down
14 changes: 14 additions & 0 deletions testing/testcafe/model/dataGrid/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ClientFunction, Selector } from 'testcafe';
import DataGridInstance from '../../../../js/ui/data_grid';
import Widget from '../internal/widget';
import DataRow from './data/row';
import GroupRow from './groupRow';
Expand Down Expand Up @@ -458,6 +459,19 @@ export default class DataGrid extends Widget {
)();
}

apiCollapseAllGroups(): Promise<void> {
const { getInstance } = this;

return ClientFunction(
() => (getInstance() as DataGridInstance).option('grouping.autoExpandAll', false),
{
dependencies: {
getInstance,
},
},
)();
}

moveRow(rowIndex: number, x: number, y: number, isStart = false): Promise<void> {
const { getInstance } = this;

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
143 changes: 143 additions & 0 deletions testing/testcafe/tests/dataGrid/grouping/grouping.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@ import { createScreenshotsComparer } from 'devextreme-screenshot-comparer';
import url from '../../../helpers/getPageUrl';
import createWidget from '../../../helpers/createWidget';
import DataGrid from '../../../model/dataGrid';
import { makeColumnHeadersViewTemplatesAsync } from '../helpers/asyncTemplates';

fixture.disablePageReloads`Grouping Panel`
.page(url(__dirname, '../../container.html'));

const DATA_GRID_SELECTOR = '#container';

test('Grouping Panel label should not overflow in a narrow grid (T1103925)', async (t) => {
const { takeScreenshot, compareResults } = createScreenshotsComparer(t);

Expand Down Expand Up @@ -77,3 +80,143 @@ test('Content should be rendered correctly after setting the grouping.autoExpand
autoExpandAll: false,
},
}));

// T1112573
test('Content should be rendered correctly after setting the grouping.autoExpandAll property to true when dataRowTemplate is given', async (t) => {
const { takeScreenshot, compareResults } = createScreenshotsComparer(t);
const dataGrid = new DataGrid('#container');

await dataGrid.apiExpandAllGroups();

await t
.wait(100)
.expect(await takeScreenshot('expanded-groups-content', dataGrid.element))
.ok()
.expect(compareResults.isValid())
.ok(compareResults.errorMessages());
}).before(async () => createWidget('dxDataGrid', {
dataSource: [
{
field1: '1', field2: 'test1',
},
{
field1: '2', field2: 'test1',
},
{
field1: '3', field2: 'test2',
},
],
width: 700,
columns: [
'field1',
{ dataField: 'field2', groupIndex: 0 },
],
dataRowTemplate(container, { data }) {
return $(container).append($(`<tr><td>${data.field1}</td></tr>`));
},
groupPanel: {
visible: true,
},
grouping: {
autoExpandAll: false,
},
}));

// T1155453
test('Headers should be rendered correctly after changing the grouping.autoExpandAll when headerCellTemplate is given (React)', async (t) => {
// arrange
const { takeScreenshot, compareResults } = createScreenshotsComparer(t);
const dataGrid = new DataGrid('#container');

await takeScreenshot('T1155453-expanded-groups', dataGrid.element);

// act
await dataGrid.apiCollapseAllGroups();
await t.wait(100);

await takeScreenshot('T1155453-collapsed-groups', dataGrid.element);

// assert
await t
.expect(compareResults.isValid())
.ok(compareResults.errorMessages());
}).before(async () => {
await createWidget('dxDataGrid', {
dataSource: [
{
field1: '1', field2: 'test1',
},
{
field1: '2', field2: 'test1',
},
{
field1: '3', field2: 'test2',
},
],
width: 700,
renderAsync: false,
templatesRenderAsynchronously: true,
columns: [
{ dataField: 'field1', headerCellTemplate: (_, { column }) => $('<div>').text(column.caption) },
{ dataField: 'field2', groupIndex: 0 },
],
groupPanel: {
visible: true,
},
grouping: {
autoExpandAll: true,
},
});

await makeColumnHeadersViewTemplatesAsync(DATA_GRID_SELECTOR);
});

// T1155453
test('Headers should be rendered correctly after changing the grouping.autoExpandAll when there is fixed column and headerCellTemplate is given (React)', async (t) => {
// arrange
const { takeScreenshot, compareResults } = createScreenshotsComparer(t);
const dataGrid = new DataGrid('#container');

await takeScreenshot('T1155453-expanded-groups-with-fixed-content', dataGrid.element);

// act
await dataGrid.apiCollapseAllGroups();
await t.wait(200);

await takeScreenshot('T1155453-collapsed-groups-with-fixed-content', dataGrid.element);

// assert
await t
.expect(compareResults.isValid())
.ok(compareResults.errorMessages());
}).before(async () => {
await createWidget('dxDataGrid', {
dataSource: [
{
field1: '1', field2: 'test1', field3: 'test11',
},
{
field1: '2', field2: 'test1', field3: 'test12',
},
{
field1: '3', field2: 'test2', field3: 'test13',
},
],
width: 700,
renderAsync: false,
templatesRenderAsynchronously: true,
columns: [
{ dataField: 'field1', headerCellTemplate: (_, { column }) => $('<div>').text(column.caption) },
{ dataField: 'field2', groupIndex: 0 },
{ dataField: 'field3', fixed: true },
],
groupPanel: {
visible: true,
},
grouping: {
autoExpandAll: true,
},
});

await makeColumnHeadersViewTemplatesAsync(DATA_GRID_SELECTOR);
});
20 changes: 20 additions & 0 deletions testing/testcafe/tests/dataGrid/helpers/asyncTemplates.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,30 @@ export const makeRowsViewTemplatesAsync = async (selector: string): Promise<void

const rowsView = dataGrid.getView('rowsView');
const originRender = rowsView.renderDelayedTemplates.bind(rowsView);

// eslint-disable-next-line no-underscore-dangle
rowsView._templatesCache = {};
rowsView.renderDelayedTemplates = (changes) => {
setTimeout(() => { originRender(changes); });
};
}, {
dependencies: { selector },
})();
};

export const makeColumnHeadersViewTemplatesAsync = async (selector: string): Promise<void> => {
await ClientFunction(() => {
const dataGrid = ($(selector) as any).dxDataGrid('instance');

const columnHeadersView = dataGrid.getView('columnHeadersView');
const originRender = columnHeadersView.renderDelayedTemplates.bind(columnHeadersView);

// eslint-disable-next-line no-underscore-dangle
columnHeadersView._templatesCache = {};
columnHeadersView.renderDelayedTemplates = (changes) => {
setTimeout(() => { originRender(changes); });
};
}, {
dependencies: { selector },
})();
};