@skyux/core 5.6.2 → 6.0.0-beta.0

package/documentation.json

@@ -723,7 +723,7 @@
               "isOptional": true
             },
             "comment": {
-              "shortText": "Indicates whether to shorten numbers to rounded numbers and abbreviation characters\nsuch as K for thousands, M for millions, B for billions, and T for trillion."
+              "shortText": "Indicates whether to shorten numbers to rounded numbers and abbreviation characters\nsuch as K for thousands, M for millions, B for billions, and T for trillions."
             },
             "sources": [
               {
@@ -1442,7 +1442,7 @@
         ]
       },
       {
-        "id": 549,
+        "id": 552,
         "name": "SkyAppTitleService",
         "kind": 128,
         "kindString": "Class",
@@ -1466,7 +1466,7 @@
         ],
         "children": [
           {
-            "id": 550,
+            "id": 553,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
@@ -1480,14 +1480,14 @@
             ],
             "signatures": [
               {
-                "id": 551,
+                "id": 554,
                 "name": "new SkyAppTitleService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 552,
+                    "id": 555,
                     "name": "title",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -1502,14 +1502,14 @@
                 ],
                 "type": {
                   "type": "reference",
-                  "id": 549,
+                  "id": 552,
                   "name": "SkyAppTitleService"
                 }
               }
             ]
           },
           {
-            "id": 553,
+            "id": 556,
             "name": "setTitle",
             "kind": 2048,
             "kindString": "Method",
@@ -1525,7 +1525,7 @@
             ],
             "signatures": [
               {
-                "id": 554,
+                "id": 557,
                 "name": "setTitle",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -1535,7 +1535,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 555,
+                    "id": 558,
                     "name": "args",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -1545,7 +1545,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "id": 547,
+                      "id": 550,
                       "name": "SkyAppSetTitleArgs"
                     }
                   }
@@ -1563,14 +1563,14 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              550
+              553
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              553
+              556
             ]
           }
         ],
@@ -1583,7 +1583,7 @@
         ]
       },
       {
-        "id": 600,
+        "id": 603,
         "name": "SkyAppWindowRef",
         "kind": 128,
         "kindString": "Class",
@@ -1607,7 +1607,7 @@
         ],
         "children": [
           {
-            "id": 603,
+            "id": 606,
             "name": "nativeWindow",
             "kind": 262144,
             "kindString": "Accessor",
@@ -1623,7 +1623,7 @@
             ],
             "getSignature": [
               {
-                "id": 604,
+                "id": 607,
                 "name": "nativeWindow",
                 "kind": 524288,
                 "kindString": "Get signature",
@@ -1644,14 +1644,14 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              601
+              604
             ]
           },
           {
             "title": "Accessors",
             "kind": 262144,
             "children": [
-              603
+              606
             ]
           }
         ],
@@ -2624,7 +2624,7 @@
               "name": "NgModule"
             },
             "arguments": {
-              "obj": "{\n  imports: [CommonModule],\n  declarations: [SkyDockComponent],\n  entryComponents: [SkyDockComponent],\n  providers: [MutationObserverService],\n}"
+              "obj": "{\n  imports: [CommonModule],\n  declarations: [SkyDockComponent],\n  providers: [MutationObserverService],\n}"
             }
           }
         ],
@@ -2641,7 +2641,7 @@
         "sources": [
           {
             "fileName": "projects/core/src/modules/dock/dock.module.ts",
-            "line": 14,
+            "line": 13,
             "character": 13
           }
         ]
@@ -2665,13 +2665,13 @@
               "name": "Injectable"
             },
             "arguments": {
-              "options": "{\n  providedIn: 'root',\n}"
+              "options": "{\n  // Must be 'any' so that the dock component is created in the context of its module's injector.\n  // If set to 'root', the component's dependency injections would only be derived from the root\n  // injector and may loose context if the dock was opened from within a lazy-loaded module.\n  providedIn: 'any',\n}"
             }
           }
         ],
         "children": [
           {
-            "id": 249,
+            "id": 251,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
@@ -2679,20 +2679,20 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/dock/dock.service.ts",
-                "line": 34,
+                "line": 36,
                 "character": 2
               }
             ],
             "signatures": [
               {
-                "id": 250,
+                "id": 252,
                 "name": "new SkyDockService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 251,
+                    "id": 253,
                     "name": "dynamicComponentService",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -2713,7 +2713,7 @@
             ]
           },
           {
-            "id": 252,
+            "id": 254,
             "name": "items",
             "kind": 262144,
             "kindString": "Accessor",
@@ -2723,13 +2723,13 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/dock/dock.service.ts",
-                "line": 24,
+                "line": 30,
                 "character": 13
               }
             ],
             "getSignature": [
               {
-                "id": 253,
+                "id": 255,
                 "name": "items",
                 "kind": 524288,
                 "kindString": "Get signature",
@@ -2765,7 +2765,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/dock/dock.service.ts",
-                "line": 41,
+                "line": 43,
                 "character": 9
               }
             ],
