@skyux/core 6.0.0 → 6.1.0

package/documentation.json

@@ -1467,7 +1467,7 @@
         ]
       },
       {
-        "id": 640,
+        "id": 646,
         "name": "SkyAppTitleService",
         "kind": 128,
         "kindString": "Class",
@@ -1491,7 +1491,7 @@
         ],
         "children": [
           {
-            "id": 641,
+            "id": 647,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
@@ -1505,14 +1505,14 @@
             ],
             "signatures": [
               {
-                "id": 642,
+                "id": 648,
                 "name": "new SkyAppTitleService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 643,
+                    "id": 649,
                     "name": "title",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -1527,14 +1527,14 @@
                 ],
                 "type": {
                   "type": "reference",
-                  "id": 640,
+                  "id": 646,
                   "name": "SkyAppTitleService"
                 }
               }
             ]
           },
           {
-            "id": 644,
+            "id": 650,
             "name": "setTitle",
             "kind": 2048,
             "kindString": "Method",
@@ -1550,7 +1550,7 @@
             ],
             "signatures": [
               {
-                "id": 645,
+                "id": 651,
                 "name": "setTitle",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -1560,7 +1560,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 646,
+                    "id": 652,
                     "name": "args",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -1570,7 +1570,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "id": 638,
+                      "id": 644,
                       "name": "SkyAppSetTitleArgs"
                     }
                   }
@@ -1588,14 +1588,14 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              641
+              647
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              644
+              650
             ]
           }
         ],
@@ -1608,7 +1608,7 @@
         ]
       },
       {
-        "id": 691,
+        "id": 697,
         "name": "SkyAppWindowRef",
         "kind": 128,
         "kindString": "Class",
@@ -1632,7 +1632,7 @@
         ],
         "children": [
           {
-            "id": 694,
+            "id": 700,
             "name": "nativeWindow",
             "kind": 262144,
             "kindString": "Accessor",
@@ -1648,7 +1648,7 @@
             ],
             "getSignature": [
               {
-                "id": 695,
+                "id": 701,
                 "name": "nativeWindow",
                 "kind": 524288,
                 "kindString": "Get signature",
@@ -1669,14 +1669,14 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              692
+              698
             ]
           },
           {
             "title": "Accessors",
             "kind": 262144,
             "children": [
-              694
+              700
             ]
           }
         ],
@@ -2145,7 +2145,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/adapter-service/adapter.service.ts",
-                "line": 230,
+                "line": 229,
                 "character": 9
               }
             ],
@@ -2286,7 +2286,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/adapter-service/adapter.service.ts",
-                "line": 246,
+                "line": 245,
                 "character": 9
               }
             ],
@@ -3091,7 +3091,7 @@
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 691,
+                      "id": 697,
                       "name": "SkyAppWindowRef"
                     }
                   },
@@ -3833,7 +3833,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": [
           {
@@ -3859,7 +3859,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/numeric/numeric.pipe.ts",
-                "line": 36,
+                "line": 32,
                 "character": 2
               }
             ],
@@ -3927,7 +3927,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/numeric/numeric.pipe.ts",
-                "line": 51,
+                "line": 47,
                 "character": 9
               }
             ],
@@ -3964,7 +3964,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/numeric/numeric.pipe.ts",
-                "line": 56,
+                "line": 55,
                 "character": 9
               }
             ],
@@ -3975,6 +3975,9 @@
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
+                "comment": {
+                  "shortText": "Formats a number based on the provided options."
+                },
                 "parameters": [
                   {
                     "id": 447,
@@ -4038,7 +4041,7 @@
         "sources": [
           {
             "fileName": "projects/core/src/modules/numeric/numeric.pipe.ts",
-            "line": 29,
+            "line": 25,
             "character": 13
           }
         ],
@@ -4142,7 +4145,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": [
                   {
@@ -5165,7 +5168,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer-media-query.service.ts",
-                "line": 53,
+                "line": 57,
                 "character": 2
               }
             ],
@@ -5242,7 +5245,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer-media-query.service.ts",
-                "line": 60,
+                "line": 64,
                 "character": 9
               }
             ],
@@ -5279,7 +5282,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer-media-query.service.ts",
-                "line": 78,
+                "line": 82,
                 "character": 9
               }
             ],
@@ -5333,7 +5336,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer-media-query.service.ts",
-                "line": 114,
+                "line": 118,
                 "character": 9
               }
             ],
@@ -5381,7 +5384,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer-media-query.service.ts",
-                "line": 107,
+                "line": 111,
                 "character": 9
               }
             ],
