@skyux/core 5.1.3 → 5.2.0

package/documentation.json

@@ -1501,7 +1501,7 @@
         ]
       },
       {
-        "id": 546,
+        "id": 548,
         "name": "SkyAppTitleService",
         "kind": 128,
         "kindString": "Class",
@@ -1523,7 +1523,7 @@
         ],
         "children": [
           {
-            "id": 547,
+            "id": 549,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
@@ -1537,14 +1537,14 @@
             ],
             "signatures": [
               {
-                "id": 548,
+                "id": 550,
                 "name": "new SkyAppTitleService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 549,
+                    "id": 551,
                     "name": "title",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -1557,14 +1557,14 @@
                 ],
                 "type": {
                   "type": "reference",
-                  "id": 546,
+                  "id": 548,
                   "name": "SkyAppTitleService"
                 }
               }
             ]
           },
           {
-            "id": 550,
+            "id": 552,
             "name": "setTitle",
             "kind": 2048,
             "kindString": "Method",
@@ -1580,7 +1580,7 @@
             ],
             "signatures": [
               {
-                "id": 551,
+                "id": 553,
                 "name": "setTitle",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -1590,7 +1590,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 552,
+                    "id": 554,
                     "name": "args",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -1600,7 +1600,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "id": 544,
+                      "id": 546,
                       "name": "SkyAppSetTitleArgs"
                     }
                   }
@@ -1618,14 +1618,14 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              547
+              549
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              550
+              552
             ]
           }
         ],
@@ -1638,7 +1638,7 @@
         ]
       },
       {
-        "id": 597,
+        "id": 599,
         "name": "SkyAppWindowRef",
         "kind": 128,
         "kindString": "Class",
@@ -1660,28 +1660,28 @@
         ],
         "children": [
           {
-            "id": 598,
+            "id": 600,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
             "flags": {},
             "signatures": [
               {
-                "id": 599,
+                "id": 601,
                 "name": "new SkyAppWindowRef",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "type": {
                   "type": "reference",
-                  "id": 597,
+                  "id": 599,
                   "name": "SkyAppWindowRef"
                 }
               }
             ]
           },
           {
-            "id": 600,
+            "id": 602,
             "name": "nativeWindow",
             "kind": 262144,
             "kindString": "Accessor",
@@ -1697,7 +1697,7 @@
             ],
             "getSignature": [
               {
-                "id": 601,
+                "id": 603,
                 "name": "nativeWindow",
                 "kind": 524288,
                 "kindString": "Get signature",
@@ -1718,14 +1718,14 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              598
+              600
             ]
           },
           {
             "title": "Accessors",
             "kind": 262144,
             "children": [
-              600
+              602
             ]
           }
         ],
@@ -3191,7 +3191,7 @@
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 597,
+                      "id": 599,
                       "name": "SkyAppWindowRef"
                     }
                   },
@@ -5472,7 +5472,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/scrollable-host/scrollable-host.service.ts",
-                "line": 12,
+                "line": 18,
                 "character": 2
               }
             ],
@@ -5504,7 +5504,7 @@
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 597,
+                      "id": 599,
                       "name": "SkyAppWindowRef"
                     }
                   }
