a11y.md

API Report File for "components-srcs"

Do not edit this file. It is a report generated by API Extractor.

import { AfterContentInit } from '@angular/core';
import { AfterViewInit } from '@angular/core';
import { BooleanInput } from '@angular/cdk/coercion';
import { ContentObserver } from '@angular/cdk/observers';
import { DoCheck } from '@angular/core';
import { ElementRef } from '@angular/core';
import { EventEmitter } from '@angular/core';
import * as i0 from '@angular/core';
import * as i4 from '@angular/cdk/observers';
import { InjectionToken } from '@angular/core';
import { NgZone } from '@angular/core';
import { Observable } from 'rxjs';
import { OnChanges } from '@angular/core';
import { OnDestroy } from '@angular/core';
import { Platform } from '@angular/cdk/platform';
import { QueryList } from '@angular/core';
import { SimpleChanges } from '@angular/core';
import { Subject } from 'rxjs';

// @public (undocumented)
export class A11yModule {
    constructor(highContrastModeDetector: HighContrastModeDetector);
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<A11yModule, never>;
    // (undocumented)
    static ɵinj: i0.ɵɵInjectorDeclaration<A11yModule>;
    // (undocumented)
    static ɵmod: i0.ɵɵNgModuleDeclaration<A11yModule, [typeof i1.CdkAriaLive, typeof i2.CdkTrapFocus, typeof i3.CdkMonitorFocus], [typeof i4.ObserversModule], [typeof i1.CdkAriaLive, typeof i2.CdkTrapFocus, typeof i3.CdkMonitorFocus]>;
}

// @public (undocumented)
export class ActiveDescendantKeyManager<T> extends ListKeyManager<Highlightable & T> {
    setActiveItem(index: number): void;
    setActiveItem(item: T): void;
}

// @public
export class AriaDescriber implements OnDestroy {
    constructor(_document: any,
    _platform?: Platform | undefined);
    describe(hostElement: Element, message: string, role?: string): void;
    describe(hostElement: Element, message: HTMLElement): void;
    ngOnDestroy(): void;
    removeDescription(hostElement: Element, message: string, role?: string): void;
    removeDescription(hostElement: Element, message: HTMLElement): void;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<AriaDescriber, never>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<AriaDescriber>;
}

// @public
export type AriaLivePoliteness = 'off' | 'polite' | 'assertive';

// @public @deprecated
export const CDK_DESCRIBEDBY_HOST_ATTRIBUTE = "cdk-describedby-host";

// @public @deprecated
export const CDK_DESCRIBEDBY_ID_PREFIX = "cdk-describedby-message";

// @public
export class CdkAriaLive implements OnDestroy {
    constructor(_elementRef: ElementRef, _liveAnnouncer: LiveAnnouncer, _contentObserver: ContentObserver, _ngZone: NgZone);
    duration: number;
    // (undocumented)
    ngOnDestroy(): void;
    get politeness(): AriaLivePoliteness;
    set politeness(value: AriaLivePoliteness);
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<CdkAriaLive, "[cdkAriaLive]", ["cdkAriaLive"], { "politeness": "cdkAriaLive"; "duration": "cdkAriaLiveDuration"; }, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<CdkAriaLive, never>;
}

// @public
export class CdkMonitorFocus implements AfterViewInit, OnDestroy {
    constructor(_elementRef: ElementRef<HTMLElement>, _focusMonitor: FocusMonitor);
    // (undocumented)
    readonly cdkFocusChange: EventEmitter<FocusOrigin>;
    // (undocumented)
    get focusOrigin(): FocusOrigin;
    // (undocumented)
    ngAfterViewInit(): void;
    // (undocumented)
    ngOnDestroy(): void;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<CdkMonitorFocus, "[cdkMonitorElementFocus], [cdkMonitorSubtreeFocus]", ["cdkMonitorFocus"], {}, { "cdkFocusChange": "cdkFocusChange"; }, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<CdkMonitorFocus, never>;
}

