@skyux/core 5.9.3 → 5.9.6

package/documentation.json

@@ -1444,7 +1444,7 @@
         ]
       },
       {
-        "id": 604,
+        "id": 606,
         "name": "SkyAppTitleService",
         "kind": 128,
         "kindString": "Class",
@@ -1468,7 +1468,7 @@
         ],
         "children": [
           {
-            "id": 605,
+            "id": 607,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
@@ -1482,14 +1482,14 @@
             ],
             "signatures": [
               {
-                "id": 606,
+                "id": 608,
                 "name": "new SkyAppTitleService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 607,
+                    "id": 609,
                     "name": "title",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -1504,14 +1504,14 @@
                 ],
                 "type": {
                   "type": "reference",
-                  "id": 604,
+                  "id": 606,
                   "name": "SkyAppTitleService"
                 }
               }
             ]
           },
           {
-            "id": 608,
+            "id": 610,
             "name": "setTitle",
             "kind": 2048,
             "kindString": "Method",
@@ -1527,7 +1527,7 @@
             ],
             "signatures": [
               {
-                "id": 609,
+                "id": 611,
                 "name": "setTitle",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -1537,7 +1537,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 610,
+                    "id": 612,
                     "name": "args",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -1547,7 +1547,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "id": 602,
+                      "id": 604,
                       "name": "SkyAppSetTitleArgs"
                     }
                   }
@@ -1565,14 +1565,14 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              605
+              607
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              608
+              610
             ]
           }
         ],
@@ -1585,7 +1585,7 @@
         ]
       },
       {
-        "id": 655,
+        "id": 657,
         "name": "SkyAppWindowRef",
         "kind": 128,
         "kindString": "Class",
@@ -1609,7 +1609,7 @@
         ],
         "children": [
           {
-            "id": 658,
+            "id": 660,
             "name": "nativeWindow",
             "kind": 262144,
             "kindString": "Accessor",
@@ -1625,7 +1625,7 @@
             ],
             "getSignature": [
               {
-                "id": 659,
+                "id": 661,
                 "name": "nativeWindow",
                 "kind": 524288,
                 "kindString": "Get signature",
@@ -1646,14 +1646,14 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              656
+              658
             ]
           },
           {
             "title": "Accessors",
             "kind": 262144,
             "children": [
-              658
+              660
             ]
           }
         ],
@@ -3068,7 +3068,7 @@
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 655,
+                      "id": 657,
                       "name": "SkyAppWindowRef"
                     }
                   },
@@ -3924,7 +3924,7 @@
         "kindString": "Class",
         "flags": {},
         "comment": {
-          "shortText": "Shortens numbers to rounded numbers and abbreviation characters such as K for thousands,\nM for millions, B for billions, and T for trillions. The pipe also formats for currency.\nBe sure you have a space after the two curly brackets opening the pipe and\na space before the two curly brackets closing the pipe or it will not work.\nUsage:\n```\n{{ value | skyNumeric(config) }}\n```"
+          "shortText": "Shortens numbers to rounded numbers and abbreviation characters such as K for thousands,\nM for millions, B for billions, and T for trillions. The pipe also formats for currency.\nBe sure you have a space after the two curly brackets opening the pipe and\na space before the two curly brackets closing the pipe or it will not work."
         },
         "decorators": [
           {
@@ -3950,7 +3950,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/numeric/numeric.pipe.ts",
-                "line": 38,
+                "line": 34,
                 "character": 2
               }
             ],
@@ -4018,7 +4018,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/numeric/numeric.pipe.ts",
-                "line": 53,
+                "line": 49,
                 "character": 9
               }
             ],
@@ -4055,7 +4055,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/numeric/numeric.pipe.ts",
-                "line": 58,
+                "line": 57,
                 "character": 9
               }
             ],