@@ -5519,7 +5519,7 @@
           },
           {
             "id": 530,
-            "name": "getScrollabeHost",
+            "name": "getScrollableHost",
             "kind": 2048,
             "kindString": "Method",
             "flags": {
@@ -5528,17 +5528,21 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/scrollable-host/scrollable-host.service.ts",
-                "line": 17,
+                "line": 28,
                 "character": 9
               }
             ],
             "signatures": [
               {
                 "id": 531,
-                "name": "getScrollabeHost",
+                "name": "getScrollableHost",
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
+                "comment": {
+                  "shortText": "Returns the given element's current scrollable host",
+                  "returns": "The current scrollable host\n"
+                },
                 "parameters": [
                   {
                     "id": 532,
@@ -5546,6 +5550,9 @@
                     "kind": 32768,
                     "kindString": "Parameter",
                     "flags": {},
+                    "comment": {
+                      "shortText": "The element whose scrollable host is being requested"
+                    },
                     "type": {
                       "type": "reference",
                       "typeArguments": [
@@ -5575,8 +5582,8 @@
             ]
           },
           {
-            "id": 533,
-            "name": "watchScrollableHost",
+            "id": 536,
+            "name": "watchScrollableHostScrollEvents",
             "kind": 2048,
             "kindString": "Method",
             "flags": {
@@ -5585,24 +5592,31 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/scrollable-host/scrollable-host.service.ts",
-                "line": 21,
+                "line": 85,
                 "character": 9
               }
             ],
             "signatures": [
               {
-                "id": 534,
-                "name": "watchScrollableHost",
+                "id": 537,
+                "name": "watchScrollableHostScrollEvents",
                 "kind": 4096,
                 "kindString": "Call signature",
                 "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"
+                },
                 "parameters": [
                   {
-                    "id": 535,
+                    "id": 538,
                     "name": "elementRef",
                     "kind": 32768,
                     "kindString": "Parameter",
                     "flags": {},
+                    "comment": {
+                      "shortText": "The element whose scrollable host scroll events are being requested"
+                    },
                     "type": {
                       "type": "reference",
                       "typeArguments": [
@@ -5613,40 +5627,14 @@
                       ],
                       "name": "ElementRef"
                     }
-                  },
-                  {
-                    "id": 536,
-                    "name": "completionObservable",
-                    "kind": 32768,
-                    "kindString": "Parameter",
-                    "flags": {},
-                    "type": {
-                      "type": "reference",
-                      "typeArguments": [
-                        {
-                          "type": "intrinsic",
-                          "name": "void"
-                        }
-                      ],
-                      "name": "Observable"
-                    }
                   }
                 ],
                 "type": {
                   "type": "reference",
                   "typeArguments": [
                     {
-                      "type": "union",
-                      "types": [
-                        {
-                          "type": "reference",
-                          "name": "HTMLElement"
-                        },
-                        {
-                          "type": "reference",
-                          "name": "Window"
-                        }
-                      ]
+                      "type": "intrinsic",
+                      "name": "void"
                     }
                   ],
                   "name": "Observable"
@@ -5668,20 +5656,20 @@
             "kind": 2048,
             "children": [
               530,
-              533
+              536
             ]
           }
         ],
         "sources": [
           {
             "fileName": "projects/core/src/modules/scrollable-host/scrollable-host.service.ts",
-            "line": 10,
+            "line": 16,
             "character": 13
           }
         ]
       },
       {
-        "id": 553,
+        "id": 555,
         "name": "SkyUIConfigService",
         "kind": 128,
         "kindString": "Class",
@@ -5700,28 +5688,28 @@
         ],
         "children": [
           {
-            "id": 554,
+            "id": 556,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
             "flags": {},
             "signatures": [
               {
-                "id": 555,
+                "id": 557,
                 "name": "new SkyUIConfigService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "type": {
                   "type": "reference",
-                  "id": 553,
+                  "id": 555,
                   "name": "SkyUIConfigService"
                 }
               }
             ]
           },
           {
-            "id": 556,
+            "id": 558,
             "name": "getConfig",
             "kind": 2048,
             "kindString": "Method",
@@ -5737,14 +5725,14 @@
             ],
             "signatures": [
               {
-                "id": 557,
+                "id": 559,
                 "name": "getConfig",
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 558,
+                    "id": 560,
                     "name": "key",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5755,7 +5743,7 @@
                     }
                   },
                   {
-                    "id": 559,
+                    "id": 561,
                     "name": "defaultConfig",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5782,7 +5770,7 @@
             ]
           },
           {
-            "id": 560,
+            "id": 562,
             "name": "setConfig",
             "kind": 2048,
             "kindString": "Method",
@@ -5798,14 +5786,14 @@
             ],
             "signatures": [
               {
-                "id": 561,
+                "id": 563,
                 "name": "setConfig",
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 562,
+                    "id": 564,
                     "name": "key",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5816,7 +5804,7 @@
                     }
                   },
                   {
-                    "id": 563,
+                    "id": 565,
                     "name": "value",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5846,15 +5834,15 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              554
+              556
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              556,
-              560
+              558,
+              562
             ]
           }
         ],
