| 1 | /**
|
|---|
| 2 | * @license
|
|---|
| 3 | * Copyright Google LLC All Rights Reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Use of this source code is governed by an MIT-style license that can be
|
|---|
| 6 | * found in the LICENSE file at https://angular.io/license
|
|---|
| 7 | */
|
|---|
| 8 | import { Platform } from '@angular/cdk/platform';
|
|---|
| 9 | /**
|
|---|
| 10 | * Configuration for the isFocusable method.
|
|---|
| 11 | */
|
|---|
| 12 | import * as ɵngcc0 from '@angular/core';
|
|---|
| 13 | export declare class IsFocusableConfig {
|
|---|
| 14 | /**
|
|---|
| 15 | * Whether to count an element as focusable even if it is not currently visible.
|
|---|
| 16 | */
|
|---|
| 17 | ignoreVisibility: boolean;
|
|---|
| 18 | }
|
|---|
| 19 | /**
|
|---|
| 20 | * Utility for checking the interactivity of an element, such as whether is is focusable or
|
|---|
| 21 | * tabbable.
|
|---|
| 22 | */
|
|---|
| 23 | export declare class InteractivityChecker {
|
|---|
| 24 | private _platform;
|
|---|
| 25 | constructor(_platform: Platform);
|
|---|
| 26 | /**
|
|---|
| 27 | * Gets whether an element is disabled.
|
|---|
| 28 | *
|
|---|
| 29 | * @param element Element to be checked.
|
|---|
| 30 | * @returns Whether the element is disabled.
|
|---|
| 31 | */
|
|---|
| 32 | isDisabled(element: HTMLElement): boolean;
|
|---|
| 33 | /**
|
|---|
| 34 | * Gets whether an element is visible for the purposes of interactivity.
|
|---|
| 35 | *
|
|---|
| 36 | * This will capture states like `display: none` and `visibility: hidden`, but not things like
|
|---|
| 37 | * being clipped by an `overflow: hidden` parent or being outside the viewport.
|
|---|
| 38 | *
|
|---|
| 39 | * @returns Whether the element is visible.
|
|---|
| 40 | */
|
|---|
| 41 | isVisible(element: HTMLElement): boolean;
|
|---|
| 42 | /**
|
|---|
| 43 | * Gets whether an element can be reached via Tab key.
|
|---|
| 44 | * Assumes that the element has already been checked with isFocusable.
|
|---|
| 45 | *
|
|---|
| 46 | * @param element Element to be checked.
|
|---|
| 47 | * @returns Whether the element is tabbable.
|
|---|
| 48 | */
|
|---|
| 49 | isTabbable(element: HTMLElement): boolean;
|
|---|
| 50 | /**
|
|---|
| 51 | * Gets whether an element can be focused by the user.
|
|---|
| 52 | *
|
|---|
| 53 | * @param element Element to be checked.
|
|---|
| 54 | * @param config The config object with options to customize this method's behavior
|
|---|
| 55 | * @returns Whether the element is focusable.
|
|---|
| 56 | */
|
|---|
| 57 | isFocusable(element: HTMLElement, config?: IsFocusableConfig): boolean;
|
|---|
| 58 | static ɵfac: ɵngcc0.ɵɵFactoryDeclaration<InteractivityChecker, never>;
|
|---|
| 59 | }
|
|---|
| 60 |
|
|---|
| 61 | //# sourceMappingURL=interactivity-checker.d.ts.map |
|---|
