Fix Adaptive Cards TextBlock
element missing aria-level
#4329
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog Entry
Fixed
TextBlock
withstyle="heading"
should havearia-level
set, by @compulim, in PR #4329Description
By default, Adaptive Cards generate DOM with
role="heading"
withoutaria-level
set. This violated WCAG 4.1.2 (ARIA5).In order to set
aria-level
, we need to explicitly setACHostConfig.textBlock.headingLevel
to1
. This is an undocumented option introduced by microsoft/AdaptiveCards#5635 and microsoft/AdaptiveCards#5698.Design
This is code in Adaptive Cards repo
card-elements.ts
.If the Adaptive Card
TextBlock
element hasstyle="heading"
, therole="heading"
will be applied. However,aria-level
is not set unlessACHostConfig.textBlock.headingLevel
is set. This is an undocumented option and required for accessibility. Otherwise, we would fail with WCAG 4.1.2 (ARIA5).We need to explicitly set
ACHostConfig.textBlock.headingLevel
to make surearia-level
is set onrole="heading"
. As we do not use heading, we default it to level 1.Specific Changes
adaptiveCardHostConfig.ts
to addtextBlock.headingLevel
to1
verifyDOMIntegrity.js
for verifying our DOM tree is goodverifyDOMIntegrity()
call to all card-related attachmentsCHANGELOG.md
Review Checklist
Browser and platform compatibilities reviewedCSS styles reviewed (minimal rules, noz-index
)Documents reviewed (docs, samples, live demo)Internationalization reviewed (strings, unit formatting)package.json
andpackage-lock.json
reviewedSecurity reviewed (no data URIs, check for nonce leak)