@@ -5867,7 +5855,7 @@
         ]
       },
       {
-        "id": 564,
+        "id": 566,
         "name": "SkyViewkeeperHostOptions",
         "kind": 128,
         "kindString": "Class",
@@ -5884,28 +5872,28 @@
         ],
         "children": [
           {
-            "id": 565,
+            "id": 567,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
             "flags": {},
             "signatures": [
               {
-                "id": 566,
+                "id": 568,
                 "name": "new SkyViewkeeperHostOptions",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "type": {
                   "type": "reference",
-                  "id": 564,
+                  "id": 566,
                   "name": "SkyViewkeeperHostOptions"
                 }
               }
             ]
           },
           {
-            "id": 567,
+            "id": 569,
             "name": "boundaryEl",
             "kind": 1024,
             "kindString": "Property",
@@ -5929,12 +5917,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 575,
+              "id": 577,
               "name": "SkyViewkeeperOptions.boundaryEl"
             }
           },
           {
-            "id": 568,
+            "id": 570,
             "name": "el",
             "kind": 1024,
             "kindString": "Property",
@@ -5958,12 +5946,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 576,
+              "id": 578,
               "name": "SkyViewkeeperOptions.el"
             }
           },
           {
-            "id": 569,
+            "id": 571,
             "name": "scrollableHost",
             "kind": 1024,
             "kindString": "Property",
@@ -5987,12 +5975,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 577,
+              "id": 579,
               "name": "SkyViewkeeperOptions.scrollableHost"
             }
           },
           {
-            "id": 570,
+            "id": 572,
             "name": "setWidth",
             "kind": 1024,
             "kindString": "Property",
@@ -6016,12 +6004,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 578,
+              "id": 580,
               "name": "SkyViewkeeperOptions.setWidth"
             }
           },
           {
-            "id": 571,
+            "id": 573,
             "name": "verticalOffset",
             "kind": 1024,
             "kindString": "Property",
@@ -6045,12 +6033,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 579,
+              "id": 581,
               "name": "SkyViewkeeperOptions.verticalOffset"
             }
           },
           {
-            "id": 572,
+            "id": 574,
             "name": "verticalOffsetEl",
             "kind": 1024,
             "kindString": "Property",
@@ -6074,12 +6062,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 580,
+              "id": 582,
               "name": "SkyViewkeeperOptions.verticalOffsetEl"
             }
           },
           {
-            "id": 573,
+            "id": 575,
             "name": "viewportMarginTop",
             "kind": 1024,
             "kindString": "Property",
@@ -6103,7 +6091,7 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 581,
+              "id": 583,
               "name": "SkyViewkeeperOptions.viewportMarginTop"
             }
           }
@@ -6113,20 +6101,20 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              565
+              567
             ]
           },
           {
             "title": "Properties",
             "kind": 1024,
             "children": [
-              567,
-              568,
               569,
               570,
               571,
               572,
-              573
+              573,
+              574,
+              575
             ]
           }
         ],
@@ -6140,13 +6128,13 @@
         "implementedTypes": [
           {
             "type": "reference",
-            "id": 574,
+            "id": 576,
             "name": "SkyViewkeeperOptions"
           }
         ]
       },
       {
-        "id": 582,
+        "id": 584,
         "name": "SkyViewkeeperModule",
         "kind": 128,
         "kindString": "Class",
@@ -6165,21 +6153,21 @@
         ],
         "children": [
           {
-            "id": 583,
+            "id": 585,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
             "flags": {},
             "signatures": [
               {
-                "id": 584,
+                "id": 586,
                 "name": "new SkyViewkeeperModule",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "type": {
                   "type": "reference",
-                  "id": 582,
+                  "id": 584,
                   "name": "SkyViewkeeperModule"
                 }
               }
@@ -6191,7 +6179,7 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              583
+              585
             ]
           }
         ],
