@skyux/indicators 6.13.0 → 6.16.0

package/lib/modules/alert/alert.component.d.ts

@@ -1,34 +1,34 @@
 import { EventEmitter, OnInit } from '@angular/core';
 import { SkyIconStackItem } from '../icon/icon-stack-item';
+import { SkyIndicatorIconType } from '../shared/indicator-icon-type';
 import * as i0 from "@angular/core";
 export declare class SkyAlertComponent implements OnInit {
+    #private;
     /**
      * Specifies a style for the alert to determine the icon and background color.
      * The valid options are `danger`, `info`, `success`, and `warning`.
      * @default "warning"
      */
-    set alertType(value: string);
-    get alertType(): string;
+    set alertType(value: string | undefined);
     /**
      * Indicates whether to include a close button for users to dismiss the alert.
      * @default false
      */
-    closeable: boolean;
+    closeable: boolean | undefined;
     /**
      * Indicates whether the alert is closed.
      * @default false
      */
-    closed: boolean;
+    closed: boolean | undefined;
     /**
      * Fires when users close the alert.
      */
     closedChange: EventEmitter<boolean>;
-    alertBaseIcon: SkyIconStackItem;
-    alertTopIcon: SkyIconStackItem;
-    private _alertType;
+    alertBaseIcon: SkyIconStackItem | undefined;
+    alertTopIcon: SkyIconStackItem | undefined;
+    alertTypeOrDefault: SkyIndicatorIconType;
     ngOnInit(): void;
     close(): void;
-    private updateAlertIcon;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyAlertComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SkyAlertComponent, "sky-alert", never, { "alertType": "alertType"; "closeable": "closeable"; "closed": "closed"; }, { "closedChange": "closedChange"; }, never, ["*"]>;
 }

package/lib/modules/chevron/chevron.component.d.ts