// @public
export class CdkTrapFocus implements OnDestroy, AfterContentInit, OnChanges, DoCheck {
    constructor(_elementRef: ElementRef<HTMLElement>, _focusTrapFactory: FocusTrapFactory,
    _document: any);
    get autoCapture(): boolean;
    set autoCapture(value: BooleanInput);
    get enabled(): boolean;
    set enabled(value: BooleanInput);
    focusTrap: FocusTrap;
    // (undocumented)
    ngAfterContentInit(): void;
    // (undocumented)
    ngDoCheck(): void;
    // (undocumented)
    ngOnChanges(changes: SimpleChanges): void;
    // (undocumented)
    ngOnDestroy(): void;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<CdkTrapFocus, "[cdkTrapFocus]", ["cdkTrapFocus"], { "enabled": "cdkTrapFocus"; "autoCapture": "cdkTrapFocusAutoCapture"; }, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<CdkTrapFocus, never>;
}

// @public
export class ConfigurableFocusTrap extends FocusTrap implements ManagedFocusTrap {
    constructor(_element: HTMLElement, _checker: InteractivityChecker, _ngZone: NgZone, _document: Document, _focusTrapManager: FocusTrapManager, _inertStrategy: FocusTrapInertStrategy, config: ConfigurableFocusTrapConfig);
    destroy(): void;
    _disable(): void;
    _enable(): void;
    get enabled(): boolean;
    set enabled(value: boolean);
}

// @public
export interface ConfigurableFocusTrapConfig {
    defer: boolean;
}

// @public
export class ConfigurableFocusTrapFactory {
    constructor(_checker: InteractivityChecker, _ngZone: NgZone, _focusTrapManager: FocusTrapManager, _document: any, _inertStrategy?: FocusTrapInertStrategy);
    create(element: HTMLElement, config?: ConfigurableFocusTrapConfig): ConfigurableFocusTrap;
    // @deprecated (undocumented)
    create(element: HTMLElement, deferCaptureElements: boolean): ConfigurableFocusTrap;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<ConfigurableFocusTrapFactory, [null, null, null, null, { optional: true; }]>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<ConfigurableFocusTrapFactory>;
}

// @public
export class EventListenerFocusTrapInertStrategy implements FocusTrapInertStrategy {
    allowFocus(focusTrap: ConfigurableFocusTrap): void;
    preventFocus(focusTrap: ConfigurableFocusTrap): void;
}

// @public
export const FOCUS_MONITOR_DEFAULT_OPTIONS: InjectionToken<FocusMonitorOptions>;

// @public
export const FOCUS_TRAP_INERT_STRATEGY: InjectionToken<FocusTrapInertStrategy>;

// @public
export interface FocusableOption extends ListKeyManagerOption {
    focus(origin?: FocusOrigin): void;
}

// @public (undocumented)
export class FocusKeyManager<T> extends ListKeyManager<FocusableOption & T> {
    setActiveItem(index: number): void;
    setActiveItem(item: T): void;
    setFocusOrigin(origin: FocusOrigin): this;
}

// @public
export class FocusMonitor implements OnDestroy {
    constructor(_ngZone: NgZone, _platform: Platform, _inputModalityDetector: InputModalityDetector,
    document: any | null, options: FocusMonitorOptions | null);
    protected _document?: Document;
    focusVia(element: HTMLElement, origin: FocusOrigin, options?: FocusOptions_2): void;
    focusVia(element: ElementRef<HTMLElement>, origin: FocusOrigin, options?: FocusOptions_2): void;
    monitor(element: HTMLElement, checkChildren?: boolean): Observable<FocusOrigin>;
    monitor(element: ElementRef<HTMLElement>, checkChildren?: boolean): Observable<FocusOrigin>;
    // (undocumented)
    ngOnDestroy(): void;
    _onBlur(event: FocusEvent, element: HTMLElement): void;
    stopMonitoring(element: HTMLElement): void;
    stopMonitoring(element: ElementRef<HTMLElement>): void;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<FocusMonitor, [null, null, null, { optional: true; }, { optional: true; }]>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<FocusMonitor>;
}

