Skip to content

fix(docs): leftovers of attribute changes from last major release #4681

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mfranzke
Copy link
Collaborator

@mfranzke mfranzke commented Aug 5, 2025

Proposed changes

Converted some leftovers of attribute changes from last major release 3.x out the changes by #4476, mainly for tooltip documentation.

partly resolves #4680 (the documentation part)

Types of changes

  • Bugfix (non-breaking change that fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (improvements to existing components or architectural decisions)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Further comments

@mfranzke mfranzke self-assigned this Aug 5, 2025
@mfranzke mfranzke requested a review from nmerget as a code owner August 5, 2025 10:41
@mfranzke mfranzke added 🐛bug Something isn't working 📕documentation Improvements or additions to documentation labels Aug 5, 2025
@mfranzke mfranzke changed the title fix(docs): converted some leftovers of attribute changes from last major fix(docs): leftovers of attribute changes from last major Aug 5, 2025
Copy link
Contributor

github-actions bot commented Aug 5, 2025

🔭🐙🐈 Test this branch here: https://db-ux-design-system.github.io/core-web/review/fix-converted-leftovers

@mfranzke mfranzke linked an issue Aug 5, 2025 that may be closed by this pull request
7 tasks
@mfranzke mfranzke moved this to 👀 In review in UX Engineering Team Backlog Aug 5, 2025
@mfranzke mfranzke removed their assignment Aug 5, 2025
@mfranzke mfranzke enabled auto-merge (squash) August 5, 2025 10:42
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@mfranzke mfranzke changed the title fix(docs): leftovers of attribute changes from last major fix(docs): leftovers of attribute changes from last major release Aug 5, 2025
@mfranzke mfranzke requested a review from Copilot August 5, 2025 21:36
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes documentation leftovers from a previous major release by updating outdated attribute names in tooltip examples. The changes address inconsistencies where the old describedbyid attribute was still being used instead of the standard aria-describedby attribute.

  • Updates tooltip documentation examples across React, Vue, and Angular frameworks
  • Fixes test file to use correct attribute name
  • Ensures consistency with accessibility standards by using proper ARIA attributes

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.

File Description
tooltip.spec.tsx Updates test case to use aria-describedby instead of describedbyid
Vue.md Fixes Vue documentation example to use correct ARIA attribute
React.md Updates React documentation example with proper attribute name
Angular.md Corrects Angular documentation example to use standard ARIA attribute

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛bug Something isn't working 📕documentation Improvements or additions to documentation postReview
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

describedbyid is reported as non existent on DBButton
2 participants