@@ -2856,7 +2856,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/dock/dock.service.ts",
-                "line": 76,
+                "line": 81,
                 "character": 9
               }
             ],
@@ -2900,14 +2900,14 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              249
+              251
             ]
           },
           {
             "title": "Accessors",
             "kind": 262144,
             "children": [
-              252
+              254
             ]
           },
           {
@@ -2922,7 +2922,7 @@
         "sources": [
           {
             "fileName": "projects/core/src/modules/dock/dock.service.ts",
-            "line": 20,
+            "line": 23,
             "character": 13
           }
         ]
@@ -3066,7 +3066,7 @@
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 600,
+                      "id": 603,
                       "name": "SkyAppWindowRef"
                     }
                   },
@@ -4676,7 +4676,7 @@
               "name": "NgModule"
             },
             "arguments": {
-              "obj": "{\n  imports: [CommonModule],\n  declarations: [SkyOverlayComponent],\n  entryComponents: [SkyOverlayComponent],\n}"
+              "obj": "{\n  imports: [CommonModule],\n  declarations: [SkyOverlayComponent],\n}"
             }
           }
         ],
@@ -4693,7 +4693,7 @@
         "sources": [
           {
             "fileName": "projects/core/src/modules/overlay/overlay.module.ts",
-            "line": 11,
+            "line": 10,
             "character": 13
           }
         ]
@@ -5283,7 +5283,7 @@
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 600,
+                      "id": 603,
                       "name": "SkyAppWindowRef"
                     }
                   }
@@ -5377,7 +5377,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/scrollable-host/scrollable-host.service.ts",
-                "line": 92,
+                "line": 118,
                 "character": 9
               }
             ],
@@ -5390,7 +5390,7 @@
                 "flags": {},
                 "comment": {
                   "shortText": "Returns an observable which emits whenever the element's scrollable host emits a scroll event. The observable will always emit the scroll events from the elements current scrollable host and will update based on any scrollable host changes. The observable will also emit once whenever the scrollable host changes.",
-                  "returns": "An observable which emits the scroll events from the given element's scrollable host\n"
+                  "returns": "An observable which emits when the elements scrollable host is scrolled or is changed\n"
                 },
                 "parameters": [
                   {
@@ -5458,7 +5458,7 @@
         ]
       },
       {
-        "id": 556,
+        "id": 559,
         "name": "SkyUIConfigService",
         "kind": 128,
         "kindString": "Class",
@@ -5479,7 +5479,7 @@
         ],
         "children": [
           {
-            "id": 559,
+            "id": 562,
             "name": "getConfig",
             "kind": 2048,
             "kindString": "Method",
@@ -5495,14 +5495,14 @@
             ],
             "signatures": [
               {
-                "id": 560,
+                "id": 563,
                 "name": "getConfig",
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 561,
+                    "id": 564,
                     "name": "key",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5513,7 +5513,7 @@
                     }
                   },
                   {
-                    "id": 562,
+                    "id": 565,
                     "name": "defaultConfig",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5542,7 +5542,7 @@
             ]
           },
           {
-            "id": 563,
+            "id": 566,
             "name": "setConfig",
             "kind": 2048,
             "kindString": "Method",
@@ -5558,14 +5558,14 @@
             ],
             "signatures": [
               {
-                "id": 564,
+                "id": 567,
                 "name": "setConfig",
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 565,
+                    "id": 568,
                     "name": "key",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5576,7 +5576,7 @@
                     }
                   },
                   {
-                    "id": 566,
+                    "id": 569,
                     "name": "value",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5608,15 +5608,15 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              557
+              560
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              559,
-              563
+              562,
+              566
             ]
           }
         ],
