@skyux/layout 7.4.2 → 7.6.0

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
@@ -142,7 +142,7 @@ class SkyActionButtonContainerComponent {
142
142
  __classPrivateFieldSet(this, _SkyActionButtonContainerComponent_themeSvc, themeSvc, "f");
143
143
  }
144
144
  /**
145
- * Specifies how to display the action buttons inside the action button container.
145
+ * How to display the action buttons inside the action button container.
146
146
  * Options are `"center"` or `"left"`.
147
147
  * @default "center"
148
148
  */
@@ -519,7 +519,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
519
519
  }], ctorParameters: function () { return [{ type: i1$1.SkyAppWindowRef }, { type: i1$1.SkyScrollableHostService }]; } });
520
520
 
521
521
  /**
522
- * Specifies the type of message to send to the back to top component.
522
+ * The type of message to send to the back to top component.
523
523
  */
524
524
  var SkyBackToTopMessageType;
525
525
  (function (SkyBackToTopMessageType) {
@@ -550,14 +550,14 @@ class SkyBackToTopDirective {
550
550
  __classPrivateFieldSet(this, _SkyBackToTopDirective_elementRef, elementRef, "f");
551
551
  }
552
552
  /**
553
- * Specifies configuration options for the back to top component.
553
+ * Configuration options for the back to top component.
554
554
  */
555
555
  set skyBackToTop(value) {
556
556
  __classPrivateFieldSet(this, _SkyBackToTopDirective_buttonHidden, !!(value && value?.buttonHidden), "f");
557
557
  __classPrivateFieldGet(this, _SkyBackToTopDirective_instances, "m", _SkyBackToTopDirective_handleBackToTopButton).call(this, __classPrivateFieldGet(this, _SkyBackToTopDirective_elementInView, "f"));
558
558
  }
559
559
  /**
560
- * Provides an observable to send commands to the back to top component.
560
+ * The observable to send commands to the back to top component.
561
561
  * The commands respect the `SkyBackToTopMessage` type.
562
562
  */
563
563
  set skyBackToTopMessageStream(value) {
@@ -746,7 +746,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
746
746
  }]
747
747
  }] });
748
748
 
749
- 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;
749
+ 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;
750
750
  /**
751
751
  * @internal
752
752
  */
@@ -756,7 +756,7 @@ class SkyInlineDeleteAdapterService {
756
756
  _SkyInlineDeleteAdapterService_element.set(this, void 0);
757
757
  _SkyInlineDeleteAdapterService_focusableElements.set(this, void 0);
758
758
  _SkyInlineDeleteAdapterService_parentEl.set(this, void 0);
759
- _SkyInlineDeleteAdapterService_parentElUnlistenFn.set(this, void 0);
759
+ _SkyInlineDeleteAdapterService_parentElClearListenerFn.set(this, void 0);
760
760
  _SkyInlineDeleteAdapterService_renderer.set(this, void 0);
761
761
  _SkyInlineDeleteAdapterService_coreAdapterService.set(this, void 0);
762
762
  __classPrivateFieldSet(this, _SkyInlineDeleteAdapterService_coreAdapterService, coreAdapterService, "f");
@@ -764,8 +764,8 @@ class SkyInlineDeleteAdapterService {
764
764
  }
765
765
  clearListeners() {
766
766
  /* istanbul ignore else */
767
- if (__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentElUnlistenFn, "f")) {
768
- __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentElUnlistenFn, "f").call(this);
767
+ if (__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentElClearListenerFn, "f")) {
768
+ __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentElClearListenerFn, "f").call(this);
769
769
  }
770
770
  }
