@skyux/layout 7.5.0 → 7.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/documentation.json +74 -74
  2. package/esm2020/lib/modules/action-button/action-button-container.component.mjs +2 -2
  3. package/esm2020/lib/modules/action-button/action-button-icon.component.mjs +1 -1
  4. package/esm2020/lib/modules/action-button/action-button-permalink.mjs +1 -1
  5. package/esm2020/lib/modules/action-button/action-button.component.mjs +1 -1
  6. package/esm2020/lib/modules/back-to-top/back-to-top.directive.mjs +3 -3
  7. package/esm2020/lib/modules/back-to-top/models/back-to-top-message-type.mjs +2 -2
  8. package/esm2020/lib/modules/back-to-top/models/back-to-top-message.mjs +1 -1
  9. package/esm2020/lib/modules/back-to-top/models/back-to-top-options.mjs +1 -1
  10. package/esm2020/lib/modules/box/box.component.mjs +1 -1
  11. package/esm2020/lib/modules/card/card.component.mjs +4 -4
  12. package/esm2020/lib/modules/definition-list/definition-list.component.mjs +3 -3
  13. package/esm2020/lib/modules/description-list/description-list.component.mjs +3 -4
  14. package/esm2020/lib/modules/description-list/types/description-list-mode-type.mjs +1 -1
  15. package/esm2020/lib/modules/description-list/types/description-list-mode.mjs +2 -2
  16. package/esm2020/lib/modules/fluid-grid/column.component.mjs +2 -2
  17. package/esm2020/lib/modules/fluid-grid/fluid-grid.component.mjs +2 -2
  18. package/esm2020/lib/modules/fluid-grid/row.component.mjs +2 -2
  19. package/esm2020/lib/modules/inline-delete/inline-delete-adapter.service.mjs +8 -8
  20. package/esm2020/lib/modules/inline-delete/inline-delete-type.mjs +2 -2
  21. package/esm2020/lib/modules/inline-delete/inline-delete.component.mjs +2 -2
  22. package/esm2020/lib/modules/page/page.component.mjs +2 -2
  23. package/esm2020/lib/modules/text-expand/text-expand.component.mjs +6 -6
  24. package/esm2020/lib/modules/text-expand-repeater/text-expand-repeater.component.mjs +4 -4
  25. package/fesm2015/skyux-layout.mjs +33 -34
  26. package/fesm2015/skyux-layout.mjs.map +1 -1
  27. package/fesm2020/skyux-layout.mjs +33 -34
  28. package/fesm2020/skyux-layout.mjs.map +1 -1
  29. package/lib/modules/action-button/action-button-container.component.d.ts +1 -1
  30. package/lib/modules/action-button/action-button-icon.component.d.ts +1 -1
  31. package/lib/modules/action-button/action-button-permalink.d.ts +2 -2
  32. package/lib/modules/action-button/action-button.component.d.ts +1 -1
  33. package/lib/modules/back-to-top/back-to-top.directive.d.ts +2 -2
  34. package/lib/modules/back-to-top/models/back-to-top-message-type.d.ts +1 -1
  35. package/lib/modules/back-to-top/models/back-to-top-message.d.ts +1 -1
  36. package/lib/modules/back-to-top/models/back-to-top-options.d.ts +1 -1
  37. package/lib/modules/box/box.component.d.ts +3 -3
  38. package/lib/modules/card/card.component.d.ts +3 -3
  39. package/lib/modules/definition-list/definition-list.component.d.ts +2 -2
  40. package/lib/modules/description-list/description-list.component.d.ts +3 -4
  41. package/lib/modules/description-list/types/description-list-mode-type.d.ts +1 -1
  42. package/lib/modules/description-list/types/description-list-mode.d.ts +1 -1
  43. package/lib/modules/fluid-grid/column.component.d.ts +4 -4
  44. package/lib/modules/fluid-grid/fluid-grid.component.d.ts +1 -1
  45. package/lib/modules/fluid-grid/row.component.d.ts +1 -1
  46. package/lib/modules/inline-delete/inline-delete-type.d.ts +1 -1
  47. package/lib/modules/inline-delete/inline-delete.component.d.ts +1 -1
  48. package/lib/modules/page/page.component.d.ts +1 -1
  49. package/lib/modules/text-expand/text-expand.component.d.ts +6 -6
  50. package/lib/modules/text-expand-repeater/text-expand-repeater.component.d.ts +4 -4
  51. package/package.json +9 -9
@@ -145,7 +145,7 @@ class SkyActionButtonContainerComponent {
145
145
  __classPrivateFieldSet(this, _SkyActionButtonContainerComponent_themeSvc, themeSvc, "f");
146
146
  }
