microsoft / microsoft/AdaptiveCards

[Accessibility] Support AltText for AdaptiveTextBlock

Open
#4,284 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Accessibility Request Task
Dominant language
C#
Stars
2k
Forks
595
Avg merge
1d 19h
Merged PRs (30d)
1

Description

Platform

  • .NET WPF
  • UWP

(We use the above platforms but this is a schema ask)

Author or host

Author & Host

If you're an author, who are you sending cards to?
1.2.9

Explain your issue. If you just have a question, please post [on StackOverflow instead]

We've been seeing some accessibility issues where the information written in an Adaptive Text Block is not enough information for a narrator user or narrator reads it out strangely. Some examples below

  • 1hr is read out as 1 H R (rather than the expected 'One Hour')
  • Any text block with a bullet point or unexpected character cannot be read out by narrator so causes accessibility issues.

It would be great if Adaptive could support an altText parameter for Adaptive text blocks (to be read out by screen readers) as part of the schema, that then is used an the screen reader text.

Something like the below

        {
            "type": "TextBlock",
            "text": "1hr",
            "altText": "One hour"
        }

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Adaptive Cards schema and the accessibility behavior described for .NET WPF and UWP. Determine where a TextBlock altText property would be defined and how screen readers should consume it; the work is done when the schema supports the example and the reported narrator cases have an accessible alternative.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
accessibility
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.