@skyux/tabs 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 (31) hide show
  1. package/documentation.json +49 -49
  2. package/esm2020/lib/modules/sectioned-form/sectioned-form-section.component.mjs +2 -2
  3. package/esm2020/lib/modules/sectioned-form/sectioned-form.component.mjs +2 -2
  4. package/esm2020/lib/modules/tabs/tab.component.mjs +5 -5
  5. package/esm2020/lib/modules/tabs/tabset-nav-button-type.mjs +1 -1
  6. package/esm2020/lib/modules/tabs/tabset-nav-button.component.mjs +4 -4
  7. package/esm2020/lib/modules/tabs/tabset-permalink.service.mjs +2 -2
  8. package/esm2020/lib/modules/tabs/tabset.component.mjs +2 -2
  9. package/esm2020/lib/modules/vertical-tabset/vertical-tab-media-query.service.mjs +5 -5
  10. package/esm2020/lib/modules/vertical-tabset/vertical-tab.component.mjs +6 -6
  11. package/esm2020/lib/modules/vertical-tabset/vertical-tabset-group.component.mjs +1 -1
  12. package/esm2020/lib/modules/vertical-tabset/vertical-tabset.component.mjs +3 -3
  13. package/esm2020/lib/modules/vertical-tabset/vertical-tabset.service.mjs +2 -2
  14. package/esm2020/testing/tabs/tab-fixture-tab.mjs +1 -1
  15. package/fesm2015/skyux-tabs.mjs +23 -23
  16. package/fesm2015/skyux-tabs.mjs.map +1 -1
  17. package/fesm2020/skyux-tabs.mjs +23 -23
  18. package/fesm2020/skyux-tabs.mjs.map +1 -1
  19. package/lib/modules/sectioned-form/sectioned-form-section.component.d.ts +3 -4
  20. package/lib/modules/sectioned-form/sectioned-form.component.d.ts +1 -1
  21. package/lib/modules/tabs/tab.component.d.ts +5 -5
  22. package/lib/modules/tabs/tabset-nav-button-type.d.ts +1 -1
  23. package/lib/modules/tabs/tabset-nav-button.component.d.ts +4 -4
  24. package/lib/modules/tabs/tabset-permalink.service.d.ts +1 -1
  25. package/lib/modules/tabs/tabset.component.d.ts +3 -3
  26. package/lib/modules/vertical-tabset/vertical-tab-media-query.service.d.ts +1 -1
  27. package/lib/modules/vertical-tabset/vertical-tab.component.d.ts +8 -8
  28. package/lib/modules/vertical-tabset/vertical-tabset-group.component.d.ts +3 -3
  29. package/lib/modules/vertical-tabset/vertical-tabset.component.d.ts +5 -5
  30. package/package.json +9 -9
  31. package/testing/tabs/tab-fixture-tab.d.ts +2 -2
@@ -97,13 +97,13 @@ class SkyVerticalTabMediaQueryService {
97
97
  }