@@ -4066,6 +4066,9 @@
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
+                "comment": {
+                  "shortText": "Formats a number based on the provided options."
+                },
                 "parameters": [
                   {
                     "id": 410,
@@ -4129,7 +4132,7 @@
         "sources": [
           {
             "fileName": "projects/core/src/modules/numeric/numeric.pipe.ts",
-            "line": 29,
+            "line": 25,
             "character": 13
           }
         ],
@@ -4233,7 +4236,7 @@
                 "kindString": "Call signature",
                 "flags": {},
                 "comment": {
-                  "shortText": "Shortens with or without symbol (K/M/B/T) depending on value of number."
+                  "shortText": "Formats a number based on the provided options."
                 },
                 "parameters": [
                   {
@@ -5256,7 +5259,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer-media-query.service.ts",
-                "line": 54,
+                "line": 53,
                 "character": 2
               }
             ],
@@ -5323,7 +5326,7 @@
             ]
           },
           {
-            "id": 560,
+            "id": 559,
             "name": "ngOnDestroy",
             "kind": 2048,
             "kindString": "Method",
@@ -5333,13 +5336,13 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer-media-query.service.ts",
-                "line": 61,
+                "line": 60,
                 "character": 9
               }
             ],
             "signatures": [
               {
-                "id": 561,
+                "id": 560,
                 "name": "ngOnDestroy",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -5360,7 +5363,7 @@
             }
           },
           {
-            "id": 564,
+            "id": 563,
             "name": "observe",
             "kind": 2048,
             "kindString": "Method",
@@ -5370,13 +5373,13 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer-media-query.service.ts",
-                "line": 79,
+                "line": 78,
                 "character": 9
               }
             ],
             "signatures": [
               {
-                "id": 565,
+                "id": 564,
                 "name": "observe",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -5386,7 +5389,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 566,
+                    "id": 565,
                     "name": "element",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5414,7 +5417,7 @@
             ]
           },
           {
-            "id": 569,
+            "id": 568,
             "name": "subscribe",
             "kind": 2048,
             "kindString": "Method",
@@ -5424,13 +5427,13 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer-media-query.service.ts",
-                "line": 115,
+                "line": 110,
                 "character": 9
               }
             ],
             "signatures": [
               {
-                "id": 570,
+                "id": 569,
                 "name": "subscribe",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -5440,7 +5443,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 571,
+                    "id": 570,
                     "name": "listener",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5462,7 +5465,7 @@
             ]
           },
           {
-            "id": 567,
+            "id": 566,
             "name": "unobserve",
             "kind": 2048,
             "kindString": "Method",
@@ -5472,13 +5475,13 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer-media-query.service.ts",
-                "line": 108,
+                "line": 103,
                 "character": 9
               }
             ],
             "signatures": [
               {
-                "id": 568,
+                "id": 567,
                 "name": "unobserve",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -5513,10 +5516,10 @@
             "title": "Methods",
             "kind": 2048,
             "children": [
-              560,
-              564,
-              569,
-              567
+              559,
+              563,
+              568,
+              566
             ]
           }
         ],
@@ -5738,7 +5741,7 @@
         ]
       },
       {
-        "id": 578,
+        "id": 580,
         "name": "SkyScrollableHostService",
         "kind": 128,
         "kindString": "Class",
@@ -5759,7 +5762,7 @@
         ],
         "children": [
           {
-            "id": 579,
+            "id": 581,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
@@ -5773,14 +5776,14 @@
             ],
             "signatures": [
               {
-                "id": 580,
+                "id": 582,
                 "name": "new SkyScrollableHostService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 581,
+                    "id": 583,
                     "name": "mutationObserverSvc",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5792,28 +5795,28 @@
                     }
                   },
                   {
-                    "id": 582,
+                    "id": 584,
                     "name": "windowRef",
                     "kind": 32768,
                     "kindString": "Parameter",
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 655,
+                      "id": 657,
                       "name": "SkyAppWindowRef"
                     }
                   }
                 ],
                 "type": {
                   "type": "reference",
-                  "id": 578,
+                  "id": 580,
                   "name": "SkyScrollableHostService"
                 }
               }
             ]
           },
           {
-            "id": 583,
+            "id": 585,
             "name": "getScrollableHost",
             "kind": 2048,
             "kindString": "Method",
@@ -5829,7 +5832,7 @@
             ],
             "signatures": [
               {
-                "id": 584,
+                "id": 586,
                 "name": "getScrollableHost",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -5840,7 +5843,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 585,
+                    "id": 587,
                     "name": "elementRef",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5883,7 +5886,7 @@
             ]
           },
           {
-            "id": 589,
+            "id": 591,
             "name": "watchScrollableHostScrollEvents",
             "kind": 2048,
             "kindString": "Method",
@@ -5899,7 +5902,7 @@
             ],
             "signatures": [
               {
-                "id": 590,
+                "id": 592,
                 "name": "watchScrollableHostScrollEvents",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -5910,7 +5913,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 591,
+                    "id": 593,
                     "name": "elementRef",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5953,15 +5956,15 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              579
+              581
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              583,
-              589
+              585,
+              591
             ]
           }
         ],