// @public
export const enum FocusMonitorDetectionMode {
    EVENTUAL = 1,
    IMMEDIATE = 0
}

// @public
export interface FocusMonitorOptions {
    // (undocumented)
    detectionMode?: FocusMonitorDetectionMode;
}

// @public
interface FocusOptions_2 {
    preventScroll?: boolean;
}
export { FocusOptions_2 as FocusOptions }

// @public (undocumented)
export type FocusOrigin = 'touch' | 'mouse' | 'keyboard' | 'program' | null;

// @public @deprecated
export class FocusTrap {
    constructor(_element: HTMLElement, _checker: InteractivityChecker, _ngZone: NgZone, _document: Document, deferAnchors?: boolean);
    attachAnchors(): boolean;
    destroy(): void;
    // (undocumented)
    readonly _document: Document;
    // (undocumented)
    readonly _element: HTMLElement;
    get enabled(): boolean;
    set enabled(value: boolean);
    // (undocumented)
    protected _enabled: boolean;
    // (undocumented)
    protected endAnchorListener: () => boolean;
    focusFirstTabbableElement(options?: FocusOptions): boolean;
    focusFirstTabbableElementWhenReady(options?: FocusOptions): Promise<boolean>;
    focusInitialElement(options?: FocusOptions): boolean;
    focusInitialElementWhenReady(options?: FocusOptions): Promise<boolean>;
    focusLastTabbableElement(options?: FocusOptions): boolean;
    focusLastTabbableElementWhenReady(options?: FocusOptions): Promise<boolean>;
    hasAttached(): boolean;
    // (undocumented)
    readonly _ngZone: NgZone;
    // (undocumented)
    protected startAnchorListener: () => boolean;
    protected toggleAnchors(enabled: boolean): void;
}

// @public @deprecated
export class FocusTrapFactory {
    constructor(_checker: InteractivityChecker, _ngZone: NgZone, _document: any);
    create(element: HTMLElement, deferCaptureElements?: boolean): FocusTrap;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<FocusTrapFactory, never>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<FocusTrapFactory>;
}

// @public
export interface FocusTrapInertStrategy {
    allowFocus(focusTrap: FocusTrap): void;
    preventFocus(focusTrap: FocusTrap): void;
}

// @public
export const enum HighContrastMode {
    // (undocumented)
    BLACK_ON_WHITE = 1,
    // (undocumented)
    NONE = 0,
    // (undocumented)
    WHITE_ON_BLACK = 2
}

// @public
export class HighContrastModeDetector implements OnDestroy {
    constructor(_platform: Platform, document: any);
    _applyBodyHighContrastModeCssClasses(): void;
    getHighContrastMode(): HighContrastMode;
    // (undocumented)
    ngOnDestroy(): void;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<HighContrastModeDetector, never>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<HighContrastModeDetector>;
}

// @public
export interface Highlightable extends ListKeyManagerOption {
    setActiveStyles(): void;
    setInactiveStyles(): void;
}

// @public
export const INPUT_MODALITY_DETECTOR_DEFAULT_OPTIONS: InputModalityDetectorOptions;

// @public
export const INPUT_MODALITY_DETECTOR_OPTIONS: InjectionToken<InputModalityDetectorOptions>;

// @public
export type InputModality = 'keyboard' | 'mouse' | 'touch' | null;

// @public
export class InputModalityDetector implements OnDestroy {
    constructor(_platform: Platform, ngZone: NgZone, document: Document, options?: InputModalityDetectorOptions);
    readonly modalityChanged: Observable<InputModality>;
    readonly modalityDetected: Observable<InputModality>;
    get mostRecentModality(): InputModality;
    _mostRecentTarget: HTMLElement | null;
    // (undocumented)
    ngOnDestroy(): void;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<InputModalityDetector, [null, null, null, { optional: true; }]>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<InputModalityDetector>;
}