771
771
  setEl(element) {
@@ -773,7 +773,7 @@ class SkyInlineDeleteAdapterService {
773
773
  __classPrivateFieldSet(this, _SkyInlineDeleteAdapterService_parentEl, element.parentElement, "f");
774
774
  /* istanbul ignore else */
775
775
  if (__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentEl, "f")) {
776
- __classPrivateFieldSet(this, _SkyInlineDeleteAdapterService_parentElUnlistenFn, __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_renderer, "f").listen(__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentEl, "f"), 'focusin', (event) => {
776
+ __classPrivateFieldSet(this, _SkyInlineDeleteAdapterService_parentElClearListenerFn, __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_renderer, "f").listen(__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentEl, "f"), 'focusin', (event) => {
777
777
  if (__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_element, "f")) {
778
778
  const target = event.target;
779
779
  if (!__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_element, "f").contains(target) && __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_parentEl, "f") !== target) {
@@ -788,7 +788,7 @@ class SkyInlineDeleteAdapterService {
788
788
  }
789
789
  }
790
790
  }
791
- _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) {
791
+ _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) {
792
792
  const focusable = __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_instances, "m", _SkyInlineDeleteAdapterService_getFocusableElements).call(this);
793
793
  // If shift tab, go in the other direction
794
794
  const modifier = shiftKey ? -1 : 1;
@@ -831,7 +831,7 @@ _SkyInlineDeleteAdapterService_element = new WeakMap(), _SkyInlineDeleteAdapterS
831
831
  // clear focusableElements list so that if things change between tabbing we know about it
832
832
  __classPrivateFieldSet(this, _SkyInlineDeleteAdapterService_focusableElements, undefined, "f");
833
833
  }, _SkyInlineDeleteAdapterService_getFocusableElements = function _SkyInlineDeleteAdapterService_getFocusableElements() {
834
- // Keep this cached so we can reduce querys
834
+ // Keep this cached so we can reduce queries
835
835
  if (__classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_focusableElements, "f")) {
836
836
  return __classPrivateFieldGet(this, _SkyInlineDeleteAdapterService_focusableElements, "f");
837
837
  }
@@ -865,7 +865,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
865
865
  }], ctorParameters: function () { return [{ type: i1$1.SkyCoreAdapterService }, { type: i0.RendererFactory2 }]; } });
866
866
 
867
867
  /**
868
- * Specifies the type of inline delete that is shown.
868
+ * The type of inline delete that is shown.
869
869
  * @internal
870
870
  */
871
871
  var SkyInlineDeleteType;