@@ -5629,7 +5629,7 @@
         ]
       },
       {
-        "id": 567,
+        "id": 570,
         "name": "SkyViewkeeperHostOptions",
         "kind": 128,
         "kindString": "Class",
@@ -5648,7 +5648,7 @@
         ],
         "children": [
           {
-            "id": 570,
+            "id": 573,
             "name": "boundaryEl",
             "kind": 1024,
             "kindString": "Property",
@@ -5674,12 +5674,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 578,
+              "id": 581,
               "name": "SkyViewkeeperOptions.boundaryEl"
             }
           },
           {
-            "id": 571,
+            "id": 574,
             "name": "el",
             "kind": 1024,
             "kindString": "Property",
@@ -5705,12 +5705,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 579,
+              "id": 582,
               "name": "SkyViewkeeperOptions.el"
             }
           },
           {
-            "id": 572,
+            "id": 575,
             "name": "scrollableHost",
             "kind": 1024,
             "kindString": "Property",
@@ -5736,12 +5736,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 580,
+              "id": 583,
               "name": "SkyViewkeeperOptions.scrollableHost"
             }
           },
           {
-            "id": 573,
+            "id": 576,
             "name": "setWidth",
             "kind": 1024,
             "kindString": "Property",
@@ -5765,12 +5765,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 581,
+              "id": 584,
               "name": "SkyViewkeeperOptions.setWidth"
             }
           },
           {
-            "id": 574,
+            "id": 577,
             "name": "verticalOffset",
             "kind": 1024,
             "kindString": "Property",
@@ -5794,12 +5794,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 582,
+              "id": 585,
               "name": "SkyViewkeeperOptions.verticalOffset"
             }
           },
           {
-            "id": 575,
+            "id": 578,
             "name": "verticalOffsetEl",
             "kind": 1024,
             "kindString": "Property",
@@ -5825,12 +5825,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 583,
+              "id": 586,
               "name": "SkyViewkeeperOptions.verticalOffsetEl"
             }
           },
           {
-            "id": 576,
+            "id": 579,
             "name": "viewportMarginTop",
             "kind": 1024,
             "kindString": "Property",
@@ -5854,7 +5854,7 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 584,
+              "id": 587,
               "name": "SkyViewkeeperOptions.viewportMarginTop"
             }
           }
@@ -5864,20 +5864,20 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              568
+              571
             ]
           },
           {
             "title": "Properties",
             "kind": 1024,
             "children": [
-              570,
-              571,
-              572,
               573,
               574,
               575,
-              576
+              576,
+              577,
+              578,
+              579
             ]
           }
         ],
@@ -5891,13 +5891,13 @@
         "implementedTypes": [
           {
             "type": "reference",
-            "id": 577,
+            "id": 580,
             "name": "SkyViewkeeperOptions"
           }
         ]
       },
       {
-        "id": 585,
+        "id": 588,
         "name": "SkyViewkeeperModule",
         "kind": 128,
         "kindString": "Class",
@@ -5922,7 +5922,7 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              586
+              589
             ]
           }
         ],
@@ -5935,7 +5935,7 @@
         ]
       },
       {
-        "id": 588,
+        "id": 591,
         "name": "SkyViewkeeperService",
         "kind": 128,
         "kindString": "Class",
@@ -5959,7 +5959,7 @@
         ],
         "children": [
           {
-            "id": 589,
+            "id": 592,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
@@ -5973,14 +5973,14 @@
             ],
             "signatures": [
               {
-                "id": 590,
+                "id": 593,
                 "name": "new SkyViewkeeperService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 591,
+                    "id": 594,
                     "name": "hostOptions",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6001,21 +6001,21 @@
                     ],
                     "type": {
                       "type": "reference",
-                      "id": 567,
+                      "id": 570,
                       "name": "SkyViewkeeperHostOptions"
                     }
                   }
                 ],
                 "type": {
                   "type": "reference",
-                  "id": 588,
+                  "id": 591,
                   "name": "SkyViewkeeperService"
                 }
               }
             ]
           },
           {
-            "id": 592,
+            "id": 595,
             "name": "create",
             "kind": 2048,
             "kindString": "Method",
@@ -6031,7 +6031,7 @@
             ],
             "signatures": [
               {
-                "id": 593,
+                "id": 596,
                 "name": "create",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -6039,7 +6039,7 @@
                 "comment": {},
                 "parameters": [
                   {
-                    "id": 594,
+                    "id": 597,
                     "name": "options",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6049,7 +6049,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "id": 577,
+                      "id": 580,
                       "name": "SkyViewkeeperOptions"
                     }
                   }
@@ -6062,7 +6062,7 @@
             ]
           },
           {
-            "id": 595,
+            "id": 598,
             "name": "destroy",
             "kind": 2048,
             "kindString": "Method",
@@ -6078,7 +6078,7 @@
             ],
             "signatures": [
               {
-                "id": 596,
+                "id": 599,
                 "name": "destroy",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -6088,7 +6088,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 597,
+                    "id": 600,
                     "name": "vk",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6115,15 +6115,15 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              589
+              592
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              592,
-              595
+              595,
+              598
             ]
           }
         ],