@@ -5478,7 +5481,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer.service.ts",
-                "line": 22,
+                "line": 23,
                 "character": 2
               }
             ],
@@ -5523,7 +5526,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer.service.ts",
-                "line": 30,
+                "line": 29,
                 "character": 9
               }
             ],
@@ -5560,7 +5563,7 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/resize-observer/resize-observer.service.ts",
-                "line": 37,
+                "line": 36,
                 "character": 9
               }
             ],
@@ -5647,7 +5650,7 @@
         ]
       },
       {
-        "id": 614,
+        "id": 617,
         "name": "SkyScrollableHostService",
         "kind": 128,
         "kindString": "Class",
@@ -5668,7 +5671,7 @@
         ],
         "children": [
           {
-            "id": 615,
+            "id": 618,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
@@ -5682,14 +5685,14 @@
             ],
             "signatures": [
               {
-                "id": 616,
+                "id": 619,
                 "name": "new SkyScrollableHostService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 617,
+                    "id": 620,
                     "name": "mutationObserverSvc",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5701,28 +5704,28 @@
                     }
                   },
                   {
-                    "id": 618,
+                    "id": 621,
                     "name": "windowRef",
                     "kind": 32768,
                     "kindString": "Parameter",
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 691,
+                      "id": 697,
                       "name": "SkyAppWindowRef"
                     }
                   }
                 ],
                 "type": {
                   "type": "reference",
-                  "id": 614,
+                  "id": 617,
                   "name": "SkyScrollableHostService"
                 }
               }
             ]
           },
           {
-            "id": 619,
+            "id": 622,
             "name": "getScrollableHost",
             "kind": 2048,
             "kindString": "Method",
@@ -5738,7 +5741,7 @@
             ],
             "signatures": [
               {
-                "id": 620,
+                "id": 623,
                 "name": "getScrollableHost",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -5749,7 +5752,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 621,
+                    "id": 624,
                     "name": "elementRef",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5792,7 +5795,7 @@
             ]
           },
           {
-            "id": 625,
+            "id": 628,
             "name": "watchScrollableHostScrollEvents",
             "kind": 2048,
             "kindString": "Method",
@@ -5802,13 +5805,13 @@
             "sources": [
               {
                 "fileName": "projects/core/src/modules/scrollable-host/scrollable-host.service.ts",
-                "line": 118,
+                "line": 127,
                 "character": 9
               }
             ],
             "signatures": [
               {
-                "id": 626,
+                "id": 629,
                 "name": "watchScrollableHostScrollEvents",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -5819,7 +5822,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 627,
+                    "id": 630,
                     "name": "elementRef",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5862,15 +5865,15 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              615
+              618
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              619,
-              625
+              622,
+              628
             ]
           }
         ],
@@ -5883,7 +5886,7 @@
         ]
       },
       {
-        "id": 647,
+        "id": 653,
         "name": "SkyUIConfigService",
         "kind": 128,
         "kindString": "Class",
@@ -5904,7 +5907,7 @@
         ],
         "children": [
           {
-            "id": 650,
+            "id": 656,
             "name": "getConfig",
             "kind": 2048,
             "kindString": "Method",
@@ -5920,14 +5923,14 @@
             ],
             "signatures": [
               {
-                "id": 651,
+                "id": 657,
                 "name": "getConfig",
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 652,
+                    "id": 658,
                     "name": "key",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5938,7 +5941,7 @@
                     }
                   },
                   {
-                    "id": 653,
+                    "id": 659,
                     "name": "defaultConfig",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -5967,7 +5970,7 @@
             ]
           },
           {
-            "id": 654,
+            "id": 660,
             "name": "setConfig",
             "kind": 2048,
             "kindString": "Method",
@@ -5983,14 +5986,14 @@
             ],
             "signatures": [
               {
-                "id": 655,
+                "id": 661,
                 "name": "setConfig",
                 "kind": 4096,
                 "kindString": "Call signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 656,
+                    "id": 662,
                     "name": "key",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6001,7 +6004,7 @@
                     }
                   },
                   {
-                    "id": 657,
+                    "id": 663,
                     "name": "value",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6033,15 +6036,15 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              648
+              654
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              650,
-              654
+              656,
+              660
             ]
           }
         ],