147
147
  /**
148
- * Specifies how to display the action buttons inside the action button container.
148
+ * How to display the action buttons inside the action button container.
149
149
  * Options are `"center"` or `"left"`.
150
150
  * @default "center"
151
151
  */
@@ -524,7 +524,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
524
524
  }], ctorParameters: function () { return [{ type: i1$1.SkyAppWindowRef }, { type: i1$1.SkyScrollableHostService }]; } });
525
525
 
526
526
  /**
527
- * Specifies the type of message to send to the back to top component.
527
+ * The type of message to send to the back to top component.
528
528
  */
529
529
  var SkyBackToTopMessageType;
530
530
  (function (SkyBackToTopMessageType) {
@@ -555,14 +555,14 @@ class SkyBackToTopDirective {
555
555
  __classPrivateFieldSet(this, _SkyBackToTopDirective_elementRef, elementRef, "f");
556
556
  }
557
557
  /**
558
- * Specifies configuration options for the back to top component.
558
+ * Configuration options for the back to top component.
559
559
  */
560
560
  set skyBackToTop(value) {
561
561
  __classPrivateFieldSet(this, _SkyBackToTopDirective_buttonHidden, !!(value && (value === null || value === void 0 ? void 0 : value.buttonHidden)), "f");
562
562
  __classPrivateFieldGet(this, _SkyBackToTopDirective_instances, "m", _SkyBackToTopDirective_handleBackToTopButton).call(this, __classPrivateFieldGet(this, _SkyBackToTopDirective_elementInView, "f"));
563
563
  }
564
564
  /**
565
- * Provides an observable to send commands to the back to top component.
565
+ * The observable to send commands to the back to top component.
566
566
  * The commands respect the `SkyBackToTopMessage` type.
567
567
  */
568
568
  set skyBackToTopMessageStream(value) {
@@ -750,7 +750,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
750
750
  }]
751
751
  }] });
752
752
 
753
- var _SkyInlineDeleteAdapterService_instances, _SkyInlineDeleteAdapterService_element, _SkyInlineDeleteAdapterService_focusableElements, _SkyInlineDeleteAdapterService_parentEl, _SkyInlineDeleteAdapterService_parentElUnlistenFn, _SkyInlineDeleteAdapterService_renderer, _SkyInlineDeleteAdapterService_coreAdapterService, _SkyInlineDeleteAdapterService_focusNextElement, _SkyInlineDeleteAdapterService_getFocusableElements, _SkyInlineDeleteAdapterService_isElementHiddenOrCovered, _SkyInlineDeleteAdapterService_isElementHidden, _SkyInlineDeleteAdapterService_isShift;
753
+ var _SkyInlineDeleteAdapterService_instances, _SkyInlineDeleteAdapterService_element, _SkyInlineDeleteAdapterService_focusableElements, _SkyInlineDeleteAdapterService_parentEl, _SkyInlineDeleteAdapterService_parentElClearListenerFn, _SkyInlineDeleteAdapterService_renderer, _SkyInlineDeleteAdapterService_coreAdapterService, _SkyInlineDeleteAdapterService_focusNextElement, _SkyInlineDeleteAdapterService_getFocusableElements, _SkyInlineDeleteAdapterService_isElementHiddenOrCovered, _SkyInlineDeleteAdapterService_isElementHidden, _SkyInlineDeleteAdapterService_isShift;
754
754
  /**
755
755
  * @internal
756
756
  */
@@ -760,7 +760,7 @@ class SkyInlineDeleteAdapterService {
760
760
  _SkyInlineDeleteAdapterService_element.set(this, void 0);
761
761
  _SkyInlineDeleteAdapterService_focusableElements.set(this, void 0);
762
762
  _SkyInlineDeleteAdapterService_parentEl.set(this, void 0);
763
- _SkyInlineDeleteAdapterService_parentElUnlistenFn.set(this, void 0);
763
+ _SkyInlineDeleteAdapterService_parentElClearListenerFn.set(this, void 0);
764
764
  _SkyInlineDeleteAdapterService_renderer.set(this, void 0);
765
765
  _SkyInlineDeleteAdapterService_coreAdapterService.set(this, void 0);
766
766
  __classPrivateFieldSet(this, _SkyInlineDeleteAdapterService_coreAdapterService, coreAdapterService, "f");
@@ -768,8 +768,8 @@ class SkyInlineDeleteAdapterService {
768
768
  }
769
769
  clearListeners() {
770
770
  /* istanbul ignore else */
771
- if (__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentElUnlistenFn, "f")) {
772
- __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentElUnlistenFn, "f").call(this);
771
+ if (__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentElClearListenerFn, "f")) {
772
+ __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentElClearListenerFn, "f").call(this);
773
773
  }