@@ -7007,7 +7007,7 @@
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 588,
+                      "id": 591,
                       "name": "SkyViewkeeperService"
                     }
                   },
@@ -7530,14 +7530,14 @@
         ]
       },
       {
-        "id": 547,
+        "id": 550,
         "name": "SkyAppSetTitleArgs",
         "kind": 256,
         "kindString": "Interface",
         "flags": {},
         "children": [
           {
-            "id": 548,
+            "id": 551,
             "name": "titleParts",
             "kind": 1024,
             "kindString": "Property",
@@ -7563,7 +7563,7 @@
             "title": "Properties",
             "kind": 1024,
             "children": [
-              548
+              551
             ]
           }
         ],
@@ -8146,7 +8146,7 @@
         ]
       },
       {
-        "id": 577,
+        "id": 580,
         "name": "SkyViewkeeperOptions",
         "kind": 256,
         "kindString": "Interface",
@@ -8156,7 +8156,7 @@
         },
         "children": [
           {
-            "id": 578,
+            "id": 581,
             "name": "boundaryEl",
             "kind": 1024,
             "kindString": "Property",
@@ -8181,7 +8181,7 @@
             }
           },
           {
-            "id": 579,
+            "id": 582,
             "name": "el",
             "kind": 1024,
             "kindString": "Property",
@@ -8206,7 +8206,7 @@
             }
           },
           {
-            "id": 580,
+            "id": 583,
             "name": "scrollableHost",
             "kind": 1024,
             "kindString": "Property",
@@ -8231,7 +8231,7 @@
             }
           },
           {
-            "id": 581,
+            "id": 584,
             "name": "setWidth",
             "kind": 1024,
             "kindString": "Property",
@@ -8254,7 +8254,7 @@
             }
           },
           {
-            "id": 582,
+            "id": 585,
             "name": "verticalOffset",
             "kind": 1024,
             "kindString": "Property",
@@ -8277,7 +8277,7 @@
             }
           },
           {
-            "id": 583,
+            "id": 586,
             "name": "verticalOffsetEl",
             "kind": 1024,
             "kindString": "Property",
@@ -8302,7 +8302,7 @@
             }
           },
           {
-            "id": 584,
+            "id": 587,
             "name": "viewportMarginTop",
             "kind": 1024,
             "kindString": "Property",
@@ -8330,13 +8330,13 @@
             "title": "Properties",
             "kind": 1024,
             "children": [
-              578,
-              579,
-              580,
               581,
               582,
               583,
-              584
+              584,
+              585,
+              586,
+              587
             ]
           }
         ],
@@ -8350,7 +8350,7 @@
         "implementedBy": [
           {
             "type": "reference",
-            "id": 567,
+            "id": 570,
             "name": "SkyViewkeeperHostOptions"
           }
         ]
@@ -8544,8 +8544,8 @@
           140,
           148,
           303,
-          549,
-          600,
+          552,
+          603,
           63,
           66,
           221,
@@ -8567,10 +8567,10 @@
           506,
           503,
           526,
-          556,
-          567,
-          585,
+          559,
+          570,
           588,
+          591,
           1,
           26,
           34
@@ -8583,14 +8583,14 @@
           117,
           131,
           134,
-          547,
+          550,
           218,
           235,
           241,
           275,
           111,
           445,
-          577
+          580
         ]
       },
       {