@@ -888,7 +888,7 @@ let nextId$2 = 0;
888
888
  class SkyInlineDeleteComponent {
889
889
  constructor(adapterService, changeDetector, elRef) {
890
890
  /**
891
- * Indicates whether the deletion is pending.
891
+ * Whether the deletion is pending.
892
892
  * @default false
893
893
  */
894
894
  this.pending = false;
@@ -1109,13 +1109,13 @@ var _SkyCardComponent_subscription, _SkyCardComponent__size;
1109
1109
  class SkyCardComponent {
1110
1110
  constructor(logger) {
1111
1111
  /**
1112
- * Indicates whether to display a checkbox to the right of the card title.
1112
+ * Whether to display a checkbox to the right of the card title.
1113
1113
  * Users can select multiple checkboxes and perform actions on the selected cards.
1114
1114
  * @default false
1115
1115
  */
1116
1116
  this.selectable = false;
1117
1117
  /**
1118
- * Indicates whether the card is selected. This only applies to card where
1118
+ * Whether the card is selected. This only applies to card where
1119
1119
  * `selectable` is set to `true`.
1120
1120
  * @default false
1121
1121
  */
@@ -1134,7 +1134,7 @@ class SkyCardComponent {
1134
1134
  });
1135
1135
  }
1136
1136
  /**
1137
- * Specifies the size of the card. The valid options are `"large"` and `"small"`.
1137
+ * The size of the card. The valid options are `"large"` and `"small"`.
1138
1138
  * @default "large"
1139
1139
  */
1140
1140
  set size(value) {
@@ -1331,14 +1331,14 @@ class SkyDefinitionListComponent {
1331
1331
  });
1332
1332
  }
1333
1333
  /**
1334
- * Specifies the width of the label portion of the definition list.
1334
+ * The width of the label portion of the definition list.
1335
1335
  * @default "90px"
1336
1336
  */
1337
1337
  set labelWidth(value) {
1338
1338
  this.service.labelWidth.next(value);
1339
1339
  }
1340
1340
  /**
1341
- * Specifies a default value to display when no value is provided
1341
+ * The default value to display when no value is provided
1342
1342
  * for a label-value pair.
1343
1343
  * @default "None found"
1344
1344
  */
@@ -1563,7 +1563,7 @@ class SkyDescriptionListComponent {
1563
1563
  __classPrivateFieldSet(this, _SkyDescriptionListComponent_descriptionListService, descriptionListService, "f");
1564
1564
  }
1565
1565
  /**
1566
- * Specifies a default description to display when no description is provided
1566
+ * The default description to display when no description is provided
1567
1567
  * for a term-description pair.
1568
1568
  * @default "None found"
1569
1569
  */
@@ -1571,8 +1571,7 @@ class SkyDescriptionListComponent {
1571
1571
  __classPrivateFieldGet(this, _SkyDescriptionListComponent_descriptionListService, "f").updateDefaultDescription(value);
1572
1572
  }
1573
1573
  /**
1574
- * Specifies how to display term-description pairs within the description list.
1575
- * Options include `"horizontal"`, `"longDescription"`, and `"vertical"`.
1574
+ * How to display term-description pairs within the description list.
1576
1575
  * @default "vertical"
1577
1576
  */
1578
1577
  set mode(value) {
@@ -1681,7 +1680,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
1681
1680
  /**
1682
1681
  * @deprecated Use `SkyDescriptionListModeType` instead.
1683
1682
  * @internal
1684
- * Specifies how to display the term-description pairs within a description list.
1683
+ * How to display the term-description pairs within a description list.
1685
1684
  */
1686
1685
  var SkyDescriptionListMode;
1687
1686
  (function (SkyDescriptionListMode) {
@@ -1711,7 +1710,7 @@ class SkyColumnComponent {
1711
1710
  _SkyColumnComponent__screenXSmall.set(this, 12);
1712
1711
  }
1713
1712
  /**
1714
- * Specifies the number of columns (1-12) to use on extra-small screens
1713
+ * The number of columns (1-12) on extra-small screens
1715
1714
  * (less than 768px). If you do not specify a value, the fluid grid displays
1716
1715
  * the column at the full width of the screen.
1717
1716
  * @default 12
@@ -1785,7 +1784,7 @@ class SkyFluidGridComponent {
1785
1784
  _SkyFluidGridComponent__gutterSize.set(this, 'large');
1786
1785
  }
1787
1786
  /**
1788
- * Specifies a `SkyFluidGridGutterSizeType` to define the size of the padding
1787
+ * The type that defines the size of the padding
1789
1788
  * between columns.
1790
1789
  * @default "large"
1791
1790
  */
@@ -1815,7 +1814,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
1815
1814
  class SkyRowComponent {
1816
1815
  constructor() {
1817
1816
  /**
1818
- * Indicates whether to reverse the display order for columns in the row.
1817
+ * Whether to reverse the display order for columns in the row.
1819
1818
  * @default false
1820
1819
  */
1821
1820
  this.reverseColumnOrder = false;
@@ -1971,7 +1970,7 @@ class SkyPageComponent {
1971
1970
  __classPrivateFieldSet(this, _SkyPageComponent_themeAdapter, themeAdapter, "f");
1972
1971
  }
1973
1972
  /**
1974
- * Specifies the page layout. Use `auto` to allow the page contents
1973
+ * The page layout. Use `auto` to allow the page contents
1975
1974
  * to expand beyond the bottom of the browser window. Use `fit`
1976
1975
  * to constrain the page contents to the available viewport.
1977
1976
  */
@@ -2315,7 +2314,7 @@ class SkyTextExpandComponent {
2315
2314
  constructor(resources, modalSvc, textExpandAdapter) {
2316
2315
  _SkyTextExpandComponent_instances.add(this);
2317
2316
  /**
2318
- * Indicates whether to replace newline characters in truncated text with spaces.
2317
+ * Whether to replace newline characters in truncated text with spaces.
2319
2318
  */
2320
2319
  this.truncateNewlines = true;
2321
2320
  this.buttonText = '';
@@ -2341,7 +2340,7 @@ class SkyTextExpandComponent {
2341
2340
  __classPrivateFieldSet(this, _SkyTextExpandComponent_textExpandAdapter, textExpandAdapter, "f");
2342
2341
  }
2343
2342
  /**
2344
- * Specifies the maximum number of text characters to display inline when users select the link
2343
+ * The maximum number of text characters to display inline when users select the link
2345
2344
  * to expand the full text. If the text exceeds this limit, then the component expands
2346
2345
  * the full text in a modal instead.
2347
2346
  * @default 600
@@ -2359,7 +2358,7 @@ class SkyTextExpandComponent {
2359
2358
  return __classPrivateFieldGet(this, _SkyTextExpandComponent__maxExpandedLength, "f");
2360
2359
  }
2361
2360
  /**
2362
- * Specifies the maximum number of newline characters to display inline when users select
2361
+ * The maximum number of newline characters to display inline when users select
2363
2362
  * the link to expand the full text. If the text exceeds this limit, then
2364
2363
  * the component expands the full text in a modal view instead.
2365
2364
  * @default 2
@@ -2377,7 +2376,7 @@ class SkyTextExpandComponent {
2377
2376
  return __classPrivateFieldGet(this, _SkyTextExpandComponent__maxExpandedNewlines, "f");
2378
2377
  }
2379
2378
  /**
2380
- * Specifies the number of text characters to display before truncating the text.
2379
+ * The number of text characters to display before truncating the text.
2381
2380
  * To avoid truncating text in the middle of a word, the component looks for a space
2382
2381
  * in the 10 characters before the last character.
2383
2382
  * @default 200
@@ -2395,7 +2394,7 @@ class SkyTextExpandComponent {
2395
2394
  return __classPrivateFieldGet(this, _SkyTextExpandComponent__maxLength, "f");
2396
2395
  }
2397
2396
  /**
2398
- * Specifies the text to truncate.
2397
+ * The text to truncate.
2399
2398
  */
2400
2399
  set text(value) {
2401
2400
  __classPrivateFieldSet(this, _SkyTextExpandComponent__text, value ?? '', "f");
@@ -2665,7 +2664,7 @@ class SkyTextExpandRepeaterComponent {
2665
2664
  constructor(resources, elRef, textExpandRepeaterAdapter, changeDetector) {
2666
2665
  _SkyTextExpandRepeaterComponent_instances.add(this);
2667
2666
  /**
2668
- * Specifies the style of bullet to use
2667
+ * The style of bullet to use
2669
2668
  * @default "unordered"
2670
2669
  */
2671
2670
  this.listStyle = 'unordered';
@@ -2688,7 +2687,7 @@ class SkyTextExpandRepeaterComponent {
2688
2687
  __classPrivateFieldSet(this, _SkyTextExpandRepeaterComponent_changeDetector, changeDetector, "f");
2689
2688
  }
2690
2689
  /**
2691
- * Specifies the data to truncate.
2690
+ * The data to truncate.
2692
2691
  */
2693
2692
  set data(value) {
2694
2693
  __classPrivateFieldSet(this, _SkyTextExpandRepeaterComponent__data, value, "f");
@@ -2702,7 +2701,7 @@ class SkyTextExpandRepeaterComponent {
2702
2701
  return __classPrivateFieldGet(this, _SkyTextExpandRepeaterComponent__data, "f");
2703
2702
  }
2704
2703
  /**
2705
- * Specifies the number of items to display before truncating the list. If not supplied, all items are shown.
2704
+ * The number of items to display before truncating the list. If not supplied, all items are shown.
2706
2705
  */
2707
2706
  set maxItems(value) {
2708
2707
  __classPrivateFieldSet(this, _SkyTextExpandRepeaterComponent__maxItems, value, "f");