774
774
  }
775
775
  setEl(element) {
@@ -777,7 +777,7 @@ class SkyInlineDeleteAdapterService {
777
777
  __classPrivateFieldSet(this, _SkyInlineDeleteAdapterService_parentEl, element.parentElement, "f");
778
778
  /* istanbul ignore else */
779
779
  if (__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentEl, "f")) {
780
- __classPrivateFieldSet(this, _SkyInlineDeleteAdapterService_parentElUnlistenFn, __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_renderer, "f").listen(__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentEl, "f"), 'focusin', (event) => {
780
+ __classPrivateFieldSet(this, _SkyInlineDeleteAdapterService_parentElClearListenerFn, __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_renderer, "f").listen(__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentEl, "f"), 'focusin', (event) => {
781
781
  if (__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_element, "f")) {
782
782
  const target = event.target;
783
783
  if (!__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_element, "f").contains(target) && __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentEl, "f") !== target) {
@@ -792,7 +792,7 @@ class SkyInlineDeleteAdapterService {
792
792
  }
793
793
  }
794
794
  }
795
- _SkyInlineDeleteAdapterService_element = new WeakMap(), _SkyInlineDeleteAdapterService_focusableElements = new WeakMap(), _SkyInlineDeleteAdapterService_parentEl = new WeakMap(), _SkyInlineDeleteAdapterService_parentElUnlistenFn = new WeakMap(), _SkyInlineDeleteAdapterService_renderer = new WeakMap(), _SkyInlineDeleteAdapterService_coreAdapterService = new WeakMap(), _SkyInlineDeleteAdapterService_instances = new WeakSet(), _SkyInlineDeleteAdapterService_focusNextElement = function _SkyInlineDeleteAdapterService_focusNextElement(targetElement, shiftKey) {
795
+ _SkyInlineDeleteAdapterService_element = new WeakMap(), _SkyInlineDeleteAdapterService_focusableElements = new WeakMap(), _SkyInlineDeleteAdapterService_parentEl = new WeakMap(), _SkyInlineDeleteAdapterService_parentElClearListenerFn = new WeakMap(), _SkyInlineDeleteAdapterService_renderer = new WeakMap(), _SkyInlineDeleteAdapterService_coreAdapterService = new WeakMap(), _SkyInlineDeleteAdapterService_instances = new WeakSet(), _SkyInlineDeleteAdapterService_focusNextElement = function _SkyInlineDeleteAdapterService_focusNextElement(targetElement, shiftKey) {
796
796
  const focusable = __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_instances, "m", _SkyInlineDeleteAdapterService_getFocusableElements).call(this);
797
797
  // If shift tab, go in the other direction
798
798
  const modifier = shiftKey ? -1 : 1;
@@ -835,7 +835,7 @@ _SkyInlineDeleteAdapterService_element = new WeakMap(), _SkyInlineDeleteAdapterS
835
835
  // clear focusableElements list so that if things change between tabbing we know about it
836
836
  __classPrivateFieldSet(this, _SkyInlineDeleteAdapterService_focusableElements, undefined, "f");
837
837
  }, _SkyInlineDeleteAdapterService_getFocusableElements = function _SkyInlineDeleteAdapterService_getFocusableElements() {
838
- // Keep this cached so we can reduce querys
838
+ // Keep this cached so we can reduce queries
839
839
  if (__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_focusableElements, "f")) {
840
840
  return __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_focusableElements, "f");
841
841
  }
@@ -870,7 +870,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
870
870
  }], ctorParameters: function () { return [{ type: i1$1.SkyCoreAdapterService }, { type: i0.RendererFactory2 }]; } });
871
871
 
872
872
  /**
873
- * Specifies the type of inline delete that is shown.
873
+ * The type of inline delete that is shown.
874
874
  * @internal
875
875
  */
876
876
  var SkyInlineDeleteType;
