@skyux/core 8.0.0-alpha.20 → 8.0.0-alpha.21

package/index.d.ts

@@ -27,6 +27,9 @@ export * from './lib/modules/dynamic-component/dynamic-component.service';
 export * from './lib/modules/format/app-format';
 export * from './lib/modules/id/id.module';
 export * from './lib/modules/id/id.service';
+export * from './lib/modules/live-announcer/live-announcer.service';
+export * from './lib/modules/live-announcer/types/live-announcer-args';
+export * from './lib/modules/live-announcer/types/live-announcer-politeness';
 export * from './lib/modules/log/log.module';
 export * from './lib/modules/log/log.service';
 export * from './lib/modules/log/types/log-level';

package/lib/modules/live-announcer/live-announcer.service.d.ts

@@ -0,0 +1,31 @@
+import { OnDestroy } from '@angular/core';
+import { ReplaySubject } from 'rxjs';
+import { SkyLiveAnnouncerArgs } from './types/live-announcer-args';
+import * as i0 from "@angular/core";
+/**
+ * Allows for announcing messages to screen reader users through the use of a common `aria-live` element.
+ * @internal
+ */
+export declare class SkyLiveAnnouncerService implements OnDestroy {
+    #private;
+    announcerElementChanged: ReplaySubject<HTMLElement | undefined>;
+    constructor();
+    /**
+     * Announces a message to screen readers.
+     * @param message Message to be announced to the screen reader.
+     * @param args Options for the announcement of the message.
+     */
+    announce(message: string, args?: SkyLiveAnnouncerArgs): void;
+    /**
+     * Clears the current text from the announcer element. Can be used to prevent
+     * screen readers from reading the text out again while the user is going
+     * through the page landmarks.
+     */
+    clear(): void;
+    /**
+     * @internal
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyLiveAnnouncerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SkyLiveAnnouncerService>;
+}

package/lib/modules/live-announcer/types/live-announcer-args.d.ts

@@ -0,0 +1,8 @@
+import { SkyLiveAnnouncerPoliteness } from './live-announcer-politeness';
+/**
+ * Options used when announcing messages to screen readers via the `SkyLiveAnnouncerService`
+ * @internal
+ */
+export interface SkyLiveAnnouncerArgs {
+    politeness?: SkyLiveAnnouncerPoliteness;
+}

package/lib/modules/live-announcer/types/live-announcer-politeness.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Possible politeness levels for messages announced via the `SkyLiveAnnouncerService`.
+ * @internal
+ */
+export type SkyLiveAnnouncerPoliteness = 'off' | 'polite' | 'assertive';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/core",
-  "version": "8.0.0-alpha.20",
+  "version": "8.0.0-alpha.21",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -45,7 +45,7 @@
     "@angular/core": "^15.2.1",
     "@angular/platform-browser": "^15.2.1",
     "@angular/router": "^15.2.1",
-    "@skyux/i18n": "8.0.0-alpha.20"
+    "@skyux/i18n": "8.0.0-alpha.21"
   },
   "dependencies": {
     "tslib": "^2.5.0"