@skyux/indicators 6.16.0 → 6.18.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 (35) hide show
  1. package/documentation.json +1146 -464
  2. package/esm2020/lib/modules/alert/alert.component.mjs +71 -15
  3. package/esm2020/lib/modules/key-info/key-info-label.component.mjs +3 -1
  4. package/esm2020/lib/modules/shared/sky-indicators-resources.module.mjs +10 -1
  5. package/esm2020/lib/modules/text-highlight/text-highlight.directive.mjs +109 -103
  6. package/esm2020/testing/alert/alert-harness-filters.mjs +1 -1
  7. package/esm2020/testing/alert/alert-harness.mjs +2 -1
  8. package/esm2020/testing/alert-fixture.mjs +2 -1
  9. package/esm2020/testing/label-fixture.mjs +2 -1
  10. package/esm2020/testing/tokens/token-harness-filters.mjs +1 -1
  11. package/esm2020/testing/tokens/token-harness.mjs +2 -1
  12. package/esm2020/testing/tokens/tokens-harness-filters.mjs +1 -1
  13. package/esm2020/testing/tokens/tokens-harness.mjs +2 -1
  14. package/esm2020/testing/wait-fixture.mjs +4 -1
  15. package/fesm2015/skyux-indicators-testing.mjs +8 -0
  16. package/fesm2015/skyux-indicators-testing.mjs.map +1 -1
  17. package/fesm2015/skyux-indicators.mjs +206 -135
  18. package/fesm2015/skyux-indicators.mjs.map +1 -1
  19. package/fesm2020/skyux-indicators-testing.mjs +8 -0
  20. package/fesm2020/skyux-indicators-testing.mjs.map +1 -1
  21. package/fesm2020/skyux-indicators.mjs +206 -135
  22. package/fesm2020/skyux-indicators.mjs.map +1 -1
  23. package/lib/modules/alert/alert.component.d.ts +18 -3
  24. package/lib/modules/key-info/key-info-label.component.d.ts +2 -0
  25. package/lib/modules/text-highlight/text-highlight.directive.d.ts +3 -14
  26. package/package.json +5 -5
  27. package/testing/alert/alert-harness-filters.d.ts +1 -0
  28. package/testing/alert/alert-harness.d.ts +1 -0
  29. package/testing/alert-fixture.d.ts +1 -0
  30. package/testing/label-fixture.d.ts +1 -0
  31. package/testing/tokens/token-harness-filters.d.ts +1 -0
  32. package/testing/tokens/token-harness.d.ts +1 -0
  33. package/testing/tokens/tokens-harness-filters.d.ts +1 -0
  34. package/testing/tokens/tokens-harness.d.ts +1 -0
  35. package/testing/wait-fixture.d.ts +3 -0
@@ -1,8 +1,10 @@
1
- import { EventEmitter, OnInit } from '@angular/core';
1
+ import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
2
+ import { SkyLibResourcesService } from '@skyux/i18n';
2
3
  import { SkyIconStackItem } from '../icon/icon-stack-item';
4
+ import { SkyIndicatorDescriptionType } from '../shared/indicator-description-type';
3
5
  import { SkyIndicatorIconType } from '../shared/indicator-icon-type';
4
6
  import * as i0 from "@angular/core";
