Website - CodeBlock a11y improvements docs
#2896
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dchyun
changed the title
CodeBlock a11y improvements docsCodeBlock a11y improvements docs
2 tasks
dchyun
force-pushed
the
dchyun/docs-code-block-a11y-improvements
branch
from
7a3f514 to
0201cbd
Compare
didoo
reviewed
Jun 4, 2025
| @@ -11,6 +11,15 @@ This component uses [prism.js](https://prismjs.com/) under the hood. | |||
| <C.Property @name="<[CB].Description>" @type="yielded component"> | |||
| `ContentBlock::Description` yielded as contextual component (see below). | |||
| </C.Property> | |||
| <C.Property @name="ariaLabel" @type="string"> | |||
| Accepts a localized string. The `ariaLabel` value is applied to the code block pre element. | |||
There was a problem hiding this comment.
[question] why are we saying "localized" here? we don't mention localization in any other parts o the APIs (plus it works even if it's not localized)
There was a problem hiding this comment.
I was matching the language used for the aria attributes in the component api of the Code Editor docs
There was a problem hiding this comment.
OK, I'll ask the team what they think of this.
didoo
approved these changes
Jun 4, 2025
| @@ -11,6 +11,15 @@ This component uses [prism.js](https://prismjs.com/) under the hood. | |||
| <C.Property @name="<[CB].Description>" @type="yielded component"> | |||
| `ContentBlock::Description` yielded as contextual component (see below). | |||
| </C.Property> | |||
| <C.Property @name="ariaLabel" @type="string"> | |||
| Accepts a localized string. The `ariaLabel` value is applied to the code block pre element. | |||
There was a problem hiding this comment.
OK, I'll ask the team what they think of this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📌 Summary
If merged, this PR would update the
CodeBlockdocs to include new aria arguments from #2879.The
ariaDescribedByargument was also added to theCodeEditordocs, which was already present in the component through its extension of thehds-code-editormodifier.🔗 External links
Jira ticket: HDS-3349
👀 Component checklist
💬 Please consider using conventional comments when reviewing this PR.