chrome-devtools-frontend/front_end/ui/legacy/ThrottledWidget.ts

Chrome DevTools UI

// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import * as Common from '../../core/common/common.js';

import {VBox} from './Widget.js';

export class ThrottledWidget extends VBox {
  private readonly updateThrottler: Common.Throttler.Throttler;
  private updateWhenVisible: boolean;
  protected lastUpdatePromise: Promise<void> = Promise.resolve();

  constructor(useShadowDom?: boolean, timeout?: number) {
    super(useShadowDom);
    this.updateThrottler = new Common.Throttler.Throttler(timeout === undefined ? 100 : timeout);
    this.updateWhenVisible = false;
  }

  protected doUpdate(): Promise<void> {
    return Promise.resolve();
  }

  update(): void {
    this.updateWhenVisible = !this.isShowing();
    if (this.updateWhenVisible) {
      return;
    }
    this.lastUpdatePromise = this.updateThrottler.schedule(() => {
      if (this.isShowing()) {
        return this.doUpdate();
      }
      this.updateWhenVisible = true;
      return Promise.resolve();
    });
  }

  override get updateComplete(): Promise<boolean> {
    return this.updateThrottler.processCompleted?.then(result => Boolean(result)) || Promise.resolve(false);
  }

  override wasShown(): void {
    super.wasShown();
    if (this.updateWhenVisible) {
      this.update();
    }
  }
}