Selaa lähdekoodia

Merge pull request #945 from ivanov/quick-doc

Add documentation about widget.id requirement
Steven Silvester 8 vuotta sitten
vanhempi
commit
8470fabbda
1 muutettua tiedostoa jossa 12 lisäystä ja 0 poistoa
  1. 12 0
      src/application/shell.ts

+ 12 - 0
src/application/shell.ts

@@ -160,6 +160,9 @@ class ApplicationShell extends Widget {
 
   /**
    * Add a widget to the top content area.
+   *
+   * #### Notes
+   * Widgets must have a unique `id` property, which will be used as the DOM id.
    */
   addToTopArea(widget: Widget, options: ISideAreaOptions = {}): void {
     if (!widget.id) {
@@ -172,6 +175,9 @@ class ApplicationShell extends Widget {
 
   /**
    * Add a widget to the left content area.
+   *
+   * #### Notes
+   * Widgets must have a unique `id` property, which will be used as the DOM id.
    */
   addToLeftArea(widget: Widget, options: ISideAreaOptions = {}): void {
     if (!widget.id) {
@@ -184,6 +190,9 @@ class ApplicationShell extends Widget {
 
   /**
    * Add a widget to the right content area.
+   *
+   * #### Notes
+   * Widgets must have a unique `id` property, which will be used as the DOM id.
    */
   addToRightArea(widget: Widget, options: ISideAreaOptions = {}): void {
     if (!widget.id) {
@@ -196,6 +205,9 @@ class ApplicationShell extends Widget {
 
   /**
    * Add a widget to the main content area.
+   *
+   * #### Notes
+   * Widgets must have a unique `id` property, which will be used as the DOM id.
    */
   addToMainArea(widget: Widget): void {
     // TODO