Info and relationships issues #16231

Mati365 · 2024-04-17T07:11:34Z

Suggested merge commit message (convention)

Docs: Improved accessibility of tooltips in documentation by switching from aria-expanded to aria-describedby in elements they are attached to.
Feature (engine): Improved accessibility of editor placeholders by adding aria-placeholder attributes to elements that placeholders are attached to.
Fix: Source mode and show block buttons are no longer marked as dropdown buttons in aria attributes.
Fix (ui): Improve accessibility of menu bar toggle items by marking them as menucheckbox aria roles.

Additional information

Closes https://github.com/cksource/ckeditor5-commercial/issues/6037
Commercial PR: https://github.com/cksource/ckeditor5-commercial/pull/6180

Summary by CodeRabbit

New Features
- Enhanced button functionalities across various UI components, setting roles as 'menuitemcheckbox' and making them toggleable for improved accessibility and user interaction.
Refactor
- Optimized button creation and property settings in multiple classes to streamline command bindings and role assignments.
Style
- Updated ARIA attributes across UI components to better align with accessibility standards, including the removal of 'ariaChecked' and introduction of '_ariaPressed' and '_ariaChecked'.
Bug Fixes
- Corrected ARIA attribute handling in button views to ensure proper state reflection based on button roles and toggle states.
Tests
- Expanded test cases to cover new ARIA attribute checks and button state validations, ensuring robust functionality.

coderabbitai · 2024-04-19T06:16:37Z

Walkthrough

The recent updates across various CKEditor5 packages primarily focus on enhancing accessibility by standardizing roles like 'menuitemcheckbox' and adjusting properties related to ARIA states such as 'aria-pressed' and 'aria-checked. These changes aim to ensure consistent handling of UI components, particularly buttons, across different editor functionalities, promoting better accessibility practices within the editor's UI components.

Changes

File Path	Change Summary
`.../src/bold/boldui.ts` `.../src/italic/italicui.ts` `.../src/strikethrough/strikethroughui.ts` `.../src/subscript/subscriptui.ts` `.../src/superscript/superscriptui.ts` `.../src/underline/underlineui.ts`	Updated button creation with `role: 'menuitemcheckbox'` and bindings to `command`'s `value`.
`.../src/code/codeui.ts`	Adjusted command initialization and button view configuration.
`.../src/codeblockui.ts`	Updated `menuView.buttonView` properties and removed `ariaChecked` binding.
`.../src/list/utils.ts` `.../src/sourceediting.ts`	Added `role: 'menuitemcheckbox'` and `isToggleable: true` to button properties.
`.../src/button/button.ts` `.../src/dropdown/button/splitbuttonview.ts`	Removed `ariaChecked` from public entities.
`.../src/button/buttonview.ts`	Introduced `_ariaPressed` and `_ariaChecked` attributes for managing ARIA states.
`.../tests/button/buttonview.js` `.../tests/dropdown/utils.js`	Updated tests to reflect changes in ARIA attribute handling and button roles.

This table groups files with similar changes together, providing a clear overview of the type of modifications made across different components of the CKEditor5 project.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between df984ae and 050ad43.

Files selected for processing (1)

packages/ckeditor5-engine/tests/view/placeholder.js (1 hunks)

Files skipped from review as they are similar to previous changes (1)

packages/ckeditor5-engine/tests/view/placeholder.js

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

packages/ckeditor5-ui/tests/dropdown/utils.js

oleq

Some things are fine, some need changes and some need to be cleared up.

packages/ckeditor5-show-blocks/src/showblocksui.ts

oleq · 2024-04-29T13:33:36Z

packages/ckeditor5-basic-styles/src/bold/boldui.ts

+				role: 'menuitemcheckbox'
+			} );
+
+			buttonView.bind( 'isOn' ).to( command, 'value' );


This change gives menu bar buttons like bold, italic, etc. the "on" state

that sometimes is not announced in menu bar implementations

or gets expressed as a check mark (we don't have this functionality yet)

This is a big design decision. Let's talk it over.

packages/ckeditor5-code-block/src/codeblockui.ts

packages/ckeditor5-language/src/textpartlanguageui.ts

packages/ckeditor5-list/src/list/utils.ts

packages/ckeditor5-engine/src/view/placeholder.ts

oleq · 2024-04-29T14:11:56Z

packages/ckeditor5-engine/tests/view/placeholder.js

+					element: child2
+				} );
+
+				expect( parent.getAttribute( 'aria-placeholder' ) ).to.be.equal( 'Hello World!, Helloooo!!' );


