@skyux/indicators 6.14.0 → 6.15.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 (30) hide show
  1. package/documentation.json +372 -549
  2. package/esm2020/lib/modules/alert/alert.component.mjs +15 -14
  3. package/esm2020/lib/modules/chevron/chevron.component.mjs +11 -12
  4. package/esm2020/lib/modules/expansion-indicator/expansion-indicator.component.mjs +8 -8
  5. package/esm2020/lib/modules/icon/icon-stack-item.mjs +1 -1
  6. package/esm2020/lib/modules/icon/icon-stack.component.mjs +4 -1
  7. package/esm2020/lib/modules/icon/icon.component.mjs +1 -1
  8. package/esm2020/lib/modules/label/label.component.mjs +15 -22
  9. package/esm2020/lib/modules/status-indicator/status-indicator.component.mjs +52 -44
  10. package/esm2020/testing/alert/alert-harness.mjs +2 -1
  11. package/esm2020/testing/alert-fixture.mjs +1 -1
  12. package/fesm2015/skyux-indicators-testing.mjs +1 -0
  13. package/fesm2015/skyux-indicators-testing.mjs.map +1 -1
  14. package/fesm2015/skyux-indicators.mjs +99 -97
  15. package/fesm2015/skyux-indicators.mjs.map +1 -1
  16. package/fesm2020/skyux-indicators-testing.mjs +1 -0
  17. package/fesm2020/skyux-indicators-testing.mjs.map +1 -1
  18. package/fesm2020/skyux-indicators.mjs +99 -97
  19. package/fesm2020/skyux-indicators.mjs.map +1 -1
  20. package/lib/modules/alert/alert.component.d.ts +6 -8
  21. package/lib/modules/chevron/chevron.component.d.ts +4 -5
  22. package/lib/modules/expansion-indicator/expansion-indicator.component.d.ts +2 -3
  23. package/lib/modules/icon/icon-stack-item.d.ts +3 -0
  24. package/lib/modules/icon/icon-stack.component.d.ts +3 -0
  25. package/lib/modules/icon/icon.component.d.ts +5 -4
  26. package/lib/modules/label/label.component.d.ts +4 -4
  27. package/lib/modules/status-indicator/status-indicator.component.d.ts +5 -10
  28. package/package.json +5 -5
  29. package/testing/alert/alert-harness.d.ts +1 -1
  30. package/testing/alert-fixture.d.ts +4 -4
@@ -3,34 +3,32 @@ import { SkyIconStackItem } from '../icon/icon-stack-item';
3
3
  import { SkyIndicatorIconType } from '../shared/indicator-icon-type';
4
4
  import * as i0 from "@angular/core";
5
5
  export declare class SkyAlertComponent implements OnInit {
6
+ #private;
6
7
  /**
7
8
  * Specifies a style for the alert to determine the icon and background color.
8
9
  * The valid options are `danger`, `info`, `success`, and `warning`.
9
10
  * @default "warning"
10
11
  */
11
- set alertType(value: string);
12
- get alertType(): string;
12
+ set alertType(value: string | undefined);
13
13
  /**
14
14
  * Indicates whether to include a close button for users to dismiss the alert.
15
15
  * @default false
16
16
  */
17
- closeable: boolean;
17
+ closeable: boolean | undefined;
18
18
  /**
19
19
  * Indicates whether the alert is closed.
20
20
  * @default false
21
21
  */
22
- closed: boolean;
22
+ closed: boolean | undefined;
23
23
  /**
24
24
  * Fires when users close the alert.
25
25
  */
26
26
  closedChange: EventEmitter<boolean>;
27
- alertBaseIcon: SkyIconStackItem;
28
- alertTopIcon: SkyIconStackItem;
27
+ alertBaseIcon: SkyIconStackItem | undefined;
28
+ alertTopIcon: SkyIconStackItem | undefined;
29
29
  alertTypeOrDefault: SkyIndicatorIconType;
30
- private _alertType;
31
30
  ngOnInit(): void;
32
31
  close(): void;
33
- private updateAlertIcon;
34
32
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyAlertComponent, never>;
35
33
  static ɵcmp: i0.ɵɵComponentDeclaration<SkyAlertComponent, "sky-alert", never, { "alertType": "alertType"; "closeable": "closeable"; "closed": "closed"; }, { "closedChange": "closedChange"; }, never, ["*"]>;
36
34
  }
