@skyux/indicators
Version:
This library was generated with [Nx](https://nx.dev).
52 lines (51 loc) • 3.31 kB
TypeScript
import { OnDestroy, OnInit } from '@angular/core';
import { BehaviorSubject } from 'rxjs';
import * as i0 from "@angular/core";
export declare class SkyWaitComponent implements OnInit, OnDestroy {
#private;
/**
* The ARIA label for the wait icon.
* This sets the icon's `aria-label` attribute to provide a text equivalent for screen readers
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility) when an element or page loads and when users tab to a wait icon.
* The default value varies based on whether the wait is for an element or a page and whether it is a blocking wait. For example, the default for a page-level blocking wait is "Page loading. Please wait."
* For element-level waits, we recommend that consumers overwrite the default to describe the specific element.
* "For more information, see the Design tab and the [WAI-ARIA `aria-label` definition](https://www.w3.org/TR/wai-aria/#aria-label).
*/
set ariaLabel(value: string | undefined);
/**
* When set to `true`, wait indication appears on the parent element of the `sky-wait` component.
*/
set isWaiting(value: boolean | undefined);
get isWaiting(): boolean | undefined;
/**
* When set to `true`, wait indication appears on the page level instead of the
* parent element level. We recommend that you use the `beginBlockingPageWait` or
* `beginNonBlockingPageWait` functions of the `SkyWaitService` instead of setting this
* on the component level.
* @default false
*/
set isFullPage(value: boolean | undefined);
get isFullPage(): boolean | undefined;
/**
* When set to `true`, wait indication appears in the bottom left corner of the element
* instead of hiding the entire parent element.
* @default false
*/
set isNonBlocking(value: boolean | undefined);
get isNonBlocking(): boolean | undefined;
/**
* Screen reader text [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility) when the wait toggles off.
* The default varies based on whether the wait is for an element or a page.
* For example, the default for a page-level wait is "Page loading complete."
* For element-level waits, we recommend that consumers overwrite the default to describe the specific element.
* For more information, see the Design tab and the [WCAG documentation on status messages](https://www.w3.org/WAI/WCAG21/Understanding/status-messages.html).
*/
set screenReaderCompletedText(value: string | undefined);
ariaLabelStream: BehaviorSubject<string>;
ariaLiveText: string;
screenReaderCompletedTextStream: BehaviorSubject<string>;
ngOnInit(): void;
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<SkyWaitComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<SkyWaitComponent, "sky-wait", never, { "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "isWaiting": { "alias": "isWaiting"; "required": false; }; "isFullPage": { "alias": "isFullPage"; "required": false; }; "isNonBlocking": { "alias": "isNonBlocking"; "required": false; }; "screenReaderCompletedText": { "alias": "screenReaderCompletedText"; "required": false; }; }, {}, never, never, true, never>;
}