@@ -5974,7 +5977,7 @@
         ]
       },
       {
-        "id": 611,
+        "id": 613,
         "name": "SkyUIConfigService",
         "kind": 128,
         "kindString": "Class",
@@ -5995,7 +5998,7 @@
         ],
         "children": [
           {
-            "id": 614,
+            "id": 616,
             "name": "getConfig",
             "kind": 2048,
             "kindString": "Method",
@@ -6011,14 +6014,14 @@
             ],
             "signatures": [
               {
-                "id": 615,
+                "id": 617,
                 "name": "getConfig",
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 616,
+                    "id": 618,
                     "name": "key",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6029,7 +6032,7 @@
                     }
                   },
                   {
-                    "id": 617,
+                    "id": 619,
                     "name": "defaultConfig",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6058,7 +6061,7 @@
             ]
           },
           {
-            "id": 618,
+            "id": 620,
             "name": "setConfig",
             "kind": 2048,
             "kindString": "Method",
@@ -6074,14 +6077,14 @@
             ],
             "signatures": [
               {
-                "id": 619,
+                "id": 621,
                 "name": "setConfig",
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 620,
+                    "id": 622,
                     "name": "key",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6092,7 +6095,7 @@
                     }
                   },
                   {
-                    "id": 621,
+                    "id": 623,
                     "name": "value",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6124,15 +6127,15 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              612
+              614
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              614,
-              618
+              616,
+              620
             ]
           }
         ],
@@ -6145,7 +6148,7 @@
         ]
       },
       {
-        "id": 622,
+        "id": 624,
         "name": "SkyViewkeeperHostOptions",
         "kind": 128,
         "kindString": "Class",
@@ -6164,7 +6167,7 @@
         ],
         "children": [
           {
-            "id": 625,
+            "id": 627,
             "name": "boundaryEl",
             "kind": 1024,
             "kindString": "Property",
@@ -6190,12 +6193,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 633,
+              "id": 635,
               "name": "SkyViewkeeperOptions.boundaryEl"
             }
           },
           {
-            "id": 626,
+            "id": 628,
             "name": "el",
             "kind": 1024,
             "kindString": "Property",
@@ -6221,12 +6224,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 634,
+              "id": 636,
               "name": "SkyViewkeeperOptions.el"
             }
           },
           {
-            "id": 627,
+            "id": 629,
             "name": "scrollableHost",
             "kind": 1024,
             "kindString": "Property",
@@ -6252,12 +6255,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 635,
+              "id": 637,
               "name": "SkyViewkeeperOptions.scrollableHost"
             }
           },
           {
-            "id": 628,
+            "id": 630,
             "name": "setWidth",
             "kind": 1024,
             "kindString": "Property",
@@ -6281,12 +6284,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 636,
+              "id": 638,
               "name": "SkyViewkeeperOptions.setWidth"
             }
           },
           {
-            "id": 629,
+            "id": 631,
             "name": "verticalOffset",
             "kind": 1024,
             "kindString": "Property",
@@ -6310,12 +6313,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 637,
+              "id": 639,
               "name": "SkyViewkeeperOptions.verticalOffset"
             }
           },
           {
-            "id": 630,
+            "id": 632,
             "name": "verticalOffsetEl",
             "kind": 1024,
             "kindString": "Property",
@@ -6341,12 +6344,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 638,
+              "id": 640,
               "name": "SkyViewkeeperOptions.verticalOffsetEl"
             }
           },
           {
-            "id": 631,
+            "id": 633,
             "name": "viewportMarginTop",
             "kind": 1024,
             "kindString": "Property",
@@ -6370,7 +6373,7 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 639,
+              "id": 641,
               "name": "SkyViewkeeperOptions.viewportMarginTop"
             }
           }
@@ -6380,20 +6383,20 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              623
+              625
             ]
           },
           {
             "title": "Properties",
             "kind": 1024,
             "children": [
-              625,
-              626,
               627,
               628,
               629,
               630,
-              631
+              631,
+              632,
+              633
             ]
           }
         ],
@@ -6407,13 +6410,13 @@
         "implementedTypes": [
           {
             "type": "reference",
-            "id": 632,
+            "id": 634,
             "name": "SkyViewkeeperOptions"
           }
         ]
       },
       {
-        "id": 640,
+        "id": 642,
         "name": "SkyViewkeeperModule",
         "kind": 128,
         "kindString": "Class",
@@ -6438,7 +6441,7 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              641
+              643
             ]
           }
         ],
