Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

a11y(Alert): give Alert alertdialog role #6846

Merged
merged 4 commits into from
Jun 26, 2024

Conversation

bvandercar-vt
Copy link
Contributor

@bvandercar-vt bvandercar-vt commented Jun 12, 2024

Checklist

  • [N/A] Includes tests
  • [N/A] Update documentation

Changes proposed in this pull request:

  1. Make Dialog role prop configurable (default="dialog")
  2. Set Alert's Dialog's role to alertdialog: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alertdialog_role

@changelog-app
Copy link

changelog-app bot commented Jun 12, 2024

Generate changelog in packages/core/changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

feat(a11y): give Alert alertdialog role

Check the box to generate changelog(s)

  • Generate changelog entry

@@ -172,6 +172,7 @@ export class Alert extends AbstractPureComponent<AlertProps> {
return (
<Dialog
{...overlayProps}
role="alertdialog"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may also want to set aria-modal="true" when setting this role


We may also want to follow this guidance if adding this role

The alert dialog must have at least one focusable control — such as Confirm, Close, and Cancel — and focus must be moved to that control when the alert dialog appears. Alertdialogs can have additional interactive controls such as text fields and checkboxes.

From my logging it appears focus is initially on the start of the dialog focus trap
Screenshot 2024-06-17 at 11 15 56 PM

Copy link
Contributor Author

@bvandercar-vt bvandercar-vt Jun 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call. Tied aria-modal to the enforceFocus prop in Dialog, these seemed to be one in the same. 1a9709b

/**
* @default "dialog"
*/
role?: React.AriaRole;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we have an explicit list of values we expect to be valid given the setup of this component? "dialog" | "alertdialog" feels like a reasonable place to start that can be expanded as needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bvandercar-vt bvandercar-vt changed the title feat(a11y): give Alert alertdialog role a11y(Alert): give Alert alertdialog role Jun 25, 2024
Copy link
Contributor

@evansjohnson evansjohnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@evansjohnson evansjohnson self-assigned this Jun 26, 2024
@evansjohnson evansjohnson merged commit f9a1b48 into palantir:develop Jun 26, 2024
12 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants