diff options
author | Christoph Cullmann <cullmann@kde.org> | 2024-04-28 17:33:09 +0200 |
---|---|---|
committer | Christoph Cullmann <cullmann@kde.org> | 2024-04-28 17:33:09 +0200 |
commit | e77051ccc4b47951bfa4fde2be436b1bb2fb113b (patch) | |
tree | f0b75ee3521da9c8cd39dac4359212348f70e4e8 /themes/blowfish/assets/lib/mermaid/accessibility.d.ts | |
parent | 4b355837824ac2422d371acef790f0f4249255c7 (diff) |
use https://github.com/nunocoracao/blowfish.git
Diffstat (limited to 'themes/blowfish/assets/lib/mermaid/accessibility.d.ts')
-rw-r--r-- | themes/blowfish/assets/lib/mermaid/accessibility.d.ts | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/themes/blowfish/assets/lib/mermaid/accessibility.d.ts b/themes/blowfish/assets/lib/mermaid/accessibility.d.ts new file mode 100644 index 0000000..7e9703e --- /dev/null +++ b/themes/blowfish/assets/lib/mermaid/accessibility.d.ts @@ -0,0 +1,27 @@ +/** + * Accessibility (a11y) functions, types, helpers. + * + * @see https://www.w3.org/WAI/ + * @see https://www.w3.org/TR/wai-aria-1.1/ + * @see https://www.w3.org/TR/svg-aam-1.0/ + */ +import type { D3Element } from './mermaidAPI.js'; +/** + * Add role and aria-roledescription to the svg element. + * + * @param svg - d3 object that contains the SVG HTML element + * @param diagramType - diagram name for to the aria-roledescription + */ +export declare function setA11yDiagramInfo(svg: D3Element, diagramType: string): void; +/** + * Add an accessible title and/or description element to a chart. + * The title is usually not displayed and the description is never displayed. + * + * The following charts display their title as a visual and accessibility element: gantt. + * + * @param svg - d3 node to insert the a11y title and desc info + * @param a11yTitle - a11y title. undefined or empty strings mean to skip them + * @param a11yDesc - a11y description. undefined or empty strings mean to skip them + * @param baseId - id used to construct the a11y title and description id + */ +export declare function addSVGa11yTitleDescription(svg: D3Element, a11yTitle: string | undefined, a11yDesc: string | undefined, baseId: string): void; |