Browse Source

Change the main area widget reveal promise to ‘revealed’

Jason Grout 7 năm trước cách đây
mục cha
commit
414fd43cb6

+ 6 - 6
packages/apputils/src/mainareawidget.ts

@@ -71,7 +71,7 @@ class MainAreaWidget<T extends Widget = Widget> extends Widget {
       layout.addWidget(spinner);
       // Make sure the ready promise is a Promise<void> to avoid leaking any
       // results.
-      this._reveal = options.reveal.then(() => {
+      this._revealed = options.reveal.then(() => {
         this._isRevealed = true;
         const active = document.activeElement === spinner.node;
         spinner.dispose();
@@ -96,7 +96,7 @@ class MainAreaWidget<T extends Widget = Widget> extends Widget {
       spinner.dispose();
       layout.addWidget(content);
       this._isRevealed = true;
-      this._reveal = Promise.resolve(undefined);
+      this._revealed = Promise.resolve(undefined);
     }
   }
 
@@ -118,10 +118,10 @@ class MainAreaWidget<T extends Widget = Widget> extends Widget {
   }
 
   /**
-   * A promise that resolves when the widget is ready to be revealed.
+   * A promise that resolves when the widget is revealed.
    */
-  get reveal(): Promise<void> {
-    return this._reveal;
+  get revealed(): Promise<void> {
+    return this._revealed;
   }
 
   /**
@@ -240,7 +240,7 @@ class MainAreaWidget<T extends Widget = Widget> extends Widget {
   private _spinner = new Spinner();
 
   private _isRevealed = false;
-  private _reveal: Promise<void>;
+  private _revealed: Promise<void>;
 }
 
 

+ 5 - 5
packages/csvviewer/src/widget.ts

@@ -72,7 +72,7 @@ class CSVViewer extends Widget {
 
     this._context.ready.then(() => {
       this._updateGrid();
-      this._reveal.resolve(undefined);
+      this._revealed.resolve(undefined);
       // Throttle the rendering rate of the widget.
       this._monitor = new ActivityMonitor({
         signal: context.model.contentChanged,
@@ -92,8 +92,8 @@ class CSVViewer extends Widget {
   /**
    * A promise that resolves when the csv viewer is ready to be revealed.
    */
-  get reveal() {
-    return this._reveal.promise;
+  get revealed() {
+    return this._revealed.promise;
   }
 
   /**
@@ -145,7 +145,7 @@ class CSVViewer extends Widget {
   private _grid: DataGrid;
   private _monitor: ActivityMonitor<any, any> | null = null;
   private _delimiter = ',';
-  private _reveal = new PromiseDelegate<void>();
+  private _revealed = new PromiseDelegate<void>();
 }
 
 
@@ -171,7 +171,7 @@ class CSVDocumentWidget extends DocumentWidget<CSVViewer> {
   constructor(options: CSVDocumentWidget.IOptions) {
     let {content, context, delimiter, reveal, ...other} = options;
     content = content || Private.createContent(context);
-    reveal = Promise.all([reveal, content.reveal]);
+    reveal = Promise.all([reveal, content.revealed]);
     super({content, context, reveal, ...other});
 
     if (delimiter) {

+ 2 - 2
packages/docregistry/src/registry.ts

@@ -1202,9 +1202,9 @@ interface IDocumentWidget<T extends Widget = Widget, U extends DocumentRegistry.
   readonly content: T;
 
   /**
-   * A promise resolving when the content widget is ready to be revealed.
+   * A promise resolving after the content widget is revealed.
    */
-  readonly reveal: Promise<void>;
+  readonly revealed: Promise<void>;
 
   /**
    * The context associated with the document.

+ 5 - 5
tests/test-docregistry/src/default.spec.ts

@@ -601,7 +601,7 @@ describe('docregistry/default', () => {
 
     });
 
-    describe('#reveal', () => {
+    describe('#revealed', () => {
       beforeEach(setup);
 
       it('should resolve after the reveal and context ready promises', async () => {
@@ -612,12 +612,12 @@ describe('docregistry/default', () => {
         expect(widget.isRevealed).to.be(false);
 
         // Our promise should resolve before the widget reveal promise.
-        expect(await Promise.race([widget.reveal, reveal])).to.be(x);
+        expect(await Promise.race([widget.revealed, reveal])).to.be(x);
         // The context ready promise should also resolve first.
         context.initialize(true);
-        expect(await Promise.race([widget.reveal, contextReady])).to.eql([undefined, x]);
-        // The widget.reveal promise should finally resolve.
-        expect(await widget.reveal).to.be(undefined);
+        expect(await Promise.race([widget.revealed, contextReady])).to.eql([undefined, x]);
+        // The widget.revealed promise should finally resolve.
+        expect(await widget.revealed).to.be(undefined);
       });
 
     });