fix: stop separation of heading and sub heading by screen reader (#3491)

Co-authored-by: karimim <[email protected]>
swisspost · Oct 8, 2024 · f2968b9 · f2968b9
1 parent 3551745
commit f2968b9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/.changeset/clean-icons-complain.md b/.changeset/clean-icons-complain.md
@@ -0,0 +1,6 @@
+---
+'@swisspost/design-system-documentation': patch
+'@swisspost/design-system-styles': patch
+---
+
+Improved accessibility of headings with subheadings by removing the <br> element and added the utility class d-block. Consult https://design-system.post.ch/?path=/docs/7ecd87f1-de96-4e39-a057-ba1798eb6959--docs for updated markup.
diff --git a/packages/documentation/src/stories/components/heading/heading.stories.ts b/packages/documentation/src/stories/components/heading/heading.stories.ts
@@ -89,8 +89,7 @@ export const Default: Story = {
     const tagName = unsafeStatic(args.level);
     const content = args.showSubtitle
       ? html`
-          <span>${args.title}</span>
-          <br />
+          <span class="d-block">${args.title}</span>
           <span class="fw-light">${args.subtitle}</span>
         `
       : args.title;