@@ -10,17 +10,16 @@ export declare class SkyChevronComponent {
10
10
  * This sets the chevron's aria-controls attribute
11
11
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
12
12
  */
13
- ariaControls: string;
13
+ ariaControls: string | undefined;
14
14
  /**
15
15
  * Specifies an ARIA label for the chevron. This sets the chevron's aria-label attribute
16
16
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
17
17
  */
18
- ariaLabel: string;
18
+ ariaLabel: string | undefined;
19
19
  /**
20
20
  * Specifies whether the chevron points up or down.
21
21
  */
22
- set direction(value: string);
23
- get direction(): string;
22
+ set direction(value: string | undefined);
24
23
  /**
25
24
  * Indicates whether to disable the chevron button.
26
25
  */
@@ -30,7 +29,7 @@ export declare class SkyChevronComponent {
30
29
  */
31
30
  directionChange: EventEmitter<string>;
32
31
  ariaExpanded: boolean;
33
- private _direction;
32
+ directionOrDefault: string;
34
33
  chevronClick(event: Event): void;
35
34
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyChevronComponent, never>;
36
35
  static ɵcmp: i0.ɵɵComponentDeclaration<SkyChevronComponent, "sky-chevron", never, { "ariaControls": "ariaControls"; "ariaLabel": "ariaLabel"; "direction": "direction"; "disabled": "disabled"; }, { "directionChange": "directionChange"; }, never, never>;
@@ -7,9 +7,8 @@ export declare class SkyExpansionIndicatorComponent {
7
7
  /**
8
8
  * Specifies whether the chevron points up or down.
9
9
  */
10
- set direction(value: string);
11
- get direction(): string;
12
- private _direction;
10
+ set direction(value: string | undefined);
11
+ directionOrDefault: string;
13
12
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyExpansionIndicatorComponent, never>;
14
13
  static ɵcmp: i0.ɵɵComponentDeclaration<SkyExpansionIndicatorComponent, "sky-expansion-indicator", never, { "direction": "direction"; }, {}, never, never>;
15
14
  }
@@ -1,4 +1,7 @@
1
1
  import { SkyIconType } from './types/icon-type';
2
+ /**
3
+ * @internal
4
+ */
2
5
  export interface SkyIconStackItem {
3
6
  /**
4
7
  * Specifies the name of
@@ -1,5 +1,8 @@
1
1
  import { SkyIconStackItem } from './icon-stack-item';
2
2
  import * as i0 from "@angular/core";
3
+ /**
4
+ * @internal
5
+ */
3
6
  export declare class SkyIconStackComponent {
4
7
  /**
5
8
  * Specifies the size of the icon using
@@ -4,8 +4,8 @@ import * as i0 from "@angular/core";
4
4
  export declare class SkyIconComponent {
5
5
  /**
6
6
  * Specifies the name of
7
- * [the Font Awesome 4.7 icon](https://fontawesome.com/v4.7/icons/) to
8
- * display. Do not specify the `fa fa-` classes.
7
+ * [the Font Awesome 4.7 icon](https://fontawesome.com/v4.7/icons/) or the SKY UX icon to
8
+ * display. When specifying a Font Awesome icon, do not prefix the name with `fa-`.
9
9
  * @required
10
10
  */
11
11
  icon: string | undefined;
@@ -18,16 +18,17 @@ export declare class SkyIconComponent {
18
18
  iconType: SkyIconType;
19
19
  /**
20
20
  * Specifies the size of the icon using
21
- * [Font Awesome sizes](https://fontawesome.com/how-to-use/on-the-web/styling/sizing-icons).
21
+ * [Font Awesome sizes](https://fontawesome.com/how-to-use/on-the-web/styling/sizing-icons). Do not prefix the size with `fa-`.
22
22
  */
23
23
  size: string;
24
24
  /**
25
25
  * Indicates whether the icon has a fixed width.
26
+ * @default false
26
27
  */
27
28
  fixedWidth: boolean;
28
29
  /**
29
30
  * Specifies the icon variant (`"line"` or `"solid"`). If the variant doesn't exist for the
30
- * specified icon, the normal icon is displayed.
31
+ * specified icon, the normal icon is displayed. This property only applies when using SKY UX icons.
31
32
  */
32
33
  variant: SkyIconVariantType;
33
34
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyIconComponent, never>;
@@ -1,19 +1,19 @@
1
+ import { OnInit } from '@angular/core';
1
2
  import { SkyIconStackItem } from '../icon/icon-stack-item';
2
3
  import { SkyLabelType } from './label-type';
3
4
  import * as i0 from "@angular/core";
4
- export declare class SkyLabelComponent {
5
+ export declare class SkyLabelComponent implements OnInit {
5
6
  #private;
6
7
  /**
7
8
  * The type of label to display.
8
- * @required
9
+ * @default 'info'
9
10
  */
10
11
  set labelType(value: SkyLabelType | undefined);
11
- get labelType(): SkyLabelType | undefined;
12
12
  baseIcon: SkyIconStackItem | undefined;
13
13
  icon: string | undefined;
14
14
  labelTypeOrDefault: SkyLabelType;
15
15
  topIcon: SkyIconStackItem | undefined;
16
- private updateIcon;
16
+ ngOnInit(): void;
17
17
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyLabelComponent, never>;
18
18
  static ɵcmp: i0.ɵɵComponentDeclaration<SkyLabelComponent, "sky-label", never, { "labelType": "labelType"; }, {}, never, ["*"]>;
19
19
  }
@@ -1,4 +1,4 @@
1
- import { ChangeDetectorRef } from '@angular/core';
1
+ import { ChangeDetectorRef, OnInit } from '@angular/core';
2
2
  import { SkyLibResourcesService } from '@skyux/i18n';
3
3
  import { SkyIconStackItem } from '../icon/icon-stack-item';
4
4
  import { SkyIndicatorDescriptionType } from '../shared/indicator-description-type';
@@ -10,15 +10,13 @@ import * as i0 from "@angular/core";
10
10
  * `sky-help-inline`, in the `sky-status-indicator` element and a `sky-control-help`
11
11
  * CSS class on that help button element.
12
12
  */
13
- export declare class SkyStatusIndicatorComponent {
14
- private changeDetector;
15
- private resources;
13
+ export declare class SkyStatusIndicatorComponent implements OnInit {
14
+ #private;
16
15
  /**
17
16
  * Specifies a style for the status indicator to determine the icon.
18
17
  * @default "warning"
19
18
  */
20
19
  set indicatorType(value: SkyIndicatorIconType);
21
- get indicatorType(): SkyIndicatorIconType;
22
20
  /**
23
21
  * Specifies the predefined text to be read by screen readers for users
24
22
  * who cannot see the indicator icon.
@@ -35,13 +33,10 @@ export declare class SkyStatusIndicatorComponent {
35
33
  descriptionComputed: string;
36
34
  baseIcon: SkyIconStackItem;
37
35
  icon: string;
36
+ indicatorTypeOrDefault: SkyIndicatorIconType;
38
37
  topIcon: SkyIconStackItem;
39
- private _indicatorType;
40
- private _descriptionType;
41
- private _customDescription;
42
38
  constructor(changeDetector: ChangeDetectorRef, resources: SkyLibResourcesService);
43
- private updateIcon;
44
- private updateDescriptionComputed;
39
+ ngOnInit(): void;
45
40
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyStatusIndicatorComponent, never>;
46
41
  static ɵcmp: i0.ɵɵComponentDeclaration<SkyStatusIndicatorComponent, "sky-status-indicator", never, { "indicatorType": "indicatorType"; "descriptionType": "descriptionType"; "customDescription": "customDescription"; }, {}, never, ["*", ".sky-control-help"]>;
47
42
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/indicators",
3
- "version": "6.14.0",
3
+ "version": "6.15.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.14.0",
49
- "@skyux/core": "6.14.0",
50
- "@skyux/i18n": "6.14.0",
51
- "@skyux/theme": "6.14.0"
48
+ "@skyux-sdk/testing": "6.15.0",
49
+ "@skyux/core": "6.15.0",
50
+ "@skyux/i18n": "6.15.0",
51
+ "@skyux/theme": "6.15.0"
52
52
  },
53
53
  "dependencies": {
54
54
  "tslib": "^2.3.1"
@@ -16,7 +16,7 @@ export declare class SkyAlertHarness extends SkyComponentHarness {
16
16
  /**
17
17
  * Gets the current alert type.
18
18
  */
19
- getAlertType(): Promise<SkyIndicatorIconType>;
19
+ getAlertType(): Promise<SkyIndicatorIconType | undefined>;
20
20
  /**
21
21
  * Gets the current alert text.
22
22
  */
@@ -7,11 +7,11 @@ export declare class SkyAlertFixture {
7
7
  /**
8
8
  * The alert's current text.
9
9
  */
10
- get text(): string;
10
+ get text(): string | undefined;
11
11
  /**
12
12
  * A flag indicating whether the alert can be closed.
13
13
  */
14
- get closeable(): boolean;
14
+ get closeable(): boolean | undefined;
15
15
  /**
16
16
  * Returns a flag indicating whether the alert is closed.
17
17
  */
@@ -19,9 +19,9 @@ export declare class SkyAlertFixture {
19
19
  /**
20
20
  * The alert's current type.
21
21
  */
22
- get alertType(): string;
22
+ get alertType(): string | undefined;
23
23
  private debugEl;
24
- constructor(fixture: ComponentFixture<any>, skyTestId: string);
24
+ constructor(fixture: ComponentFixture<unknown>, skyTestId: string);
25
25
  /**
26
26
  * Closes the alert. If the alert is not closeable, an error is thrown.
27
27
  */