98
98
  setBreakpointForWidth(width) {
99
99
  let breakpoint;
100
- if (this.isWidthWithinBreakpiont(width, SkyMediaBreakpoints.xs)) {
100
+ if (this.isWidthWithinBreakpoint(width, SkyMediaBreakpoints.xs)) {
101
101
  breakpoint = SkyMediaBreakpoints.xs;
102
102
  }
103
- else if (this.isWidthWithinBreakpiont(width, SkyMediaBreakpoints.sm)) {
103
+ else if (this.isWidthWithinBreakpoint(width, SkyMediaBreakpoints.sm)) {
104
104
  breakpoint = SkyMediaBreakpoints.sm;
105
105
  }
106
- else if (this.isWidthWithinBreakpiont(width, SkyMediaBreakpoints.md)) {
106
+ else if (this.isWidthWithinBreakpoint(width, SkyMediaBreakpoints.md)) {
107
107
  breakpoint = SkyMediaBreakpoints.md;
108
108
  }
109
109
  else {
@@ -112,7 +112,7 @@ class SkyVerticalTabMediaQueryService {
112
112
  this.current = breakpoint;
113
113
  __classPrivateFieldGet(this, _SkyVerticalTabMediaQueryService_currentSubject, "f").next(this.current);
114
114
  }
115
- isWidthWithinBreakpiont(width, breakpoint) {
115
+ isWidthWithinBreakpoint(width, breakpoint) {
116
116
  const xsBreakpointMaxPixels = 767;
117
117
  const smBreakpointMinPixels = 768;
118
118
  const smBreakpointMaxPixels = 991;
@@ -271,7 +271,7 @@ class SkyVerticalTabsetService {
271
271
  }
272
272
  }
273
273
  activateTab(tab) {
274
- // unactivate active tab
274
+ // deactivate active tab
275
275
  const activeTab = this.tabs.find((t) => t.index === this.activeIndex);
276
276
  if (activeTab && activeTab.index !== tab.index) {
277
277
  activeTab.active = false;
@@ -408,15 +408,15 @@ class SkyVerticalTabComponent {
408
408
  constructor(adapterService, changeRef, tabsetService, verticalTabMediaQueryService, tabIdSvc) {
409
409
  _SkyVerticalTabComponent_instances.add(this);
410
410
  /**
411
- * Indicates whether the tab is active when the tabset loads.
411
+ * Whether the tab is active when the tabset loads.
412
412
  */
413
413
  this.active = false;
414
414
  /**
415
- * Indicates whether to disable the tab.
415
+ * Whether to disable the tab.
416
416
  */
417
417
  this.disabled = false;
418
418
  /**
419
- * Indicates whether to indicate that the tab has an error.
419
+ * Whether to indicate that the tab has an error.
420
420
  * @internal This is used for sectioned forms and is not currently a supported design for pure vertical tabs.
421
421
  */
422
422
  this.errorIndicator = false;
@@ -441,7 +441,7 @@ class SkyVerticalTabComponent {
441
441
  this.tabId = __classPrivateFieldGet(this, _SkyVerticalTabComponent_defaultTabId, "f");
442
442
  }
443
443
  /**
444
- * Specifies an ARIA role for the vertical tab
444
+ * The ARIA role for the vertical tab
445
445
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)
446
446
  * by indicating how the tab functions and what it controls. For information about how
447
447
  * an ARIA role indicates what an item represents on a web page, see the
@@ -457,7 +457,7 @@ class SkyVerticalTabComponent {
457
457
  __classPrivateFieldSet(this, _SkyVerticalTabComponent__ariaRole, value ?? 'tab', "f");
458
458
  }
459
459
  /**
460
- * Specifies an ID for the tab.
460
+ * The ID for the tab.
461
461
  * @deprecated Now that the vertical tabs provide aria labels automatically, this input is no longer necessary.
462
462
  */
463
463
  set tabId(value) {
@@ -675,7 +675,7 @@ class SkyVerticalTabsetComponent {
675
675
  this.adapterService = adapterService;
676
676
  this.tabService = tabService;
677
677
  /**
678
- * Indicates whether the vertical tabset loads tab content during initialization so that it
678
+ * Whether the vertical tabset loads tab content during initialization so that it
679
679
  * displays content without moving around elements in the content container.
680
680
  * @default false
681
681
  */
@@ -700,7 +700,7 @@ class SkyVerticalTabsetComponent {
700
700
  });
701
701
  }
702
702
  /**
703
- * Specifies an ARIA role for the vertical tabset
703
+ * The ARIA role for the vertical tabset
704
704
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)
705
705
  * by indicating how the tabset functions and what it controls. For information about how
706
706
  * an ARIA role indicates what an item represents on a web page, see the
@@ -903,7 +903,7 @@ class SkySectionedFormSectionComponent {
903
903
  this.sectionTabId = `sky-sectioned-form-tab-${++nextId$1}`;
904
904
  this.sectionContentId = `sky-sectioned-form-section-${++nextId$1}`;
905
905
  /**
906
- * Indicates whether the section is active when the form loads.
906
+ * Whether the section is active when the form loads.
907
907
  * @default false
908
908
  */
909
909
  this.active = false;
@@ -957,7 +957,7 @@ class SkySectionedFormComponent {
957
957
  constructor(tabService, changeRef, tabIdSvc) {
958
958
  this.tabService = tabService;
959
959
  /**
960
- * Indicates whether the sectioned form loads section content during initialization so that it
960
+ * Whether the sectioned form loads section content during initialization so that it
961
961
  * displays content without moving around elements in the content container.
962
962
  * @default false
963
963
  */
@@ -1505,7 +1505,7 @@ class SkyTabsetPermalinkService {
1505
1505
  this.setParam(name, null);
1506
1506
  }
1507
1507
  /**
1508
- * Returns a relative URL that includes the provided query parameter. The value is inteded to be
1508
+ * Returns a relative URL that includes the provided query parameter. The value is intended to be
1509
1509
  * used by an HTML anchor element.
1510
1510
  */
1511
1511
  getParamHref(name, value) {
@@ -1592,7 +1592,7 @@ class SkyTabComponent {
1592
1592
  __classPrivateFieldGet(this, _SkyTabComponent_instances, "m", _SkyTabComponent_setPermalinkValueOrDefault).call(this);
1593
1593
  }
1594
1594
  /**
1595
- * Indicates whether the tab is active when the tabset loads. After initialization, the `active`
1595
+ * Whether the tab is active when the tabset loads. After initialization, the `active`
1596
1596
  * property on the tabset component should be used to set the active tab.
1597
1597
  * @default false
1598
1598
  */
@@ -1609,7 +1609,7 @@ class SkyTabComponent {
1609
1609
  return __classPrivateFieldGet(this, _SkyTabComponent_activeChange, "f");
1610
1610
  }
1611
1611
  /**
1612
- * Specifies a custom query parameter value for the tab.
1612
+ * The custom query parameter value for the tab.
1613
1613
  * This works in conjunction with the tabset's `permalinkId` to distinguish
1614
1614
  * the tab's unique state in the URL by generating a query parameter that is
1615
1615
  * written as `?<queryParam>-active-tab=<sanitized-tab-heading`.
@@ -1624,7 +1624,7 @@ class SkyTabComponent {
1624
1624
  return __classPrivateFieldGet(this, _SkyTabComponent__permalinkValue, "f");
1625
1625
  }
1626
1626
  /**
1627
- * Specifies the tab header.
1627
+ * The tab header.
1628
1628
  * When using tabs as the main navigation on a page,
1629
1629
  * use [the Angular `Title` service](https://angular.io/docs/ts/latest/cookbook/set-document-title.html)
1630
1630
  * and [the SKY UX `title` configuration property](https://developer.blackbaud.com/skyux/learn/reference/configuration#app)
@@ -1639,7 +1639,7 @@ class SkyTabComponent {
1639
1639
  return __classPrivateFieldGet(this, _SkyTabComponent__tabHeading, "f");
1640
1640
  }
1641
1641
  /**
1642
- * Specifies a unique identifier for the tab.
1642
+ * The unique identifier for the tab.
1643
1643
  * If not defined, the identifier is set to the position of the tab on load, starting with `0`.
1644
1644
  */
1645
1645
  set tabIndex(value) {
@@ -1763,7 +1763,7 @@ class SkyTabsetNavButtonComponent {
1763
1763
  __classPrivateFieldSet(this, _SkyTabsetNavButtonComponent_logger, logger, "f");
1764
1764
  }
1765
1765
  /**
1766
- * Specifies the tabset wizard component to associate with the nav button.
1766
+ * The tabset wizard component to associate with the nav button.
1767
1767
  * @required
1768
1768
  */
1769
1769
  get tabset() {
@@ -1790,7 +1790,7 @@ class SkyTabsetNavButtonComponent {
1790
1790
  }
1791
1791
  }
1792
1792
  /**
1793
- * Specifies the type of nav button to include.
1793
+ * The type of nav button to include.
1794
1794
  * @required
1795
1795
  */
1796
1796
  get buttonType() {
@@ -1809,7 +1809,7 @@ class SkyTabsetNavButtonComponent {
1809
1809
  }
1810
1810
  }
1811
1811
  /**
1812
- * Indicates whether to disable the nav button.
1812
+ * Whether to disable the nav button.
1813
1813
  * Defaults to the disabled state of the next tab for `next`, the existence of a previous tab for `previous`,
1814
1814
  * and false for `finish`.
1815
1815
  */
@@ -2043,7 +2043,7 @@ class SkyTabsetComponent {
2043
2043
  return __classPrivateFieldGet(this, _SkyTabsetComponent__permalinkId, "f");
2044
2044
  }
2045
2045
  /**
2046
- * Specifies the behavior for a series of tabs.
2046
+ * The behavior for a series of tabs.
2047
2047
  * @default "tabs"
2048
2048
  */
2049
2049
  set tabStyle(value) {