Skip to content

Commit c66724e

Browse files
authored
refactor: move controllers logic to ControllerMixin (#3069)
1 parent 0c7f682 commit c66724e

42 files changed

Lines changed: 316 additions & 162 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎packages/checkbox/src/vaadin-checkbox.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 { ActiveMixin } from '@vaadin/component-base/src/active-mixin.js';
7+
import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
78
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
89
import { CheckedMixin } from '@vaadin/field-base/src/checked-mixin.js';
910
import { DelegateFocusMixin } from '@vaadin/field-base/src/delegate-focus-mixin.js';
@@ -61,7 +62,7 @@ export interface CheckboxEventMap extends HTMLElementEventMap, CheckboxCustomEve
6162
* @fires {CustomEvent} indeterminate-changed - Fired when the `indeterminate` property changes.
6263
*/
6364
declare class Checkbox extends SlotLabelMixin(
64-
CheckedMixin(DelegateFocusMixin(ActiveMixin(ElementMixin(ThemableMixin(HTMLElement)))))
65+
CheckedMixin(DelegateFocusMixin(ActiveMixin(ElementMixin(ThemableMixin(ControllerMixin(HTMLElement))))))
6566
) {
6667
/**
6768
* True if the checkbox is in the indeterminate state which means

‎packages/checkbox/src/vaadin-checkbox.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
*/
66
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
77
import { ActiveMixin } from '@vaadin/component-base/src/active-mixin.js';
8+
import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
89
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
910
import { AriaLabelController } from '@vaadin/field-base/src/aria-label-controller.js';
1011
import { CheckedMixin } from '@vaadin/field-base/src/checked-mixin.js';
@@ -46,6 +47,7 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
4647
* @fires {CustomEvent} indeterminate-changed - Fired when the `indeterminate` property changes.
4748
*
4849
* @extends HTMLElement
50+
* @mixes ControllerMixin
4951
* @mixes ThemableMixin
5052
* @mixes ElementMixin
5153
* @mixes ActiveMixin
@@ -54,7 +56,7 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
5456
* @mixes SlotLabelMixin
5557
*/
5658
class Checkbox extends SlotLabelMixin(
57-
CheckedMixin(DelegateFocusMixin(ActiveMixin(ElementMixin(ThemableMixin(PolymerElement)))))
59+
CheckedMixin(DelegateFocusMixin(ActiveMixin(ElementMixin(ThemableMixin(ControllerMixin(PolymerElement))))))
5860
) {
5961
static get is() {
6062
return 'vaadin-checkbox';

‎packages/checkbox/test/typings/checkbox.types.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import '../../vaadin-checkbox.js';
22
import { ActiveMixinClass } from '@vaadin/component-base/src/active-mixin.js';
3+
import { ControllerMixinClass } from '@vaadin/component-base/src/controller-mixin.js';
34
import { DisabledMixinClass } from '@vaadin/component-base/src/disabled-mixin.js';
45
import { ElementMixinClass } from '@vaadin/component-base/src/element-mixin.js';
56
import { FocusMixinClass } from '@vaadin/component-base/src/focus-mixin.js';
@@ -24,6 +25,7 @@ assertType<string>(checkbox.name);
2425
assertType<string>(checkbox.value);
2526

2627
// Mixins
28+
assertType<ControllerMixinClass>(checkbox);
2729
assertType<ActiveMixinClass>(checkbox);
2830
assertType<DisabledMixinClass>(checkbox);
2931
assertType<ElementMixinClass>(checkbox);

‎packages/combo-box/src/vaadin-combo-box.d.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
* Copyright (c) 2021 Vaadin Ltd.
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
6+
import { ControllerMixinClass } from '@vaadin/component-base/src/controller-mixin.js';
67
import { ElementMixinClass } from '@vaadin/component-base/src/element-mixin.js';
78
import { InputControlMixinClass } from '@vaadin/field-base/src/input-control-mixin.js';
89
import { PatternMixinClass } from '@vaadin/field-base/src/pattern-mixin.js';
@@ -208,7 +209,8 @@ interface ComboBox<TItem = ComboBoxDefaultItem>
208209
PatternMixinClass,
209210
InputControlMixinClass,
210211
ThemableMixinClass,
211-
ElementMixinClass {}
212+
ElementMixinClass,
213+
ControllerMixinClass {}
212214

213215
declare global {
214216
interface HTMLElementTagNameMap {

‎packages/combo-box/src/vaadin-combo-box.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import '@vaadin/input-container/src/vaadin-input-container.js';
77
import './vaadin-combo-box-dropdown.js';
88
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
9+
import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
910
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
1011
import { AriaLabelController } from '@vaadin/field-base/src/aria-label-controller.js';
1112
import { InputControlMixin } from '@vaadin/field-base/src/input-control-mixin.js';
@@ -146,6 +147,7 @@ registerStyles('vaadin-combo-box', inputFieldShared, { moduleId: 'vaadin-combo-b
146147
* @fires {CustomEvent} value-changed - Fired when the `value` property changes.
147148
*
148149
* @extends HTMLElement
150+
* @mixes ControllerMixin
149151
* @mixes ElementMixin
150152
* @mixes ThemableMixin
151153
* @mixes InputControlMixin
@@ -154,7 +156,7 @@ registerStyles('vaadin-combo-box', inputFieldShared, { moduleId: 'vaadin-combo-b
154156
* @mixes ComboBoxMixin
155157
*/
156158
class ComboBox extends ComboBoxDataProviderMixin(
157-
ComboBoxMixin(PatternMixin(InputControlMixin(ThemableMixin(ElementMixin(PolymerElement)))))
159+
ComboBoxMixin(PatternMixin(InputControlMixin(ThemableMixin(ElementMixin(ControllerMixin(PolymerElement))))))
158160
) {
159161
static get is() {
160162
return 'vaadin-combo-box';

‎packages/combo-box/test/typings/combo-box.types.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { ControllerMixinClass } from '@vaadin/component-base/src/controller-mixin.js';
12
import { ElementMixinClass } from '@vaadin/component-base/src/element-mixin.js';
23
import { ThemableMixinClass } from '@vaadin/vaadin-themable-mixin';
34
import { ComboBoxDataProviderMixinClass } from '../../src/vaadin-combo-box-data-provider-mixin';
@@ -32,6 +33,7 @@ const genericComboBox = document.createElement('vaadin-combo-box');
3233

3334
const narrowedComboBox = genericComboBox as ComboBox<TestComboBoxItem>;
3435
assertType<ComboBox>(narrowedComboBox);
36+
assertType<ControllerMixinClass>(narrowedComboBox);
3537
assertType<ElementMixinClass>(narrowedComboBox);
3638
assertType<ComboBoxDataProviderMixinClass<TestComboBoxItem>>(narrowedComboBox);
3739
assertType<ComboBoxMixinClass<TestComboBoxItem>>(narrowedComboBox);

‎packages/component-base/index.d.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
export { ActiveMixin } from './src/active-mixin.js';
2+
export { ControllerMixin } from './src/controller-mixin.js';
23
export { DirMixin } from './src/dir-mixin.js';
34
export { DisabledMixin } from './src/disabled-mixin.js';
45
export { ElementMixin } from './src/element-mixin.js';

‎packages/component-base/index.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
export { ActiveMixin } from './src/active-mixin.js';
2+
export { ControllerMixin } from './src/controller-mixin.js';
23
export { DirMixin } from './src/dir-mixin.js';
34
export { DisabledMixin } from './src/disabled-mixin.js';
45
export { ElementMixin } from './src/element-mixin.js';
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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+
import { ReactiveController, ReactiveControllerHost } from 'lit';
8+
9+
/**
10+
* A mixin for connecting controllers to the element.
11+
*/
12+
export declare function ControllerMixin<T extends Constructor<HTMLElement>>(
13+
superclass: T
14+
): T & Constructor<ControllerMixinClass>;
15+
16+
export declare class ControllerMixinClass
17+
implements Pick<ReactiveControllerHost, 'addController' | 'removeController'>
18+
{
19+
/**
20+
* Registers a controller to participate in the element update cycle.
21+
*/
22+
addController(controller: ReactiveController): void;
23+
24+
/**
25+
* Removes a controller from the element.
26+
*/
27+
removeController(controller: ReactiveController): void;
28+
}
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
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+
/**
9+
* A mixin for connecting controllers to the element.
10+
*
11+
* @polymerMixin
12+
*/
13+
export const ControllerMixin = dedupingMixin(
14+
(superClass) =>
15+
class ControllerMixinClass extends superClass {
16+
constructor() {
17+
super();
18+
19+
/**
20+
* @type {Set<import('lit').ReactiveController>}
21+
*/
22+
this.__controllers = new Set();
23+
}
24+
25+
/** @protected */
26+
connectedCallback() {
27+
super.connectedCallback();
28+
29+
this.__controllers.forEach((c) => {
30+
c.hostConnected && c.hostConnected();
31+
});
32+
}
33+
34+
/** @protected */
35+
disconnectedCallback() {
36+
super.disconnectedCallback();
37+
38+
this.__controllers.forEach((c) => {
39+
c.hostDisconnected && c.hostDisconnected();
40+
});
41+
}
42+
43+
/**
44+
* Registers a controller to participate in the element update cycle.
45+
*
46+
* @param {import('lit').ReactiveController} controller
47+
* @protected
48+
*/
49+
addController(controller) {
50+
this.__controllers.add(controller);
51+
// Call hostConnected if a controller is added after the element is attached.
52+
if (this.$ !== undefined && this.isConnected && controller.hostConnected) {
53+
controller.hostConnected();
54+
}
55+
}
56+
57+
/**
58+
* Removes a controller from the element.
59+
*
60+
* @param {import('lit').ReactiveController} controller
61+
* @protected
62+
*/
63+
removeController(controller) {
64+
this.__controllers.delete(controller);
65+
}
66+
}
67+
);

0 commit comments

Comments
 (0)