@@ -10,17 +10,16 @@ export declare class SkyChevronComponent {
      * This sets the chevron's aria-controls attribute
      * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
      */
-    ariaControls: string;
+    ariaControls: string | undefined;
     /**
      * Specifies an ARIA label for the chevron. This sets the chevron's aria-label attribute
      * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
      */
-    ariaLabel: string;
+    ariaLabel: string | undefined;
     /**
      * Specifies whether the chevron points up or down.
      */
-    set direction(value: string);
-    get direction(): string;
+    set direction(value: string | undefined);
     /**
      * Indicates whether to disable the chevron button.
      */
@@ -30,7 +29,7 @@ export declare class SkyChevronComponent {
      */
     directionChange: EventEmitter<string>;
     ariaExpanded: boolean;
-    private _direction;
+    directionOrDefault: string;
     chevronClick(event: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyChevronComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SkyChevronComponent, "sky-chevron", never, { "ariaControls": "ariaControls"; "ariaLabel": "ariaLabel"; "direction": "direction"; "disabled": "disabled"; }, { "directionChange": "directionChange"; }, never, never>;

package/lib/modules/expansion-indicator/expansion-indicator.component.d.ts

@@ -7,9 +7,8 @@ export declare class SkyExpansionIndicatorComponent {
     /**
      * Specifies whether the chevron points up or down.
      */
-    set direction(value: string);
-    get direction(): string;
-    private _direction;
+    set direction(value: string | undefined);
+    directionOrDefault: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyExpansionIndicatorComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SkyExpansionIndicatorComponent, "sky-expansion-indicator", never, { "direction": "direction"; }, {}, never, never>;
 }

package/lib/modules/icon/icon-stack-item.d.ts

@@ -1,4 +1,7 @@
 import { SkyIconType } from './types/icon-type';
+/**
+ * @internal
+ */
 export interface SkyIconStackItem {
     /**
      * Specifies the name of

package/lib/modules/icon/icon-stack.component.d.ts

@@ -1,5 +1,8 @@
 import { SkyIconStackItem } from './icon-stack-item';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyIconStackComponent {
     /**
      * Specifies the size of the icon using

package/lib/modules/icon/icon.component.d.ts

@@ -4,8 +4,8 @@ import * as i0 from "@angular/core";
 export declare class SkyIconComponent {
     /**
      * Specifies the name of
-     * [the Font Awesome 4.7 icon](https://fontawesome.com/v4.7/icons/) to
-     * display. Do not specify the `fa fa-` classes.
+     * [the Font Awesome 4.7 icon](https://fontawesome.com/v4.7/icons/) or the SKY UX icon to
+     * display. When specifying a Font Awesome icon, do not prefix the name with `fa-`.
      * @required
      */
     icon: string | undefined;
@@ -18,16 +18,17 @@ export declare class SkyIconComponent {
     iconType: SkyIconType;
     /**
      * Specifies the size of the icon using
-     * [Font Awesome sizes](https://fontawesome.com/how-to-use/on-the-web/styling/sizing-icons).
+     * [Font Awesome sizes](https://fontawesome.com/how-to-use/on-the-web/styling/sizing-icons). Do not prefix the size with `fa-`.
      */
     size: string;
     /**
      * Indicates whether the icon has a fixed width.
+     * @default false
      */
     fixedWidth: boolean;
     /**
      * Specifies the icon variant (`"line"` or `"solid"`). If the variant doesn't exist for the
-     * specified icon, the normal icon is displayed.
+     * specified icon, the normal icon is displayed. This property only applies when using SKY UX icons.
      */
     variant: SkyIconVariantType;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyIconComponent, never>;

package/lib/modules/label/label.component.d.ts

@@ -1,19 +1,34 @@
+import { ChangeDetectorRef, OnDestroy, OnInit } from '@angular/core';
+import { SkyLibResourcesService } from '@skyux/i18n';
 import { SkyIconStackItem } from '../icon/icon-stack-item';
+import { SkyIndicatorDescriptionType } from '../shared/indicator-description-type';
 import { SkyLabelType } from './label-type';
 import * as i0 from "@angular/core";
-export declare class SkyLabelComponent {
+export declare class SkyLabelComponent implements OnDestroy, OnInit {
     #private;
     /**
      * The type of label to display.
-     * @required
+     * @default 'info'
      */
     set labelType(value: SkyLabelType | undefined);
-    get labelType(): SkyLabelType | undefined;
+    /**
+     * Specifies the predefined text to be read by screen readers for users who cannot see the indicator icon.
+     * This property is optional but will be required in future versions of SKY UX.
+     */
+    set descriptionType(value: SkyIndicatorDescriptionType | undefined);
+    /**
+     * Specifies the text to be read by screen readers for users who cannot see
+     * the indicator icon when `descriptionType` is `custom`.
+     */
+    set customDescription(value: string | undefined);
     baseIcon: SkyIconStackItem | undefined;
+    descriptionComputed: string | undefined;
     icon: string | undefined;
     labelTypeOrDefault: SkyLabelType;
     topIcon: SkyIconStackItem | undefined;
-    private updateIcon;
+    constructor(changeDetector: ChangeDetectorRef, resources: SkyLibResourcesService);
+    ngOnInit(): void;
+    ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyLabelComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SkyLabelComponent, "sky-label", never, { "labelType": "labelType"; }, {}, never, ["*"]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SkyLabelComponent, "sky-label", never, { "labelType": "labelType"; "descriptionType": "descriptionType"; "customDescription": "customDescription"; }, {}, never, ["*"]>;
 }

package/lib/modules/label/label.module.d.ts

@@ -1,9 +1,11 @@
 import * as i0 from "@angular/core";
 import * as i1 from "./label.component";
 import * as i2 from "@angular/common";
-import * as i3 from "../icon/icon.module";
+import * as i3 from "@skyux/i18n";
+import * as i4 from "../icon/icon.module";
+import * as i5 from "../shared/sky-indicators-resources.module";
 export declare class SkyLabelModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyLabelModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyLabelModule, [typeof i1.SkyLabelComponent], [typeof i2.CommonModule, typeof i3.SkyIconModule], [typeof i1.SkyLabelComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyLabelModule, [typeof i1.SkyLabelComponent], [typeof i2.CommonModule, typeof i3.SkyI18nModule, typeof i4.SkyIconModule, typeof i5.SkyIndicatorsResourcesModule], [typeof i1.SkyLabelComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<SkyLabelModule>;
 }

package/lib/modules/shared/indicator-description-type.d.ts

@@ -1 +1 @@
-export declare type SkyIndicatorDescriptionType = 'completed' | 'custom' | 'error' | 'important-info' | 'none' | 'warning';
+export declare type SkyIndicatorDescriptionType = 'attention' | 'caution' | 'completed' | 'custom' | 'danger' | 'error' | 'important-info' | 'important-warning' | 'none' | 'success' | 'warning';

package/lib/modules/status-indicator/status-indicator.component.d.ts

@@ -1,4 +1,4 @@
-import { ChangeDetectorRef } from '@angular/core';
+import { ChangeDetectorRef, OnInit } from '@angular/core';
 import { SkyLibResourcesService } from '@skyux/i18n';
 import { SkyIconStackItem } from '../icon/icon-stack-item';
 import { SkyIndicatorDescriptionType } from '../shared/indicator-description-type';
@@ -10,15 +10,13 @@ import * as i0 from "@angular/core";
  * `sky-help-inline`, in the `sky-status-indicator` element and a `sky-control-help`
  * CSS class on that help button element.
  */
-export declare class SkyStatusIndicatorComponent {
-    private changeDetector;
-    private resources;
+export declare class SkyStatusIndicatorComponent implements OnInit {
+    #private;
     /**
      * Specifies a style for the status indicator to determine the icon.
      * @default "warning"
      */
     set indicatorType(value: SkyIndicatorIconType);
-    get indicatorType(): SkyIndicatorIconType;
     /**
      * Specifies the predefined text to be read by screen readers for users
      * who cannot see the indicator icon.
@@ -35,13 +33,10 @@ export declare class SkyStatusIndicatorComponent {
     descriptionComputed: string;
     baseIcon: SkyIconStackItem;
     icon: string;
+    indicatorTypeOrDefault: SkyIndicatorIconType;
     topIcon: SkyIconStackItem;
-    private _indicatorType;
-    private _descriptionType;
-    private _customDescription;
     constructor(changeDetector: ChangeDetectorRef, resources: SkyLibResourcesService);
-    private updateIcon;
-    private updateDescriptionComputed;
+    ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyStatusIndicatorComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SkyStatusIndicatorComponent, "sky-status-indicator", never, { "indicatorType": "indicatorType"; "descriptionType": "descriptionType"; "customDescription": "customDescription"; }, {}, never, ["*", ".sky-control-help"]>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/indicators",
-  "version": "6.13.0",
+  "version": "6.16.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -41,13 +41,14 @@
   },
   "peerDependencies": {
     "@angular/animations": "^13.3.2",
+    "@angular/cdk": "^13.3.2",
     "@angular/common": "^13.3.2",
     "@angular/core": "^13.3.2",
     "@angular/platform-browser": "^13.3.2",
-    "@skyux-sdk/testing": "6.13.0",
-    "@skyux/core": "6.13.0",
-    "@skyux/i18n": "6.13.0",
-    "@skyux/theme": "6.13.0"
+    "@skyux-sdk/testing": "6.16.0",
+    "@skyux/core": "6.16.0",
+    "@skyux/i18n": "6.16.0",
+    "@skyux/theme": "6.16.0"
   },
   "dependencies": {
     "tslib": "^2.3.1"

package/testing/alert/alert-harness-filters.d.ts

@@ -0,0 +1,6 @@
+import { SkyHarnessFilters } from '@skyux/core/testing';
+/**
+ * A set of criteria that can be used to filter a list of SkyAlertHarness instances.
+ */
+export interface SkyAlertHarnessFilters extends SkyHarnessFilters {
+}

package/testing/alert/alert-harness.d.ts

@@ -0,0 +1,36 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyComponentHarness } from '@skyux/core/testing';
+import { SkyIndicatorIconType } from '@skyux/indicators';
+import { SkyAlertHarnessFilters } from './alert-harness-filters';
+/**
+ * Harness for interacting with an alert component in tests.
+ */
+export declare class SkyAlertHarness extends SkyComponentHarness {
+    #private;
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyAlertHarness` that meets certain criteria.
+     */
+    static with(filters: SkyAlertHarnessFilters): HarnessPredicate<SkyAlertHarness>;
+    /**
+     * Gets the current alert type.
+     */
+    getAlertType(): Promise<SkyIndicatorIconType | undefined>;
+    /**
+     * Gets the current alert text.
+     */
+    getText(): Promise<string>;
+    /**
+     * Closes the alert.
+     */
+    close(): Promise<void>;
+    /**
+     * Indicates whether the user has closed the alert.
+     */
+    isClosed(): Promise<boolean>;
+    /**
+     * Indicates whether the user can close the alert.
+     */
+    isCloseable(): Promise<boolean>;
+}

package/testing/alert-fixture.d.ts

@@ -1,16 +1,17 @@
 import { ComponentFixture } from '@angular/core/testing';
 /**
  * Allows interaction with a SKY UX alert component.
+ * @deprecated Use `SkyAlertHarness` instead.
  */
 export declare class SkyAlertFixture {
     /**
      * The alert's current text.
      */
-    get text(): string;
+    get text(): string | undefined;
     /**
      * A flag indicating whether the alert can be closed.
      */
-    get closeable(): boolean;
+    get closeable(): boolean | undefined;
     /**
      * Returns a flag indicating whether the alert is closed.
      */
@@ -18,9 +19,9 @@ export declare class SkyAlertFixture {
     /**
      * The alert's current type.
      */
-    get alertType(): string;
+    get alertType(): string | undefined;
     private debugEl;
-    constructor(fixture: ComponentFixture<any>, skyTestId: string);
+    constructor(fixture: ComponentFixture<unknown>, skyTestId: string);
     /**
      * Closes the alert.  If the alert is not closeable, an error is thrown.
      */

package/testing/public-api.d.ts

@@ -1,3 +1,9 @@
+export * from './tokens/token-harness';
+export * from './tokens/token-harness-filters';
+export * from './tokens/tokens-harness';
+export * from './tokens/tokens-harness-filters';
 export * from './alert-fixture';
 export * from './label-fixture';
 export * from './wait-fixture';
+export * from './alert/alert-harness';
+export * from './alert/alert-harness-filters';

package/testing/tokens/token-harness-filters.d.ts

@@ -0,0 +1,10 @@
+import { BaseHarnessFilters } from '@angular/cdk/testing';
+/**
+ * A set of criteria that can be used to filter a list of `SkyTokenHarness` instances.
+ */
+export interface SkyTokenHarnessFilters extends BaseHarnessFilters {
+    /**
+     * Only find instances whose text content matches the given value.
+     */
+    text?: string | RegExp;
+}

package/testing/tokens/token-harness.d.ts

@@ -0,0 +1,26 @@
+import { ComponentHarness, HarnessPredicate } from '@angular/cdk/testing';
+import { SkyTokenHarnessFilters } from './token-harness-filters';
+/**
+ * Harness for interacting with a token component in tests.
+ */
+export declare class SkyTokenHarness extends ComponentHarness {
+    #private;
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyTokenHarness` that meets certain criteria.
+     */
+    static with(filters: SkyTokenHarnessFilters): HarnessPredicate<SkyTokenHarness>;
+    /**
+     * Dismisses the token.
+     */
+    dismiss(): Promise<void>;
+    /**
+     * Returns the text content of the token.
+     */
+    getText(): Promise<string>;
+    /**
+     * Whether the token is dismissible.
+     */
+    isDismissible(): Promise<boolean>;
+}

package/testing/tokens/tokens-harness-filters.d.ts

@@ -0,0 +1,6 @@
+import { SkyHarnessFilters } from '@skyux/core/testing';
+/**
+ * A set of criteria that can be used to filter a list of `SkyTokensHarness` instances.
+ */
+export interface SkyTokensHarnessFilters extends SkyHarnessFilters {
+}

package/testing/tokens/tokens-harness.d.ts

@@ -0,0 +1,27 @@
+import { SkyComponentHarness } from '@skyux/core/testing';
+import { SkyTokenHarness } from './token-harness';
+import { SkyTokenHarnessFilters } from './token-harness-filters';
+import { SkyTokensHarnessFilters } from './tokens-harness-filters';
+/**
+ * Harness for interacting with a tokens component in tests.
+ */
+export declare class SkyTokensHarness extends SkyComponentHarness {
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyTokensHarness` that meets certain criteria.
+     */
+    static with(filters: SkyTokensHarnessFilters): import("@angular/cdk/testing").HarnessPredicate<SkyTokensHarness>;
+    /**
+     * Dismisses all tokens, or tokens that meet certain criteria.
+     */
+    dismissTokens(filters?: SkyTokenHarnessFilters): Promise<void>;
+    /**
+     * Returns a list of tokens.
+     */
+    getTokens(filters?: SkyTokenHarnessFilters): Promise<SkyTokenHarness[]>;
+    /**
+     * Returns the text content of all tokens.
+     */
+    getTokensText(): Promise<string[]>;
+}