5
- export declare class SkyAlertComponent implements OnInit {
7
+ export declare class SkyAlertComponent implements OnInit, OnDestroy {
6
8
  #private;
7
9
  /**
8
10
  * Specifies a style for the alert to determine the icon and background color.
@@ -20,6 +22,16 @@ export declare class SkyAlertComponent implements OnInit {
20
22
  * @default false
21
23
  */
22
24
  closed: boolean | undefined;
25
+ /**
26
+ * Specifies the predefined text to be read by screen readers for users who cannot see the alert icon.
27
+ * This property is optional but will be required in future versions of SKY UX.
28
+ */
29
+ set descriptionType(value: SkyIndicatorDescriptionType | undefined);
30
+ /**
31
+ * Specifies the text to be read by screen readers for users who cannot see
32
+ * the indicator icon when `descriptionType` is `custom`.
33
+ */
34
+ set customDescription(value: string | undefined);
23
35
  /**
24
36
  * Fires when users close the alert.
25
37
  */
@@ -27,8 +39,11 @@ export declare class SkyAlertComponent implements OnInit {
27
39
  alertBaseIcon: SkyIconStackItem | undefined;
28
40
  alertTopIcon: SkyIconStackItem | undefined;
29
41
  alertTypeOrDefault: SkyIndicatorIconType;
42
+ descriptionComputed: string | undefined;
43
+ constructor(resources: SkyLibResourcesService);
30
44
  ngOnInit(): void;
45
+ ngOnDestroy(): void;
31
46
  close(): void;
32
47
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyAlertComponent, never>;
33
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyAlertComponent, "sky-alert", never, { "alertType": "alertType"; "closeable": "closeable"; "closed": "closed"; }, { "closedChange": "closedChange"; }, never, ["*"]>;
48
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyAlertComponent, "sky-alert", never, { "alertType": "alertType"; "closeable": "closeable"; "closed": "closed"; "descriptionType": "descriptionType"; "customDescription": "customDescription"; }, { "closedChange": "closedChange"; }, never, ["*"]>;
34
49
  }
@@ -1,6 +1,8 @@
1
1
  import * as i0 from "@angular/core";
2
2
  /**
3
3
  * Specifies a label to display in smaller text under or beside the value.
4
+ * To display a help button beside the label, include a help button element, such as `sky-help-inline`,
5
+ * in the `sky-key-info` element and a `sky-control-help` CSS class on that help button element.
4
6
  * @required
5
7
  */
6
8
  export declare class SkyKeyInfoLabelComponent {
@@ -5,26 +5,15 @@ import * as i0 from "@angular/core";
5
5
  * Highlights all matching text within the current DOM element.
6
6
  */
7
7
  export declare class SkyTextHighlightDirective implements OnChanges, AfterViewInit, OnDestroy {
8
- private el;
9
- private observerService;
8
+ #private;
10
9
  /**
11
10
  * Specifies the text to highlight.
12
11
  */
13
- set skyHighlight(value: string | string[]);
14
- private existingHighlight;
15
- private observer;
16
- private _skyHighlight;
17
- constructor(el: ElementRef, observerService: MutationObserverService);
18
- private static cleanRegex;
19
- private static markNode;
20
- private static markTextNodes;
21
- private static removeHighlight;
12
+ set skyHighlight(value: string | string[] | undefined);
13
+ constructor(el: ElementRef, observerSvc: MutationObserverService);
22
14
  ngOnChanges(changes: SimpleChanges): void;
23
15
  ngAfterViewInit(): void;
24
16
  ngOnDestroy(): void;
25
- private readyForHighlight;
26
- private highlight;
27
- private observeDom;
28
17
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyTextHighlightDirective, never>;
29
18
  static ɵdir: i0.ɵɵDirectiveDeclaration<SkyTextHighlightDirective, "[skyHighlight]", never, { "skyHighlight": "skyHighlight"; }, {}, never>;
30
19
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/indicators",
3
- "version": "6.16.0",
3
+ "version": "6.18.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -45,10 +45,10 @@
45
45
  "@angular/common": "^13.3.2",
46
46
  "@angular/core": "^13.3.2",
47
47
  "@angular/platform-browser": "^13.3.2",
48
- "@skyux-sdk/testing": "6.16.0",
49
- "@skyux/core": "6.16.0",
50
- "@skyux/i18n": "6.16.0",
51
- "@skyux/theme": "6.16.0"
48
+ "@skyux-sdk/testing": "6.18.0",
49
+ "@skyux/core": "6.18.0",
50
+ "@skyux/i18n": "6.18.0",
51
+ "@skyux/theme": "6.18.0"
52
52
  },
53
53
  "dependencies": {
54
54
  "tslib": "^2.3.1"
@@ -1,6 +1,7 @@
1
1
  import { SkyHarnessFilters } from '@skyux/core/testing';
2
2
  /**
3
3
  * A set of criteria that can be used to filter a list of SkyAlertHarness instances.
4
+ * @internal
4
5
  */
5
6
  export interface SkyAlertHarnessFilters extends SkyHarnessFilters {
6
7
  }
@@ -4,6 +4,7 @@ import { SkyIndicatorIconType } from '@skyux/indicators';
4
4
  import { SkyAlertHarnessFilters } from './alert-harness-filters';
5
5
  /**
6
6
  * Harness for interacting with an alert component in tests.
7
+ * @internal
7
8
  */
8
9
  export declare class SkyAlertHarness extends SkyComponentHarness {
9
10
  #private;
@@ -2,6 +2,7 @@ import { ComponentFixture } from '@angular/core/testing';
2
2
  /**
3
3
  * Allows interaction with a SKY UX alert component.
4
4
  * @deprecated Use `SkyAlertHarness` instead.
5
+ * @internal
5
6
  */
6
7
  export declare class SkyAlertFixture {
7
8
  /**
@@ -1,6 +1,7 @@
1
1
  import { ComponentFixture } from '@angular/core/testing';
2
2
  /**
3
3
  * Allows interaction with a SKY UX label component.
4
+ * @internal
4
5
  */
5
6
  export declare class SkyLabelFixture {
6
7
  /**
@@ -1,6 +1,7 @@
1
1
  import { BaseHarnessFilters } from '@angular/cdk/testing';
2
2
  /**
3
3
  * A set of criteria that can be used to filter a list of `SkyTokenHarness` instances.
4
+ * @internal
4
5
  */
5
6
  export interface SkyTokenHarnessFilters extends BaseHarnessFilters {
6
7
  /**
@@ -2,6 +2,7 @@ import { ComponentHarness, HarnessPredicate } from '@angular/cdk/testing';
2
2
  import { SkyTokenHarnessFilters } from './token-harness-filters';
3
3
  /**
4
4
  * Harness for interacting with a token component in tests.
5
+ * @internal
5
6
  */
6
7
  export declare class SkyTokenHarness extends ComponentHarness {
7
8
  #private;
@@ -1,6 +1,7 @@
1
1
  import { SkyHarnessFilters } from '@skyux/core/testing';
2
2
  /**
3
3
  * A set of criteria that can be used to filter a list of `SkyTokensHarness` instances.
4
+ * @internal
4
5
  */
5
6
  export interface SkyTokensHarnessFilters extends SkyHarnessFilters {
6
7
  }
@@ -4,6 +4,7 @@ import { SkyTokenHarnessFilters } from './token-harness-filters';
4
4
  import { SkyTokensHarnessFilters } from './tokens-harness-filters';
5
5
  /**
6
6
  * Harness for interacting with a tokens component in tests.
7
+ * @internal
7
8
  */
8
9
  export declare class SkyTokensHarness extends SkyComponentHarness {
9
10
  static hostSelector: string;
@@ -1,4 +1,7 @@
1
1
  import { ComponentFixture } from '@angular/core/testing';
2
+ /**
3
+ * @internal
4
+ */
2
5
  export declare class SkyWaitFixture {
3
6
  get isWaiting(): boolean;
4
7
  get isFullPage(): boolean;