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.

Sign up for GitHub

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

Jump to bottom

Docs: Add a callout about accessibility on tooltips hiding important content #2021

Merged
merged 7 commits into from
Jun 12, 2023
Merged

Docs: Add a callout about accessibility on tooltips hiding important content #2021

merged 7 commits into from
Jun 12, 2023

Conversation

hannahiss
Copy link
Member

@hannahiss hannahiss commented May 2, 2023 •
edited by louismaximepiton
Loading

Note: Please transform - [ ] into - (NA) in the description when things are not applicable

Related issues

Linked to PR #1823

Description

Add some information to developers so that they can use tooltips in the most accessible way.

Motivation & Context

During #1823 a11y review, our expert informed us that Boosted tooltips are missing a mechanism is available to dismiss the tooltip without moving pointer hover or keyboard focus. See WCAG site.

Types of change

  • Bug fix (non-breaking which fixes an issue)

Live previews

Checklist

Contribution

Accessibility

  • My change follows accessibility good practices; I have at least run axe

Design

  • My change respects the design guidelines defined in Orange Design System
  • My change is compatible with responsive display

Development

  • My change follows the developer guide
  • (NA) I have added JavaScript unit tests to cover my changes
  • (NA) I have added SCSS unit tests to cover my changes

Documentation

  • My change introduces changes to the documentation and/or I have updated the documentation accordingly

Checklist (for Core Team only)

  • (NA) My change introduces changes to the migration guide
  • (NA) My new component is added in Storybook
  • (NA) My new component is compatible with RTL
  • (NA) Manually run BrowserStack tests
  • (NA) Manually test browser compatibility with BrowserStack (Chrome >= 60, Firefox >= 60 (+ ESR), Edge, Safari >= 12, iOS Safari, Chrome & Firefox on Android)
  • Code review
  • Design review
  • A11y review

After the merge

@sonarcloud
Copy link

sonarcloud bot commented May 2, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@hannahiss hannahiss changed the title Add a callout about accessibility on tooltips hiding important content Docs: Add a callout about accessibility on tooltips hiding important content May 2, 2023
@netlify
Copy link

netlify bot commented May 2, 2023 •
edited
Loading

✅ Deploy Preview for boosted ready!

Name Link
🔨 Latest commit eb65b7e
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/6486e903e8883c00075e9eb5
😎 Deploy Preview https://deploy-preview-2021--boosted.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@hannahiss hannahiss marked this pull request as ready for review May 2, 2023 15:24
@hannahiss hannahiss added v5 accessibility upcoming a11y review docs Improvements or additions to documentation labels May 2, 2023
louismaximepiton
louismaximepiton requested changes Jun 6, 2023
View reviewed changes
Copy link
Member

@louismaximepiton louismaximepiton left a comment

Choose a reason for hiding this comment

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

Some few things

site/content/docs/5.3/components/tooltips.md Outdated Show resolved Hide resolved
site/content/docs/5.3/components/tooltips.md Show resolved Hide resolved
site/content/docs/5.3/components/tooltips.md Outdated Show resolved Hide resolved
@hannahiss hannahiss self-assigned this Jun 9, 2023
@sonarcloud
Copy link

sonarcloud bot commented Jun 12, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@julien-deramond julien-deramond merged commit 7c5afc1 into main Jun 12, 2023
@julien-deramond julien-deramond deleted the main-his-tooltip-a11y branch June 12, 2023 09:52
@julien-deramond julien-deramond mentioned this pull request Jun 12, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@julien-deramond julien-deramond julien-deramond approved these changes

@louismaximepiton louismaximepiton louismaximepiton approved these changes

Assignees

@hannahiss hannahiss

Labels
accessibility docs Improvements or additions to documentation upcoming a11y review v5
Projects
🟣 [Orange-Boosted-Bootstrap] PRs Board
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hannahiss @julien-deramond @louismaximepiton