Skip to content

Commit 619051e

Browse files
authored
docs: show a warning when auto-freezing joined columns (#4680)
1 parent 7c1f0c1 commit 619051e

2 files changed

Lines changed: 215 additions & 1 deletion

File tree

‎packages/grid/src/vaadin-grid-column-group.js‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
*/
66
import { FlattenedNodesObserver } from '@polymer/polymer/lib/utils/flattened-nodes-observer.js';
77
import { PolymerElement } from '@polymer/polymer/polymer-element.js';
8-
import { microTask } from '@vaadin/component-base/src/async.js';
8+
import { animationFrame, microTask } from '@vaadin/component-base/src/async.js';
9+
import { Debouncer } from '@vaadin/component-base/src/debounce.js';
910
import { ColumnBaseMixin } from './vaadin-grid-column.js';
1011
import { updateColumnOrders } from './vaadin-grid-helpers.js';
1112

@@ -236,6 +237,42 @@ class GridColumnGroup extends ColumnBaseMixin(PolymerElement) {
236237
this._setFlexGrow(Array.prototype.reduce.call(this._visibleChildColumns, (prev, curr) => prev + curr.flexGrow, 0));
237238
}
238239

240+
/**
241+
* This method is called before the group's frozen value is being propagated to the child columns.
242+
* In case some of the child columns are frozen, while others are not, the non-frozen ones
243+
* will get automatically frozen as well. As this may sometimes be unintended, this method
244+
* shows a warning in the console in such cases.
245+
* @private
246+
*/
247+
__scheduleAutoFreezeWarning(columns, frozenProp) {
248+
if (this._grid) {
249+
// Derive the attribute name from the property name
250+
const frozenAttr = frozenProp.replace(/([A-Z])/g, '-$1').toLowerCase();
251+
252+
// Check if all the columns have the same frozen value
253+
const firstColumnFrozen = columns[0][frozenProp] || columns[0].hasAttribute(frozenAttr);
254+
const allSameFrozen = columns.every((column) => {
255+
return (column[frozenProp] || column.hasAttribute(frozenAttr)) === firstColumnFrozen;
256+
});
257+
258+
if (!allSameFrozen) {
259+
// Some of the child columns are frozen, some are not. Show a warning.
260+
this._grid.__autoFreezeWarningDebouncer = Debouncer.debounce(
261+
this._grid.__autoFreezeWarningDebouncer,
262+
animationFrame,
263+
() => {
264+
console.warn(
265+
`WARNING: Joining ${frozenProp} and non-${frozenProp} Grid columns inside the same column group! ` +
266+
`This will automatically freeze all the joined columns to avoid rendering issues. ` +
267+
`If this was intentional, consider marking each joined column explicitly as ${frozenProp}. ` +
268+
`Otherwise, exclude the ${frozenProp} columns from the joined group.`,
269+
);
270+
},
271+
);
272+
}
273+
}
274+
}
275+
239276
/** @private */
240277
_groupFrozenChanged(frozen, rootColumns) {
241278
if (rootColumns === undefined || frozen === undefined) {
@@ -244,6 +281,8 @@ class GridColumnGroup extends ColumnBaseMixin(PolymerElement) {
244281

245282
// Don’t propagate the default `false` value.
246283
if (frozen !== false) {
284+
this.__scheduleAutoFreezeWarning(rootColumns, 'frozen');
285+
247286
Array.from(rootColumns).forEach((col) => {
248287
col.frozen = frozen;
249288
});
@@ -258,6 +297,8 @@ class GridColumnGroup extends ColumnBaseMixin(PolymerElement) {
258297

259298
// Don’t propagate the default `false` value.
260299
if (frozenToEnd !== false) {
300+
this.__scheduleAutoFreezeWarning(rootColumns, 'frozenToEnd');
301+
261302
Array.from(rootColumns).forEach((col) => {
262303
col.frozenToEnd = frozenToEnd;
263304
});

‎packages/grid/test/column-groups.test.js‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { expect } from '@esm-bundle/chai';
22
import { fixtureSync, nextFrame, nextRender } from '@vaadin/testing-helpers';
3+
import sinon from 'sinon';
34
import '@vaadin/polymer-legacy-adapter/template-renderer.js';
45
import '../vaadin-grid.js';
56
import '../vaadin-grid-column-group.js';
@@ -132,6 +133,14 @@ const fixtures = {
132133
`,
133134
};
134135

136+
beforeEach(() => {
137+
sinon.stub(console, 'warn');
138+
});
139+
140+
afterEach(() => {
141+
console.warn.restore();
142+
});
143+
135144
describe('column groups', () => {
136145
let grid, header, body, footer, headerRows, footerRows, bodyRows;
137146

@@ -557,4 +566,168 @@ describe('column groups', () => {
557566
expect(col99._order).to.be.lessThan(col100._order);
558567
});
559568
});
569+
570+
describe('warnings', () => {
571+
['frozen', 'frozen-to-end'].forEach((frozenAttr) => {
572+
describe(frozenAttr, () => {
573+
it('should not warn when grouping frozen only columns', async () => {
574+
fixtureSync(`
575+
<vaadin-grid>
576+
<vaadin-grid-column-group>
577+
<vaadin-grid-column ${frozenAttr}></vaadin-grid-column>
578+
<vaadin-grid-column ${frozenAttr}></vaadin-grid-column>
579+
</vaadin-grid-column-group>
580+
581+
<vaadin-grid-column></vaadin-grid-column>
582+
</vaadin-grid>
583+
`);
584+
585+
await nextFrame();
586+
expect(console.warn.called).to.be.false;
587+
});
588+
589+
it('should not warn when freezing a root level group', async () => {
590+
fixtureSync(`
591+
<vaadin-grid>
592+
<vaadin-grid-column-group ${frozenAttr}>
593+
<vaadin-grid-column></vaadin-grid-column>
594+
<vaadin-grid-column></vaadin-grid-column>
595+
</vaadin-grid-column-group>
596+
597+
<vaadin-grid-column></vaadin-grid-column>
598+
</vaadin-grid>
599+
`);
600+
601+
await nextFrame();
602+
expect(console.warn.called).to.be.false;
603+
});
604+
605+
it('should not warn when freezing a root level column', async () => {
606+
fixtureSync(`
607+
<vaadin-grid>
608+
<vaadin-grid-column-group>
609+
<vaadin-grid-column></vaadin-grid-column>
610+
<vaadin-grid-column></vaadin-grid-column>
611+
</vaadin-grid-column-group>
612+
613+
<vaadin-grid-column ${frozenAttr}></vaadin-grid-column>
614+
</vaadin-grid>
615+
`);
616+
617+
await nextFrame();
618+
expect(console.warn.called).to.be.false;
619+
});
620+
621+
it('should not warn when grouping a frozen column with unimported frozen column', async () => {
622+
expect(customElements.get('vaadin-grid-selection-column')).to.be.undefined;
623+
624+
fixtureSync(`
625+
<vaadin-grid>
626+
<vaadin-grid-column-group>
627+
<vaadin-grid-selection-column ${frozenAttr}></vaadin-grid-selection-column>
628+
<vaadin-grid-column ${frozenAttr}></vaadin-grid-column>
629+
</vaadin-grid-column-group>
630+
631+
<vaadin-grid-column></vaadin-grid-column>
632+
</vaadin-grid>
633+
`);
634+
635+
await nextFrame();
636+
expect(console.warn.called).to.be.false;
637+
});
638+
639+
it('should warn when grouping frozen and non-frozen columns', async () => {
640+
fixtureSync(`
641+
<vaadin-grid>
642+
<vaadin-grid-column-group>
643+
<vaadin-grid-column ${frozenAttr}></vaadin-grid-column>
644+
<vaadin-grid-column></vaadin-grid-column>
645+
</vaadin-grid-column-group>
646+
647+
<vaadin-grid-column></vaadin-grid-column>
648+
</vaadin-grid>
649+
`);
650+
651+
await nextFrame();
652+
expect(console.warn.calledOnce).to.be.true;
653+
});
654+
655+
it('should warn when grouping a frozen column with an unimported column', async () => {
656+
expect(customElements.get('vaadin-grid-selection-column')).to.be.undefined;
657+
658+
// Testing the other way around (frozen unimported column with non-frozen column)
659+
// is not feasible because an unimported column never notifies its parent group
660+
// of its frozen state. A warning about the missing import is logged instead.
661+
fixtureSync(`
662+
<vaadin-grid>
663+
<vaadin-grid-column-group>
664+
<vaadin-grid-selection-column></vaadin-grid-selection-column>
665+
<vaadin-grid-column ${frozenAttr}></vaadin-grid-column>
666+
</vaadin-grid-column-group>
667+
668+
<vaadin-grid-column></vaadin-grid-column>
669+
</vaadin-grid>
670+
`);
671+
672+
await nextFrame();
673+
expect(console.warn.calledOnce).to.be.true;
674+
});
675+
676+
it('should warn when grouping frozen group and non-frozen column', async () => {
677+
fixtureSync(`
678+
<vaadin-grid>
679+
<vaadin-grid-column-group>
680+
<vaadin-grid-column-group ${frozenAttr}>
681+
<vaadin-grid-column></vaadin-grid-column>
682+
<vaadin-grid-column></vaadin-grid-column>
683+
</vaadin-grid-column-group>
684+
685+
<vaadin-grid-column></vaadin-grid-column>
686+
</vaadin-grid-column-group>
687+
</vaadin-grid>
688+
`);
689+
690+
await nextFrame();
691+
expect(console.warn.calledOnce).to.be.true;
692+
});
693+
694+
it('should not warn when grouping frozen group and frozen column', async () => {
695+
fixtureSync(`
696+
<vaadin-grid>
697+
<vaadin-grid-column-group>
698+
<vaadin-grid-column-group ${frozenAttr}>
699+
<vaadin-grid-column></vaadin-grid-column>
700+
<vaadin-grid-column></vaadin-grid-column>
701+
</vaadin-grid-column-group>
702+
703+
<vaadin-grid-column ${frozenAttr}></vaadin-grid-column>
704+
</vaadin-grid-column-group>
705+
</vaadin-grid>
706+
`);
707+
708+
await nextFrame();
709+
expect(console.warn.called).to.be.false;
710+
});
711+
712+
it('should only warn once', async () => {
713+
fixtureSync(`
714+
<vaadin-grid>
715+
<vaadin-grid-column-group>
716+
<vaadin-grid-column ${frozenAttr}></vaadin-grid-column>
717+
<vaadin-grid-column></vaadin-grid-column>
718+
</vaadin-grid-column-group>
719+
720+
<vaadin-grid-column-group>
721+
<vaadin-grid-column ${frozenAttr}></vaadin-grid-column>
722+
<vaadin-grid-column></vaadin-grid-column>
723+
</vaadin-grid-column-group>
724+
</vaadin-grid>
725+
`);
726+
727+
await nextFrame();
728+
expect(console.warn.calledOnce).to.be.true;
729+
});
730+
});
731+
});
732+
});
560733
});

0 commit comments

Comments
 (0)