@@ -6054,7 +6057,7 @@
         ]
       },
       {
-        "id": 658,
+        "id": 664,
         "name": "SkyViewkeeperHostOptions",
         "kind": 128,
         "kindString": "Class",
@@ -6073,7 +6076,7 @@
         ],
         "children": [
           {
-            "id": 661,
+            "id": 667,
             "name": "boundaryEl",
             "kind": 1024,
             "kindString": "Property",
@@ -6099,12 +6102,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 669,
+              "id": 675,
               "name": "SkyViewkeeperOptions.boundaryEl"
             }
           },
           {
-            "id": 662,
+            "id": 668,
             "name": "el",
             "kind": 1024,
             "kindString": "Property",
@@ -6130,12 +6133,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 670,
+              "id": 676,
               "name": "SkyViewkeeperOptions.el"
             }
           },
           {
-            "id": 663,
+            "id": 669,
             "name": "scrollableHost",
             "kind": 1024,
             "kindString": "Property",
@@ -6161,12 +6164,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 671,
+              "id": 677,
               "name": "SkyViewkeeperOptions.scrollableHost"
             }
           },
           {
-            "id": 664,
+            "id": 670,
             "name": "setWidth",
             "kind": 1024,
             "kindString": "Property",
@@ -6190,12 +6193,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 672,
+              "id": 678,
               "name": "SkyViewkeeperOptions.setWidth"
             }
           },
           {
-            "id": 665,
+            "id": 671,
             "name": "verticalOffset",
             "kind": 1024,
             "kindString": "Property",
@@ -6219,12 +6222,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 673,
+              "id": 679,
               "name": "SkyViewkeeperOptions.verticalOffset"
             }
           },
           {
-            "id": 666,
+            "id": 672,
             "name": "verticalOffsetEl",
             "kind": 1024,
             "kindString": "Property",
@@ -6250,12 +6253,12 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 674,
+              "id": 680,
               "name": "SkyViewkeeperOptions.verticalOffsetEl"
             }
           },
           {
-            "id": 667,
+            "id": 673,
             "name": "viewportMarginTop",
             "kind": 1024,
             "kindString": "Property",
@@ -6279,7 +6282,7 @@
             },
             "implementationOf": {
               "type": "reference",
-              "id": 675,
+              "id": 681,
               "name": "SkyViewkeeperOptions.viewportMarginTop"
             }
           }
@@ -6289,20 +6292,20 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              659
+              665
             ]
           },
           {
             "title": "Properties",
             "kind": 1024,
             "children": [
-              661,
-              662,
-              663,
-              664,
-              665,
-              666,
-              667
+              667,
+              668,
+              669,
+              670,
+              671,
+              672,
+              673
             ]
           }
         ],
@@ -6316,13 +6319,13 @@
         "implementedTypes": [
           {
             "type": "reference",
-            "id": 668,
+            "id": 674,
             "name": "SkyViewkeeperOptions"
           }
         ]
       },
       {
-        "id": 676,
+        "id": 682,
         "name": "SkyViewkeeperModule",
         "kind": 128,
         "kindString": "Class",
@@ -6347,7 +6350,7 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              677
+              683
             ]
           }
         ],
@@ -6360,7 +6363,7 @@
         ]
       },
       {
-        "id": 679,
+        "id": 685,
         "name": "SkyViewkeeperService",
         "kind": 128,
         "kindString": "Class",
@@ -6384,7 +6387,7 @@
         ],
         "children": [
           {
-            "id": 680,
+            "id": 686,
             "name": "constructor",
             "kind": 512,
             "kindString": "Constructor",
@@ -6398,14 +6401,14 @@
             ],
             "signatures": [
               {
-                "id": 681,
+                "id": 687,
                 "name": "new SkyViewkeeperService",
                 "kind": 16384,
                 "kindString": "Constructor signature",
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 682,
+                    "id": 688,
                     "name": "hostOptions",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6426,21 +6429,21 @@
                     ],
                     "type": {
                       "type": "reference",
-                      "id": 658,
+                      "id": 664,
                       "name": "SkyViewkeeperHostOptions"
                     }
                   }
                 ],
                 "type": {
                   "type": "reference",
-                  "id": 679,
+                  "id": 685,
                   "name": "SkyViewkeeperService"
                 }
               }
             ]
           },
           {
-            "id": 683,
+            "id": 689,
             "name": "create",
             "kind": 2048,
             "kindString": "Method",
@@ -6456,7 +6459,7 @@
             ],
             "signatures": [
               {
-                "id": 684,
+                "id": 690,
                 "name": "create",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -6464,7 +6467,7 @@
                 "comment": {},
                 "parameters": [
                   {
-                    "id": 685,
+                    "id": 691,
                     "name": "options",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6474,7 +6477,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "id": 668,
+                      "id": 674,
                       "name": "SkyViewkeeperOptions"
                     }
                   }
@@ -6487,7 +6490,7 @@
             ]
           },
           {
-            "id": 686,
+            "id": 692,
             "name": "destroy",
             "kind": 2048,
             "kindString": "Method",
@@ -6503,7 +6506,7 @@
             ],
             "signatures": [
               {
-                "id": 687,
+                "id": 693,
                 "name": "destroy",
                 "kind": 4096,
                 "kindString": "Call signature",
@@ -6513,7 +6516,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 688,
+                    "id": 694,
                     "name": "vk",
                     "kind": 32768,
                     "kindString": "Parameter",
@@ -6540,15 +6543,15 @@
             "title": "Constructors",
             "kind": 512,
             "children": [
-              680
+              686
             ]
           },
           {
             "title": "Methods",
             "kind": 2048,
             "children": [
-              683,
-              686
+              689,
+              692
             ]
           }
         ],
