@payfit/unity-components
Version:
25 lines (24 loc) • 1.16 kB
TypeScript
import { AccessibilityOptionsType } from 'embla-carousel-accessibility';
import { IntlShape } from 'react-intl';
type AriaTextCallbackType = AccessibilityOptionsType['slideAriaLabel'];
/**
* Creates a function that generates aria labels for carousel slides
* based on grouping configuration.
* @param intl - The react-intl instance for translations
* @returns A callback function for the Embla accessibility plugin
*/
export declare function createSlideAriaLabel(intl: IntlShape): AriaTextCallbackType;
/**
* Creates a function that generates live region content for announcing
* slide changes to screen readers.
* @param intl - The react-intl instance for translations
* @returns A callback function for the Embla accessibility plugin
*/
export declare function createLiveRegionContent(intl: IntlShape): AriaTextCallbackType;
/**
* Creates the default accessibility options for the Embla carousel plugin.
* @param intl - The react-intl instance for translations
* @returns Options object for the Embla Accessibility plugin
*/
export declare function createCarouselAccessibilityOptions(intl: IntlShape): AccessibilityOptionsType;
export {};