// @public
export interface InputModalityDetectorOptions {
    ignoreKeys?: number[];
}

// @public
export class InteractivityChecker {
    constructor(_platform: Platform);
    isDisabled(element: HTMLElement): boolean;
    isFocusable(element: HTMLElement, config?: IsFocusableConfig): boolean;
    isTabbable(element: HTMLElement): boolean;
    isVisible(element: HTMLElement): boolean;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<InteractivityChecker, never>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<InteractivityChecker>;
}

// @public
export function isFakeMousedownFromScreenReader(event: MouseEvent): boolean;

// @public
export function isFakeTouchstartFromScreenReader(event: TouchEvent): boolean;

// @public
export class IsFocusableConfig {
    ignoreVisibility: boolean;
}

// @public
export class ListKeyManager<T extends ListKeyManagerOption> {
    constructor(_items: QueryList<T> | T[]);
    get activeItem(): T | null;
    get activeItemIndex(): number | null;
    readonly change: Subject<number>;
    destroy(): void;
    isTyping(): boolean;
    onKeydown(event: KeyboardEvent): void;
    setActiveItem(index: number): void;
    setActiveItem(item: T): void;
    setFirstItemActive(): void;
    setLastItemActive(): void;
    setNextItemActive(): void;
    setPreviousItemActive(): void;
    skipPredicate(predicate: (item: T) => boolean): this;
    readonly tabOut: Subject<void>;
    updateActiveItem(index: number): void;
    updateActiveItem(item: T): void;
    withAllowedModifierKeys(keys: ListKeyManagerModifierKey[]): this;
    withHomeAndEnd(enabled?: boolean): this;
    withHorizontalOrientation(direction: 'ltr' | 'rtl' | null): this;
    withPageUpDown(enabled?: boolean, delta?: number): this;
    withTypeAhead(debounceInterval?: number): this;
    withVerticalOrientation(enabled?: boolean): this;
    withWrap(shouldWrap?: boolean): this;
}

// @public
export type ListKeyManagerModifierKey = 'altKey' | 'ctrlKey' | 'metaKey' | 'shiftKey';

// @public
export interface ListKeyManagerOption {
    disabled?: boolean;
    getLabel?(): string;
}

// @public
export const LIVE_ANNOUNCER_DEFAULT_OPTIONS: InjectionToken<LiveAnnouncerDefaultOptions>;

// @public (undocumented)
export const LIVE_ANNOUNCER_ELEMENT_TOKEN: InjectionToken<HTMLElement | null>;

// @public
export function LIVE_ANNOUNCER_ELEMENT_TOKEN_FACTORY(): null;

// @public (undocumented)
export class LiveAnnouncer implements OnDestroy {
    constructor(elementToken: any, _ngZone: NgZone, _document: any, _defaultOptions?: LiveAnnouncerDefaultOptions | undefined);
    announce(message: string): Promise<void>;
    announce(message: string, politeness?: AriaLivePoliteness): Promise<void>;
    announce(message: string, duration?: number): Promise<void>;
    announce(message: string, politeness?: AriaLivePoliteness, duration?: number): Promise<void>;
    clear(): void;
    // (undocumented)
    ngOnDestroy(): void;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<LiveAnnouncer, [{ optional: true; }, null, null, { optional: true; }]>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<LiveAnnouncer>;
}

// @public
export interface LiveAnnouncerDefaultOptions {
    duration?: number;
    politeness?: AriaLivePoliteness;
}

// @public @deprecated
export const MESSAGES_CONTAINER_ID = "cdk-describedby-message-container";

// @public
export interface RegisteredMessage {
    messageElement: Element;
    referenceCount: number;
}

// (No @packageDocumentation comment for this package)