@@ -7432,7 +7435,7 @@
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "id": 679,
+                      "id": 685,
                       "name": "SkyViewkeeperService"
                     }
                   },
@@ -7456,7 +7459,7 @@
                     ],
                     "type": {
                       "type": "reference",
-                      "id": 614,
+                      "id": 617,
                       "name": "SkyScrollableHostService"
                     }
                   }
@@ -7955,14 +7958,14 @@
         ]
       },
       {
-        "id": 638,
+        "id": 644,
         "name": "SkyAppSetTitleArgs",
         "kind": 256,
         "kindString": "Interface",
         "flags": {},
         "children": [
           {
-            "id": 639,
+            "id": 645,
             "name": "titleParts",
             "kind": 1024,
             "kindString": "Property",
@@ -7988,7 +7991,7 @@
             "title": "Properties",
             "kind": 1024,
             "children": [
-              639
+              645
             ]
           }
         ],
@@ -8806,7 +8809,7 @@
         ]
       },
       {
-        "id": 668,
+        "id": 674,
         "name": "SkyViewkeeperOptions",
         "kind": 256,
         "kindString": "Interface",
@@ -8816,7 +8819,7 @@
         },
         "children": [
           {
-            "id": 669,
+            "id": 675,
             "name": "boundaryEl",
             "kind": 1024,
             "kindString": "Property",
@@ -8841,7 +8844,7 @@
             }
           },
           {
-            "id": 670,
+            "id": 676,
             "name": "el",
             "kind": 1024,
             "kindString": "Property",
@@ -8866,7 +8869,7 @@
             }
           },
           {
-            "id": 671,
+            "id": 677,
             "name": "scrollableHost",
             "kind": 1024,
             "kindString": "Property",
@@ -8891,7 +8894,7 @@
             }
           },
           {
-            "id": 672,
+            "id": 678,
             "name": "setWidth",
             "kind": 1024,
             "kindString": "Property",
@@ -8914,7 +8917,7 @@
             }
           },
           {
-            "id": 673,
+            "id": 679,
             "name": "verticalOffset",
             "kind": 1024,
             "kindString": "Property",
@@ -8937,7 +8940,7 @@
             }
           },
           {
-            "id": 674,
+            "id": 680,
             "name": "verticalOffsetEl",
             "kind": 1024,
             "kindString": "Property",
@@ -8962,7 +8965,7 @@
             }
           },
           {
-            "id": 675,
+            "id": 681,
             "name": "viewportMarginTop",
             "kind": 1024,
             "kindString": "Property",
@@ -8990,13 +8993,13 @@
             "title": "Properties",
             "kind": 1024,
             "children": [
-              669,
-              670,
-              671,
-              672,
-              673,
-              674,
-              675
+              675,
+              676,
+              677,
+              678,
+              679,
+              680,
+              681
             ]
           }
         ],
@@ -9010,7 +9013,7 @@
         "implementedBy": [
           {
             "type": "reference",
-            "id": 658,
+            "id": 664,
             "name": "SkyViewkeeperHostOptions"
           }
         ]
@@ -9204,8 +9207,8 @@
           140,
           148,
           303,
-          640,
-          691,
+          646,
+          697,
           63,
           66,
           221,
@@ -9227,11 +9230,11 @@
           540,
           580,
           563,
-          614,
-          647,
-          658,
-          676,
-          679,
+          617,
+          653,
+          664,
+          682,
+          685,
           1,
           26,
           34
@@ -9244,7 +9247,7 @@
           117,
           131,
           134,
-          638,
+          644,
           218,
           235,
           241,
@@ -9252,7 +9255,7 @@
           111,
           413,
           482,
-          668
+          674
         ]
       },
       {