Skip to content

Commit 9e02f53

Browse files
authored
refactor: add resize-mixin for observing host resizes (#3207)
1 parent f3d95cc commit 9e02f53

20 files changed

Lines changed: 218 additions & 100 deletions

‎packages/avatar-group/src/vaadin-avatar-group.d.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
*/
66
import { AvatarI18n } from '@vaadin/avatar/src/vaadin-avatar.js';
77
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
8+
import { ResizeMixin } from '@vaadin/component-base/src/resize-mixin.js';
89
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
910

1011
export { AvatarI18n };
@@ -62,7 +63,7 @@ export interface AvatarGroupItem {
6263
* - `<vaadin-avatar-group-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
6364
* - `<vaadin-avatar-group-overlay>` - has the same API as [`<vaadin-overlay>`](#/elements/vaadin-overlay).
6465
*/
65-
declare class AvatarGroup extends ElementMixin(ThemableMixin(HTMLElement)) {
66+
declare class AvatarGroup extends ResizeMixin(ElementMixin(ThemableMixin(HTMLElement))) {
6667
readonly _avatars: HTMLElement[];
6768

6869
/**

‎packages/avatar-group/src/vaadin-avatar-group.js‎

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ import { IronA11yAnnouncer } from '@polymer/iron-a11y-announcer/iron-a11y-announ
1111
import { calculateSplices } from '@polymer/polymer/lib/utils/array-splice.js';
1212
import { afterNextRender } from '@polymer/polymer/lib/utils/render-status.js';
1313
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
14-
import { timeOut } from '@vaadin/component-base/src/async.js';
15-
import { Debouncer } from '@vaadin/component-base/src/debounce.js';
1614
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
15+
import { ResizeMixin } from '@vaadin/component-base/src/resize-mixin.js';
1716
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
1817

1918
const MINIMUM_DISPLAYED_AVATARS = 2;
@@ -58,8 +57,9 @@ const MINIMUM_DISPLAYED_AVATARS = 2;
5857
* @extends HTMLElement
5958
* @mixes ElementMixin
6059
* @mixes ThemableMixin
60+
* @mixes ResizeMixin
6161
*/
62-
class AvatarGroup extends ElementMixin(ThemableMixin(PolymerElement)) {
62+
class AvatarGroup extends ResizeMixin(ElementMixin(ThemableMixin(PolymerElement))) {
6363
static get template() {
6464
return html`
6565
<style>
@@ -282,9 +282,6 @@ class AvatarGroup extends ElementMixin(ThemableMixin(PolymerElement)) {
282282

283283
this.__boundSetPosition = this.__setPosition.bind(this);
284284

285-
this.__resizeObserver = new ResizeObserver(() => this._onResize());
286-
this.__resizeObserver.observe(this);
287-
288285
this._overlayElement = this.shadowRoot.querySelector('vaadin-avatar-group-overlay');
289286

290287
afterNextRender(this, () => {
@@ -358,12 +355,13 @@ class AvatarGroup extends ElementMixin(ThemableMixin(PolymerElement)) {
358355
}
359356
}
360357

361-
/** @private */
358+
/**
359+
* @protected
360+
* @override
361+
*/
362362
_onResize() {
363-
this.__debounceResize = Debouncer.debounce(this.__debounceResize, timeOut.after(0), () => {
364-
this.__setItemsInView();
365-
this.__setPosition();
366-
});
363+
this.__setItemsInView();
364+
this.__setPosition();
367365
}
368366

369367
/** @private */
@@ -593,16 +591,6 @@ class AvatarGroup extends ElementMixin(ThemableMixin(PolymerElement)) {
593591
this._overlayElement.style.top = btnRect.bottom + 'px';
594592
}
595593
}
596-
597-
/**
598-
* @deprecated Since Vaadin 23, `notifyResize()` is deprecated. The component uses a
599-
* ResizeObserver internally and doesn't need to be explicitly notified of resizes.
600-
*/
601-
notifyResize() {
602-
console.warn(
603-
`WARNING: Since Vaadin 23, notifyResize() is deprecated. The component uses a ResizeObserver internally and doesn't need to be explicitly notified of resizes.`
604-
);
605-
}
606594
}
607595

608596
customElements.define(AvatarGroup.is, AvatarGroup);

‎packages/avatar-group/test/avatar-group.test.js‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ function onceInvoked(object, functionName) {
2121
* Resolves once the ResizeObserver in AvatarGroup has processed a resize.
2222
*/
2323
async function onceResized(group) {
24-
// Wait for the _onResize function to be invoked by the ResizeObserver
25-
await onceInvoked(group, '_onResize');
26-
// Wait for the debouncer callback in _onResize to invoke __setItemsInView
2724
await onceInvoked(group, '__setItemsInView');
2825
}
2926

@@ -199,15 +196,6 @@ describe('avatar-group', () => {
199196
expect(overflow.abbr).to.equal('+3');
200197
});
201198

202-
it('should warn when calling deprecated notifyResize()', () => {
203-
const stub = sinon.stub(console, 'warn');
204-
group.notifyResize();
205-
stub.restore();
206-
207-
expect(stub.calledOnce).to.be.true;
208-
expect(stub.args[0][0]).to.include('WARNING: Since Vaadin 23, notifyResize() is deprecated.');
209-
});
210-
211199
it('should always show at least two avatars', async () => {
212200
group.set('items', group.items.slice(0, 2));
213201
group.style.width = '50px';

‎packages/board/src/vaadin-board-row.d.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* This program is available under Commercial Vaadin Developer License 4.0, available at https://vaadin.com/license/cvdl-4.0.
55
*/
66
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
7+
import { ResizeMixin } from '@vaadin/component-base/src/resize-mixin.js';
78

89
/**
910
* `<vaadin-board-row>` is a web component that together with `<vaadin-board>` component allows
@@ -39,7 +40,7 @@ import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
3940
* `--vaadin-board-width-small` | Determines the width where mode changes from `small` to `medium` | `600px`
4041
* `--vaadin-board-width-medium` | Determines the width where mode changes from `medium` to `large` | `960px`
4142
*/
42-
declare class BoardRow extends ElementMixin(HTMLElement) {
43+
declare class BoardRow extends ResizeMixin(ElementMixin(HTMLElement)) {
4344
/**
4445
* Redraws the row, if necessary.
4546
*

‎packages/board/src/vaadin-board-row.js‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import { DomIf } from '@polymer/polymer/lib/elements/dom-if.js';
77
import { DomRepeat } from '@polymer/polymer/lib/elements/dom-repeat.js';
88
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
99
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
10+
import { ResizeMixin } from '@vaadin/component-base/src/resize-mixin.js';
1011

1112
const CLASSES = {
1213
SMALL: 'small',
@@ -50,8 +51,9 @@ const CLASSES = {
5051
*
5152
* @extends HTMLElement
5253
* @mixes ElementMixin
54+
* @mixes ResizeMixin
5355
*/
54-
class BoardRow extends ElementMixin(PolymerElement) {
56+
class BoardRow extends ResizeMixin(ElementMixin(PolymerElement)) {
5557
static get template() {
5658
return html`
5759
<style>
@@ -89,11 +91,6 @@ class BoardRow extends ElementMixin(PolymerElement) {
8991
super.ready();
9092

9193
this.$.insertionPoint.addEventListener('slotchange', () => this.redraw());
92-
93-
this.__resizeObserver = new ResizeObserver(() => {
94-
requestAnimationFrame(() => this._onResize());
95-
});
96-
this.__resizeObserver.observe(this);
9794
}
9895

9996
/** @protected */
@@ -220,7 +217,10 @@ class BoardRow extends ElementMixin(PolymerElement) {
220217
this._recalculateFlexBasis(true);
221218
}
222219

223-
/** @private */
220+
/**
221+
* @protected
222+
* @override
223+
*/
224224
_onResize() {
225225
this._recalculateFlexBasis(false);
226226
}
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
/**
2+
* @license
3+
* Copyright (c) 2021 Vaadin Ltd.
4+
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
5+
*/
6+
import { Constructor } from '@open-wc/dedupe-mixin';
7+
8+
/**
9+
* A mixin that uses a ResizeObserver to listen to host size changes.
10+
*/
11+
export declare function ResizeMixin<T extends Constructor<HTMLElement>>(base: T): T & Constructor<ResizeMixinClass>;
12+
13+
export declare class ResizeMixinClass {
14+
/**
15+
* A handler invoked on host resize. By default, it does nothing.
16+
* Override the method to implement your own behavior.
17+
*/
18+
protected _onResize(contentRect: DOMRect): void;
19+
}
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
/**
2+
* @license
3+
* Copyright (c) 2021 Vaadin Ltd.
4+
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
5+
*/
6+
import { dedupingMixin } from '@polymer/polymer/lib/utils/mixin.js';
7+
8+
const observer = new ResizeObserver((entries) => {
9+
setTimeout(() => {
10+
entries.forEach((entry) => {
11+
entry.target._onResize(entry.contentRect);
12+
});
13+
});
14+
});
15+
16+
/**
17+
* A mixin that uses a ResizeObserver to listen to host size changes.
18+
*
19+
* @polymerMixin
20+
*/
21+
export const ResizeMixin = dedupingMixin(
22+
(superclass) =>
23+
class ResizeMixinClass extends superclass {
24+
/** @protected */
25+
connectedCallback() {
26+
super.connectedCallback();
27+
observer.observe(this);
28+
}
29+
30+
/** @protected */
31+
disconnectedCallback() {
32+
super.disconnectedCallback();
33+
observer.unobserve(this);
34+
}
35+
36+
/**
37+
* A handler invoked on host resize. By default, it does nothing.
38+
* Override the method to implement your own behavior.
39+
*
40+
* @protected
41+
*/
42+
_onResize(_contentRect) {
43+
// To be implemented.
44+
}
45+
46+
/**
47+
* @deprecated Since Vaadin 23, `notifyResize()` is deprecated. The component uses a
48+
* ResizeObserver internally and doesn't need to be explicitly notified of resizes.
49+
*/
50+
notifyResize() {
51+
console.warn(
52+
`WARNING: Since Vaadin 23, notifyResize() is deprecated. The component uses a ResizeObserver internally and doesn't need to be explicitly notified of resizes.`
53+
);
54+
}
55+
}
56+
);
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
import { expect } from '@esm-bundle/chai';
2+
import { aTimeout, fixtureSync } from '@vaadin/testing-helpers';
3+
import sinon from 'sinon';
4+
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
5+
import { ResizeMixin } from '../src/resize-mixin.js';
6+
7+
describe('resize-mixin', () => {
8+
let element;
9+
10+
before(() => {
11+
customElements.define(
12+
'resize-mixin-element',
13+
class extends ResizeMixin(PolymerElement) {
14+
static get template() {
15+
return html`
16+
<style>
17+
:host {
18+
display: block;
19+
}
20+
</style>
21+
<div></div>
22+
`;
23+
}
24+
25+
_onResize() {
26+
this.__resolveResize?.();
27+
}
28+
29+
nextResize() {
30+
return new Promise((resolve) => {
31+
this.__resolveResize = resolve;
32+
});
33+
}
34+
}
35+
);
36+
});
37+
38+
beforeEach(async () => {
39+
element = fixtureSync(`<resize-mixin-element></resize-mixin-element>`);
40+
// Wait for the initial resize.
41+
await element.nextResize();
42+
});
43+
44+
it('should notify resize', async () => {
45+
element.style.width = '100px';
46+
await element.nextResize();
47+
});
48+
49+
it('should not notify resize for detached element', async () => {
50+
const spy = sinon.spy(element, '_onResize');
51+
element.remove();
52+
element.style.width = '100px';
53+
await aTimeout(100);
54+
expect(spy.called).to.be.false;
55+
});
56+
57+
describe('console warnings', () => {
58+
beforeEach(() => {
59+
sinon.stub(console, 'warn');
60+
});
61+
62+
afterEach(() => {
63+
console.warn.restore();
64+
});
65+
66+
it('should warn when calling deprecated notifyResize()', () => {
67+
element.notifyResize();
68+
expect(console.warn.calledOnce).to.be.true;
69+
expect(console.warn.args[0][0]).to.include('WARNING: Since Vaadin 23, notifyResize() is deprecated.');
70+
});
71+
});
72+
});

‎packages/form-layout/src/vaadin-form-layout.d.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
66
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
7+
import { ResizeMixin } from '@vaadin/component-base/src/resize-mixin.js';
78
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
89

910
export type FormLayoutLabelsPosition = 'aside' | 'top';
@@ -104,7 +105,7 @@ export type FormLayoutResponsiveStep = {
104105
* ---|---|---
105106
* `--vaadin-form-layout-column-spacing` | Length of the spacing between columns | `2em`
106107
*/
107-
declare class FormLayout extends ElementMixin(ThemableMixin(HTMLElement)) {
108+
declare class FormLayout extends ResizeMixin(ElementMixin(ThemableMixin(HTMLElement))) {
108109
/**
109110
* Allows specifying a responsive behavior with the number of columns
110111
* and the label position depending on the layout width.

‎packages/form-layout/src/vaadin-form-layout.js‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import { FlattenedNodesObserver } from '@polymer/polymer/lib/utils/flattened-nodes-observer.js';
77
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
88
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
9+
import { ResizeMixin } from '@vaadin/component-base/src/resize-mixin.js';
910
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
1011

1112
/**
@@ -101,8 +102,9 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
101102
* @extends HTMLElement
102103
* @mixes ElementMixin
103104
* @mixes ThemableMixin
105+
* @mixes ResizeMixin
104106
*/
105-
class FormLayout extends ElementMixin(ThemableMixin(PolymerElement)) {
107+
class FormLayout extends ResizeMixin(ElementMixin(ThemableMixin(PolymerElement))) {
106108
static get template() {
107109
return html`
108110
<style>
@@ -276,16 +278,10 @@ class FormLayout extends ElementMixin(ThemableMixin(PolymerElement)) {
276278

277279
this.__mutationObserver.disconnect();
278280
this.__childObserver.disconnect();
279-
this.__resizeObserver.disconnect();
280281
}
281282

282283
/** @private */
283284
_observeChildrenColspanChange() {
284-
this.__resizeObserver = new ResizeObserver(() => {
285-
requestAnimationFrame(() => this._selectResponsiveStep());
286-
});
287-
this.__resizeObserver.observe(this);
288-
289285
// Observe changes in form items' `colspan` attribute and update styles
290286
const mutationObserverConfig = { attributes: true };
291287

@@ -542,6 +538,14 @@ class FormLayout extends ElementMixin(ThemableMixin(PolymerElement)) {
542538
}
543539
});
544540
}
541+
542+
/**
543+
* @protected
544+
* @override
545+
*/
546+
_onResize() {
547+
this._selectResponsiveStep();
548+
}
545549
}
546550

547551
customElements.define(FormLayout.is, FormLayout);

0 commit comments

Comments
 (0)