@@ -893,7 +893,7 @@ let nextId$2 = 0;
893
893
  class SkyInlineDeleteComponent {
894
894
  constructor(adapterService, changeDetector, elRef) {
895
895
  /**
896
- * Indicates whether the deletion is pending.
896
+ * Whether the deletion is pending.
897
897
  * @default false
898
898
  */
899
899
  this.pending = false;
@@ -1115,13 +1115,13 @@ var _SkyCardComponent_subscription, _SkyCardComponent__size;
1115
1115
  class SkyCardComponent {
1116
1116
  constructor(logger) {
1117
1117
  /**
1118
- * Indicates whether to display a checkbox to the right of the card title.
1118
+ * Whether to display a checkbox to the right of the card title.
1119
1119
  * Users can select multiple checkboxes and perform actions on the selected cards.
1120
1120
  * @default false
1121
1121
  */
1122
1122
  this.selectable = false;
1123
1123
  /**
1124
- * Indicates whether the card is selected. This only applies to card where
1124
+ * Whether the card is selected. This only applies to card where
1125
1125
  * `selectable` is set to `true`.
1126
1126
  * @default false
1127
1127
  */
@@ -1140,7 +1140,7 @@ class SkyCardComponent {
1140
1140
  });
1141
1141
  }
1142
1142
  /**
1143
- * Specifies the size of the card. The valid options are `"large"` and `"small"`.
1143
+ * The size of the card. The valid options are `"large"` and `"small"`.
1144
1144
  * @default "large"
1145
1145
  */
1146
1146
  set size(value) {
@@ -1339,14 +1339,14 @@ class SkyDefinitionListComponent {
1339
1339
  });
1340
1340
  }
1341
1341
  /**
1342
- * Specifies the width of the label portion of the definition list.
1342
+ * The width of the label portion of the definition list.
1343
1343
  * @default "90px"
1344
1344
  */
1345
1345
  set labelWidth(value) {
1346
1346
  this.service.labelWidth.next(value);
1347
1347
  }
1348
1348
  /**
1349
- * Specifies a default value to display when no value is provided
1349
+ * The default value to display when no value is provided
1350
1350
  * for a label-value pair.
1351
1351
  * @default "None found"
1352
1352
  */
@@ -1573,7 +1573,7 @@ class SkyDescriptionListComponent {
1573
1573
  __classPrivateFieldSet(this, _SkyDescriptionListComponent_descriptionListService, descriptionListService, "f");
1574
1574
  }
1575
1575
  /**
1576
- * Specifies a default description to display when no description is provided
1576
+ * The default description to display when no description is provided
1577
1577
  * for a term-description pair.
1578
1578
  * @default "None found"
1579
1579
  */
@@ -1581,8 +1581,7 @@ class SkyDescriptionListComponent {
1581
1581
  __classPrivateFieldGet(this, _SkyDescriptionListComponent_descriptionListService, "f").updateDefaultDescription(value);
1582
1582
  }
1583
1583
  /**
1584
- * Specifies how to display term-description pairs within the description list.
1585
- * Options include `"horizontal"`, `"longDescription"`, and `"vertical"`.
1584
+ * How to display term-description pairs within the description list.
1586
1585
  * @default "vertical"
1587
1586
  */
1588
1587
  set mode(value) {
@@ -1691,7 +1690,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
1691
1690
  /**
1692
1691
  * @deprecated Use `SkyDescriptionListModeType` instead.
1693
1692
  * @internal
1694
- * Specifies how to display the term-description pairs within a description list.
1693
+ * How to display the term-description pairs within a description list.
1695
1694
  */
1696
1695
  var SkyDescriptionListMode;
1697
1696
  (function (SkyDescriptionListMode) {
@@ -1721,7 +1720,7 @@ class SkyColumnComponent {
1721
1720
  _SkyColumnComponent__screenXSmall.set(this, 12);
1722
1721
  }
1723
1722
  /**
1724
- * Specifies the number of columns (1-12) to use on extra-small screens
1723
+ * The number of columns (1-12) on extra-small screens
1725
1724
  * (less than 768px). If you do not specify a value, the fluid grid displays
1726
1725
  * the column at the full width of the screen.
1727
1726
  * @default 12
@@ -1795,7 +1794,7 @@ class SkyFluidGridComponent {
1795
1794
  _SkyFluidGridComponent__gutterSize.set(this, 'large');
1796
1795
  }
1797
1796
  /**
1798
- * Specifies a `SkyFluidGridGutterSizeType` to define the size of the padding
1797
+ * The type that defines the size of the padding
1799
1798
  * between columns.
1800
1799
  * @default "large"
1801
1800
  */
@@ -1825,7 +1824,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
1825
1824
  class SkyRowComponent {
1826
1825
  constructor() {
1827
1826
  /**
1828
- * Indicates whether to reverse the display order for columns in the row.
1827
+ * Whether to reverse the display order for columns in the row.
1829
1828
  * @default false
1830
1829
  */
1831
1830
  this.reverseColumnOrder = false;
@@ -1983,7 +1982,7 @@ class SkyPageComponent {
1983
1982
  __classPrivateFieldSet(this, _SkyPageComponent_themeAdapter, themeAdapter, "f");
1984
1983
  }
1985
1984
  /**
1986
- * Specifies the page layout. Use `auto` to allow the page contents
1985
+ * The page layout. Use `auto` to allow the page contents
1987
1986
  * to expand beyond the bottom of the browser window. Use `fit`
1988
1987
  * to constrain the page contents to the available viewport.
1989
1988
  */
@@ -2329,7 +2328,7 @@ class SkyTextExpandComponent {
2329
2328
  constructor(resources, modalSvc, textExpandAdapter) {
2330
2329
  _SkyTextExpandComponent_instances.add(this);
2331
2330
  /**
2332
- * Indicates whether to replace newline characters in truncated text with spaces.
2331
+ * Whether to replace newline characters in truncated text with spaces.
2333
2332
  */
2334
2333
  this.truncateNewlines = true;
2335
2334
  this.buttonText = '';
@@ -2355,7 +2354,7 @@ class SkyTextExpandComponent {
2355
2354
  __classPrivateFieldSet(this, _SkyTextExpandComponent_textExpandAdapter, textExpandAdapter, "f");
2356
2355
  }
2357
2356
  /**
2358
- * Specifies the maximum number of text characters to display inline when users select the link
2357
+ * The maximum number of text characters to display inline when users select the link
2359
2358
  * to expand the full text. If the text exceeds this limit, then the component expands
2360
2359
  * the full text in a modal instead.
2361
2360
  * @default 600
@@ -2373,7 +2372,7 @@ class SkyTextExpandComponent {
2373
2372
  return __classPrivateFieldGet(this, _SkyTextExpandComponent__maxExpandedLength, "f");
2374
2373
  }
2375
2374
  /**
2376
- * Specifies the maximum number of newline characters to display inline when users select
2375
+ * The maximum number of newline characters to display inline when users select
2377
2376
  * the link to expand the full text. If the text exceeds this limit, then
2378
2377
  * the component expands the full text in a modal view instead.
2379
2378
  * @default 2
@@ -2391,7 +2390,7 @@ class SkyTextExpandComponent {
2391
2390
  return __classPrivateFieldGet(this, _SkyTextExpandComponent__maxExpandedNewlines, "f");
2392
2391
  }
2393
2392
  /**
2394
- * Specifies the number of text characters to display before truncating the text.
2393
+ * The number of text characters to display before truncating the text.
2395
2394
  * To avoid truncating text in the middle of a word, the component looks for a space
2396
2395
  * in the 10 characters before the last character.
2397
2396
  * @default 200
@@ -2409,7 +2408,7 @@ class SkyTextExpandComponent {
2409
2408
  return __classPrivateFieldGet(this, _SkyTextExpandComponent__maxLength, "f");
2410
2409
  }
2411
2410
  /**
2412
- * Specifies the text to truncate.
2411
+ * The text to truncate.
2413
2412
  */
2414
2413
  set text(value) {
2415
2414
  __classPrivateFieldSet(this, _SkyTextExpandComponent__text, value !== null && value !== void 0 ? value : '', "f");
@@ -2679,7 +2678,7 @@ class SkyTextExpandRepeaterComponent {
2679
2678
  constructor(resources, elRef, textExpandRepeaterAdapter, changeDetector) {
2680
2679
  _SkyTextExpandRepeaterComponent_instances.add(this);
2681
2680
  /**
2682
- * Specifies the style of bullet to use
2681
+ * The style of bullet to use
2683
2682
  * @default "unordered"
2684
2683
  */
2685
2684
  this.listStyle = 'unordered';
@@ -2702,7 +2701,7 @@ class SkyTextExpandRepeaterComponent {
2702
2701
  __classPrivateFieldSet(this, _SkyTextExpandRepeaterComponent_changeDetector, changeDetector, "f");
2703
2702
  }
2704
2703
  /**
2705
- * Specifies the data to truncate.
2704
+ * The data to truncate.
2706
2705
  */
2707
2706
  set data(value) {
2708
2707
  __classPrivateFieldSet(this, _SkyTextExpandRepeaterComponent__data, value, "f");
@@ -2716,7 +2715,7 @@ class SkyTextExpandRepeaterComponent {
2716
2715
  return __classPrivateFieldGet(this, _SkyTextExpandRepeaterComponent__data, "f");
2717
2716
  }
2718
2717
  /**
2719
- * Specifies the number of items to display before truncating the list. If not supplied, all items are shown.
2718
+ * The number of items to display before truncating the list. If not supplied, all items are shown.
2720
2719
  */
2721
2720
  set maxItems(value) {
2722
2721
  __classPrivateFieldSet(this, _SkyTextExpandRepeaterComponent__maxItems, value, "f");