What value would that be to the users? There could be 10 placeholders in 10 random places in the document (at different nesting levels). It doesn't seem like aggregation is the way to go here. Here's the screenshot from http://fake.ckeditor.com:8125/ckeditor5-heading/tests/manual/title.html

Shouldn't the aria-placeholder attribute change dynamically as users move between placeholder-enabled elements? Would a screen reader even respect that?

Placeholder should provide an additional description for the field that is currently focused. Reading placeholders of all fields in one place defeats the purpose of that mechanism.

I would simply leave aria-placeholders in the title and body fields, removing it from the editor itself. But I'm not sure if it would be read 🤔 Dynamically changing placeholder also sounds like something that would be ignored.

@Comandeer / @oleq So what should we do?

coderabbitai

Actionable comments posted: 1

packages/ckeditor5-engine/tests/view/placeholder.js

Use aria-describedby instead of aria-expanded in docs tooltips

681573a

Mati365 changed the title ~~Use aria-describedby instead of aria-expanded in docs tooltips~~ Info and relationships issues Apr 17, 2024

Mati365 added 2 commits April 17, 2024 13:27

Add aria-pressed to toggle source mode and show blocks buttons

9d5e2b0

Add aria-checked to menu entries

d395a51

Mati365 force-pushed the ck/6037 branch from c18d794 to d395a51 Compare April 18, 2024 07:43

Mati365 added 4 commits April 18, 2024 09:45

Adjust docs

3a527b3

Adjust typings

8939627

Fix tests

2a92753

Add more tests

cf61664

Mati365 marked this pull request as ready for review April 18, 2024 09:15

Mati365 added 6 commits April 18, 2024 13:12

Add aria-placeholder entry for nearest contenteditable element

0d2a855

Update jsdoc

f638c38

Add aria placeholders tests

90e181a

Fix tests

c36ee73

Fix tests

c27e573

Add more tests

927842f

ckeditor deleted a comment from coderabbitai bot Apr 19, 2024

Use span tag in document colors label

509b0ea

Mati365 added 4 commits April 19, 2024 09:30

Fix aria-checked attributes

e164525

Adjust tests

5dc95ff

Adjust tests

3f07ae2

Add missing role

254852e

Mati365 requested a review from oleq April 19, 2024 08:40

Mati365 added 2 commits April 29, 2024 08:45

Drop isCheckbox flag

2481501

Remove not used isCheckbox tests

fbe600b

coderabbitai bot reviewed Apr 29, 2024

View reviewed changes

packages/ckeditor5-ui/tests/dropdown/utils.js Show resolved Hide resolved

oleq and others added 2 commits April 29, 2024 09:51

Merge branch 'master' into ck/6037

cf357e0

Fix role in menu list entries

8396934

oleq requested changes Apr 29, 2024

View reviewed changes

Mati365 marked this pull request as draft April 30, 2024 05:10

Mati365 added 9 commits April 30, 2024 12:58

Use findAncestor in tryLookupForNearestContentEditable

603df5e

Better asseration in tryLookupForNearestContentEditable

5c0b32e

Fix code block entry role

291c9a9

Add missing aria-checked to codeblock items

b09fc7c

Add codeblock ui tests

199e323

Add show blocks menu entry role

119c867

Add text part language ui units

40361cc

adjust tests

32537b7

Adjust list factory tests

df984ae

Mati365 marked this pull request as ready for review April 30, 2024 12:03

coderabbitai bot reviewed Apr 30, 2024

View reviewed changes

packages/ckeditor5-engine/tests/view/placeholder.js Show resolved Hide resolved

Add current element checks to placeholders assign

050ad43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Info and relationships issues #16231

Info and relationships issues #16231

Mati365 commented Apr 17, 2024 •

edited by coderabbitai bot

coderabbitai bot commented Apr 19, 2024 •

edited

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

oleq left a comment

oleq Apr 29, 2024

oleq Apr 29, 2024

Comandeer Apr 29, 2024

Mati365 Apr 30, 2024

coderabbitai bot left a comment

Info and relationships issues #16231

Are you sure you want to change the base?

Info and relationships issues #16231

Conversation

Mati365 commented Apr 17, 2024 • edited by coderabbitai bot

Suggested merge commit message (convention)

Additional information

Summary by CodeRabbit

coderabbitai bot commented Apr 19, 2024 • edited

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

oleq left a comment

Choose a reason for hiding this comment

oleq Apr 29, 2024

Choose a reason for hiding this comment

oleq Apr 29, 2024

Choose a reason for hiding this comment

Comandeer Apr 29, 2024

Choose a reason for hiding this comment

Mati365 Apr 30, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

Mati365 commented Apr 17, 2024 •

edited by coderabbitai bot

coderabbitai bot commented Apr 19, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)