Skip to content

refactor(QTI): favor removing the answer guide component for inline interactions #15194

Description

@habibayman

This issue is not open for contribution. Visit Contributing guidelines to learn about the contributing process and how to find suitable issues.

Overview

Complexity: Low
Target branch: develop

Follow-up cleanup for TextEntryInteraction after #14993. The "Short answer only:" answer guide text is being removed rather than reworked for inline rendering, per discussion with @rtibbles and @marcellamaki . This also requires a new approach for displaying pattern-mask validation errors, since that display currently leans on the guide text's markup/positioning.

Context

Answer guide text (e.g. "Short answer only:") doesn't have a sensible place to render once the interaction is inline with surrounding text, and is being treated as unnecessary more broadly, not just for this component — to be reintroduced later only if it's proven needed.

Pattern-mask validation error display currently depends on the guide's structure and needs a different approach that works with the input inline.

The Change

  • Remove AnswerGuide ("Short answer only:") from all inline interactions
  • Rework pattern-mask validation error display so it doesn't depend on the removed guide markup and works with the input rendering inline.

Out of Scope

  • Any change to numeric keypad or pattern-mask coercion logic itself, only how/where the validation message is displayed.

Acceptance Criteria

General

  • The "Short answer only:" / AnswerGuide text is removed from TextEntryInteraction and InlineChoiceInteraction.
  • Pattern-mask validation errors are still visible to the user, with a display approach that works with inline rendering and doesn't rely on the removed guide markup.

Accessibility and i18n

  • Validation error remains announced/associated via aria-invalid/aria-describedby as before.

Testing

  • Unit tests updated to reflect removal of AnswerGuide from this component.
  • Manual verification in /qti_sandbox that validation errors still display and are accessible after the guide text is removed.

References

AI usage

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions