Skip to content

Commit

Permalink
refactor: remove async modifier from willUpdate (#3223)
Browse files Browse the repository at this point in the history
(cherry picked from commit 30292e9)
  • Loading branch information
jeripeierSBB committed Nov 21, 2024
1 parent e36be2d commit e8d2b42
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 21 deletions.
2 changes: 1 addition & 1 deletion src/elements/checkbox/checkbox-panel/checkbox-panel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class SbbCheckboxPanelElement extends SbbPanelMixin(
{ bubbles: true },
);

protected override async willUpdate(changedProperties: PropertyValues<this>): Promise<void> {
protected override willUpdate(changedProperties: PropertyValues<this>): void {
super.willUpdate(changedProperties);

if (changedProperties.has('checked')) {
Expand Down
2 changes: 1 addition & 1 deletion src/elements/checkbox/common/checkbox-common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export const SbbCheckboxCommonElementMixin = <T extends Constructor<LitElement>>
['disabled', 'required', 'size'].forEach((p) => this.requestUpdate(p));
}

protected override async willUpdate(changedProperties: PropertyValues<this>): Promise<void> {
protected override willUpdate(changedProperties: PropertyValues<this>): void {
super.willUpdate(changedProperties);

if (changedProperties.has('checked') || changedProperties.has('indeterminate')) {
Expand Down
4 changes: 2 additions & 2 deletions src/elements/clock/clock.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,11 @@ class SbbClockElement extends LitElement {
/** Callback function for minutes hand. */
private _moveMinutesHandFn = (): void => this._moveMinutesHand();

protected override async willUpdate(changedProperties: PropertyValues<this>): Promise<void> {
protected override willUpdate(changedProperties: PropertyValues<this>): void {
super.willUpdate(changedProperties);

if (!isServer && changedProperties.has('now')) {
await this._startOrConfigureClock();
this._startOrConfigureClock();
}
}

Expand Down
2 changes: 1 addition & 1 deletion src/elements/core/mixins/required-mixin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export const SbbRequiredMixin = <
}
private _required: boolean = false;

protected override async willUpdate(changedProperties: PropertyValues<this>): Promise<void> {
protected override willUpdate(changedProperties: PropertyValues<this>): void {
super.willUpdate(changedProperties);

if (changedProperties.has('required')) {
Expand Down
1 change: 0 additions & 1 deletion src/elements/datepicker/datepicker/datepicker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,6 @@ export function isDateAvailable<T = Date>(
min: string | number | null | undefined,
max: string | number | null | undefined,
): boolean {
// TODO: Get date adapter from config
const dateAdapter: DateAdapter<T> = readConfig().datetime?.dateAdapter ?? defaultDateAdapter;
const dateMin = dateAdapter.deserialize(min);
const dateMax = dateAdapter.deserialize(max);
Expand Down
6 changes: 3 additions & 3 deletions src/elements/flip-card/flip-card-summary/flip-card-summary.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ class SbbFlipCardSummaryElement extends LitElement {
@property({ attribute: 'image-alignment', reflect: true })
public accessor imageAlignment: SbbFlipCardImageAlignment = 'after';

protected override willUpdate(_changedProperties: PropertyValues): void {
super.willUpdate(_changedProperties);
protected override willUpdate(changedProperties: PropertyValues<this>): void {
super.willUpdate(changedProperties);

if (_changedProperties.has('imageAlignment')) {
if (changedProperties.has('imageAlignment')) {
this.closest?.('sbb-flip-card')?.setAttribute('data-image-alignment', this.imageAlignment);
}
}
Expand Down
10 changes: 2 additions & 8 deletions src/elements/icon/icon.snapshot.spec.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import { aTimeout, expect } from '@open-wc/testing';
import { expect } from '@open-wc/testing';
import { html } from 'lit/static-html.js';

import { mergeConfig, type SbbIconConfig } from '../core/config.js';
import { readConfig } from '../core/config.js';
import { mergeConfig, readConfig, type SbbIconConfig } from '../core/config.js';
import { fixture, testA11yTreeSnapshot } from '../core/testing/private.js';
import { waitForLitRender } from '../core/testing.js';

Expand Down Expand Up @@ -107,11 +106,6 @@ describe(`sbb-icon`, () => {
`);

icon.setAttribute('name', 'pie-medium');
// TODO: Optimize with https://lit.dev/docs/elements/lifecycle/#getUpdateComplete
// The update of the internal state happens a tick after the updateComplete down below completes.
// We could change this by implementing a getUpdateComplete which starts with a name change
// and completes with the new icon loaded.
await aTimeout(0);
await waitForLitRender(icon);

expect(icon).dom.to.be.equal(`
Expand Down
2 changes: 1 addition & 1 deletion src/elements/icon/icon.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { forceType, omitEmptyConverter } from '../core/decorators.js';
import { SbbIconBase } from './icon-base.js';

/**
* It displays an icon loaded from a registered namespace.
* Displays an icon loaded from a registered namespace.
*/
export
@customElement('sbb-icon')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ class SbbRadioButtonPanelElement extends SbbPanelMixin(
@getOverride((i, v) => (i.group?.size ? (i.group.size === 'xs' ? 's' : i.group.size) : v))
public accessor size: SbbPanelSize = 'm';

protected override async willUpdate(changedProperties: PropertyValues<this>): Promise<void> {
protected override willUpdate(changedProperties: PropertyValues<this>): void {
super.willUpdate(changedProperties);

if (changedProperties.has('checked')) {
Expand Down
2 changes: 1 addition & 1 deletion src/elements/table/table-wrapper/table-wrapper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class SbbTableWrapperElement extends SbbNegativeMixin(LitElement) {
});
private _tableWrapper!: HTMLElement;

protected override firstUpdated(changedProperties: PropertyValues): void {
protected override firstUpdated(changedProperties: PropertyValues<this>): void {
super.firstUpdated(changedProperties);
this._tableWrapper = this.shadowRoot!.querySelector<HTMLElement>('.sbb-table-wrapper')!;
this._resizeObserver.observe(this._tableWrapper);
Expand Down
2 changes: 1 addition & 1 deletion src/elements/toggle-check/toggle-check.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ class SbbToggleCheckElement extends SbbFormAssociatedCheckboxMixin(SbbIconNameMi
@property({ attribute: 'label-position', reflect: true })
public accessor labelPosition: 'before' | 'after' = 'after';

protected override async willUpdate(changedProperties: PropertyValues<this>): Promise<void> {
protected override willUpdate(changedProperties: PropertyValues<this>): void {
super.willUpdate(changedProperties);

if (changedProperties.has('checked')) {
Expand Down

0 comments on commit e8d2b42

Please sign in to comment.