@wordpress/components
Version:
UI components for WordPress.
27 lines • 1.08 kB
TypeScript
/**
* Hides all elements in the body element from screen-readers except
* the provided element and elements that should not be hidden from
* screen-readers.
*
* The reason we do this is because `aria-modal="true"` currently is bugged
* in Safari, and support is spotty in other browsers overall. In the future
* we should consider removing these helper functions in favor of
* `aria-modal="true"`.
*
* @param {HTMLDivElement} unhiddenElement The element that should not be hidden.
*/
export declare function hideApp(unhiddenElement?: HTMLDivElement): void;
/**
* Determines if the passed element should not be hidden from screen readers.
*
* @param {HTMLElement} element The element that should be checked.
*
* @return {boolean} Whether the element should not be hidden from screen-readers.
*/
export declare function elementShouldBeHidden(element: Element): boolean;
/**
* Makes all elements in the body that have been hidden by `hideApp`
* visible again to screen-readers.
*/
export declare function showApp(): void;
//# sourceMappingURL=aria-helper.d.ts.map