@@ -6204,7 +6192,7 @@
         ]
       },
       {
-        "id": 585,
+        "id": 587,
         "name": "SkyViewkeeperService",
         "kind": 128,
         "kindString": "Class",
@@ -6226,7 +6214,7 @@
         ],
         "children": [
           {
-            "id": 586,
+            "id": 588,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
@@ -6240,14 +6228,14 @@
             ],
             "signatures": [
               {
-                "id": 587,
+                "id": 589,
                 "name": "new SkyViewkeeperService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 588,
+                    "id": 590,
                     "name": "hostOptions",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6266,21 +6254,21 @@
                     ],
                     "type": {
                       "type": "reference",
-                      "id": 564,
+                      "id": 566,
                       "name": "SkyViewkeeperHostOptions"
                     }
                   }
                 ],
                 "type": {
                   "type": "reference",
-                  "id": 585,
+                  "id": 587,
                   "name": "SkyViewkeeperService"
                 }
               }
             ]
           },
           {
-            "id": 589,
+            "id": 591,
             "name": "create",
             "kind": 2048,
             "kindString": "Method",
@@ -6296,7 +6284,7 @@
             ],
             "signatures": [
               {
-                "id": 590,
+                "id": 592,
                 "name": "create",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -6304,7 +6292,7 @@
                 "comment": {},
                 "parameters": [
                   {
-                    "id": 591,
+                    "id": 593,
                     "name": "options",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6314,7 +6302,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "id": 574,
+                      "id": 576,
                       "name": "SkyViewkeeperOptions"
                     }
                   }
@@ -6327,7 +6315,7 @@
             ]
           },
           {
-            "id": 592,
+            "id": 594,
             "name": "destroy",
             "kind": 2048,
             "kindString": "Method",
@@ -6343,7 +6331,7 @@
             ],
             "signatures": [
               {
-                "id": 593,
+                "id": 595,
                 "name": "destroy",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -6353,7 +6341,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 594,
+                    "id": 596,
                     "name": "vk",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6380,15 +6368,15 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              586
+              588
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              589,
-              592
+              591,
+              594
             ]
           }
         ],
@@ -7222,7 +7210,7 @@
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 585,
+                      "id": 587,
                       "name": "SkyViewkeeperService"
                     }
                   },
@@ -7737,14 +7725,14 @@
         ]
       },
       {
-        "id": 544,
+        "id": 546,
         "name": "SkyAppSetTitleArgs",
         "kind": 256,
         "kindString": "Interface",
         "flags": {},
         "children": [
           {
-            "id": 545,
+            "id": 547,
             "name": "titleParts",
             "kind": 1024,
             "kindString": "Property",
@@ -7770,7 +7758,7 @@
             "title": "Properties",
             "kind": 1024,
             "children": [
-              545
+              547
             ]
           }
         ],
@@ -8347,7 +8335,7 @@
         ]
       },
       {
-        "id": 574,
+        "id": 576,
         "name": "SkyViewkeeperOptions",
         "kind": 256,
         "kindString": "Interface",
@@ -8357,7 +8345,7 @@
         },
         "children": [
           {
-            "id": 575,
+            "id": 577,
             "name": "boundaryEl",
             "kind": 1024,
             "kindString": "Property",
@@ -8380,7 +8368,7 @@
             }
           },
           {
-            "id": 576,
+            "id": 578,
             "name": "el",
             "kind": 1024,
             "kindString": "Property",
@@ -8403,7 +8391,7 @@
             }
           },
           {
-            "id": 577,
+            "id": 579,
             "name": "scrollableHost",
             "kind": 1024,
             "kindString": "Property",
@@ -8426,7 +8414,7 @@
             }
           },
           {
-            "id": 578,
+            "id": 580,
             "name": "setWidth",
             "kind": 1024,
             "kindString": "Property",
@@ -8449,7 +8437,7 @@
             }
           },
           {
-            "id": 579,
+            "id": 581,
             "name": "verticalOffset",
             "kind": 1024,
             "kindString": "Property",
@@ -8472,7 +8460,7 @@
             }
           },
           {
-            "id": 580,
+            "id": 582,
             "name": "verticalOffsetEl",
             "kind": 1024,
             "kindString": "Property",
@@ -8495,7 +8483,7 @@
             }
           },
           {
-            "id": 581,
+            "id": 583,
             "name": "viewportMarginTop",
             "kind": 1024,
             "kindString": "Property",
@@ -8523,13 +8511,13 @@
             "title": "Properties",
             "kind": 1024,
             "children": [
-              575,
-              576,
               577,
               578,
               579,
               580,
-              581
+              581,
+              582,
+              583
             ]
           }
         ],
@@ -8543,7 +8531,7 @@
         "implementedBy": [
           {
             "type": "reference",
-            "id": 564,
+            "id": 566,
             "name": "SkyViewkeeperHostOptions"
           }
         ]
@@ -8737,8 +8725,8 @@
           140,
           148,
           301,
-          546,
-          597,
+          548,
+          599,
           63,
           66,
           219,
@@ -8760,10 +8748,10 @@
           505,
           502,
           525,
-          553,
-          564,
-          582,
-          585,
+          555,
+          566,
+          584,
+          587,
           1,
           26,
           34
@@ -8776,14 +8764,14 @@
           117,
           131,
           134,
-          544,
+          546,
           216,
           233,
           239,
           273,
           111,
           444,
-          574
+          576
         ]
       },
       {