@@ -6451,7 +6454,7 @@
         ]
       },
       {
-        "id": 643,
+        "id": 645,
         "name": "SkyViewkeeperService",
         "kind": 128,
         "kindString": "Class",
@@ -6475,7 +6478,7 @@
         ],
         "children": [
           {
-            "id": 644,
+            "id": 646,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
@@ -6489,14 +6492,14 @@
             ],
             "signatures": [
               {
-                "id": 645,
+                "id": 647,
                 "name": "new SkyViewkeeperService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 646,
+                    "id": 648,
                     "name": "hostOptions",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6517,21 +6520,21 @@
                     ],
                     "type": {
                       "type": "reference",
-                      "id": 622,
+                      "id": 624,
                       "name": "SkyViewkeeperHostOptions"
                     }
                   }
                 ],
                 "type": {
                   "type": "reference",
-                  "id": 643,
+                  "id": 645,
                   "name": "SkyViewkeeperService"
                 }
               }
             ]
           },
           {
-            "id": 647,
+            "id": 649,
             "name": "create",
             "kind": 2048,
             "kindString": "Method",
@@ -6547,7 +6550,7 @@
             ],
             "signatures": [
               {
-                "id": 648,
+                "id": 650,
                 "name": "create",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -6555,7 +6558,7 @@
                 "comment": {},
                 "parameters": [
                   {
-                    "id": 649,
+                    "id": 651,
                     "name": "options",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6565,7 +6568,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "id": 632,
+                      "id": 634,
                       "name": "SkyViewkeeperOptions"
                     }
                   }
@@ -6578,7 +6581,7 @@
             ]
           },
           {
-            "id": 650,
+            "id": 652,
             "name": "destroy",
             "kind": 2048,
             "kindString": "Method",
@@ -6594,7 +6597,7 @@
             ],
             "signatures": [
               {
-                "id": 651,
+                "id": 653,
                 "name": "destroy",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -6604,7 +6607,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 652,
+                    "id": 654,
                     "name": "vk",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6631,15 +6634,15 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              644
+              646
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              647,
-              650
+              649,
+              652
             ]
           }
         ],
@@ -7523,7 +7526,7 @@
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 643,
+                      "id": 645,
                       "name": "SkyViewkeeperService"
                     }
                   },
@@ -7547,7 +7550,7 @@
                     ],
                     "type": {
                       "type": "reference",
-                      "id": 578,
+                      "id": 580,
                       "name": "SkyScrollableHostService"
                     }
                   }
@@ -8046,14 +8049,14 @@
         ]
       },
       {
-        "id": 602,
+        "id": 604,
         "name": "SkyAppSetTitleArgs",
         "kind": 256,
         "kindString": "Interface",
         "flags": {},
         "children": [
           {
-            "id": 603,
+            "id": 605,
             "name": "titleParts",
             "kind": 1024,
             "kindString": "Property",
@@ -8079,7 +8082,7 @@
             "title": "Properties",
             "kind": 1024,
             "children": [
-              603
+              605
             ]
           }
         ],
@@ -8662,7 +8665,7 @@
         ]
       },
       {
-        "id": 632,
+        "id": 634,
         "name": "SkyViewkeeperOptions",
         "kind": 256,
         "kindString": "Interface",
@@ -8672,7 +8675,7 @@
         },
         "children": [
           {
-            "id": 633,
+            "id": 635,
             "name": "boundaryEl",
             "kind": 1024,
             "kindString": "Property",
@@ -8697,7 +8700,7 @@
             }
           },
           {
-            "id": 634,
+            "id": 636,
             "name": "el",
             "kind": 1024,
             "kindString": "Property",
@@ -8722,7 +8725,7 @@
             }
           },
           {
-            "id": 635,
+            "id": 637,
             "name": "scrollableHost",
             "kind": 1024,
             "kindString": "Property",
@@ -8747,7 +8750,7 @@
             }
           },
           {
-            "id": 636,
+            "id": 638,
             "name": "setWidth",
             "kind": 1024,
             "kindString": "Property",
@@ -8770,7 +8773,7 @@
             }
           },
           {
-            "id": 637,
+            "id": 639,
             "name": "verticalOffset",
             "kind": 1024,
             "kindString": "Property",
@@ -8793,7 +8796,7 @@
             }
           },
           {
-            "id": 638,
+            "id": 640,
             "name": "verticalOffsetEl",
             "kind": 1024,
             "kindString": "Property",
@@ -8818,7 +8821,7 @@
             }
           },
           {
-            "id": 639,
+            "id": 641,
             "name": "viewportMarginTop",
             "kind": 1024,
             "kindString": "Property",
@@ -8846,13 +8849,13 @@
             "title": "Properties",
             "kind": 1024,
             "children": [
-              633,
-              634,
               635,
               636,
               637,
               638,
-              639
+              639,
+              640,
+              641
             ]
           }
         ],
@@ -8866,7 +8869,7 @@
         "implementedBy": [
           {
             "type": "reference",
-            "id": 622,
+            "id": 624,
             "name": "SkyViewkeeperHostOptions"
           }
         ]
@@ -9060,8 +9063,8 @@
           140,
           148,
           303,
-          604,
-          655,
+          606,
+          657,
           63,
           66,
           221,
@@ -9084,11 +9087,11 @@
           503,
           543,
           526,
-          578,
-          611,
-          622,
-          640,
-          643,
+          580,
+          613,
+          624,
+          642,
+          645,
           1,
           26,
           34
@@ -9101,14 +9104,14 @@
           117,
           131,
           134,
-          602,
+          604,
           218,
           235,
           241,
           275,
           111,
           445,
-          632
+          634
         ]
       },
       {