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

TINY-11482: fix tab navigation for ContextFormSlider #10035

Merged
merged 4 commits into from
Dec 6, 2024

Conversation

lorenzo-pomili
Copy link
Contributor

@lorenzo-pomili lorenzo-pomili commented Dec 5, 2024

Related Ticket: TINY-11482

Description of Changes:
fix tab navigation for ContextFormSlider

Pre-checks:

  • Changelog entry added
  • Tests have been added (if applicable)
  • Branch prefixed with feature/, hotfix/ or spike/

Review:

  • Milestone set
  • Docs ticket created (if applicable)

GitHub issues (if applicable):

Summary by CodeRabbit

  • New Features

    • Added a new entry in the changelog addressing keyboard navigation for the ContextFormSlider component.
  • Bug Fixes

    • Improved keyboard navigation functionality for the ContextFormSlider, enhancing user experience.
  • Tests

    • Introduced a new test case to verify keyboard navigation within the context slider form.

@lorenzo-pomili lorenzo-pomili added this to the 7.6.1 milestone Dec 5, 2024
@lorenzo-pomili lorenzo-pomili requested a review from a team as a code owner December 5, 2024 08:27
Copy link

coderabbitai bot commented Dec 5, 2024

Walkthrough

This pull request introduces a new changelog entry for the TinyMCE project, documenting a fix related to keyboard navigation for the ContextFormSlider component. Additionally, it modifies the renderContextFormSliderInput function to include a new CSS class for the slider input. A new test case is also added to validate the keyboard navigation functionality, ensuring users can navigate using the Tab key.

Changes

Files Change Summary
.changes/unreleased/tinymce-TINY-11482-2024-12-05.yaml Added a new changelog entry for a fix related to tab navigation for the ContextFormSlider component.
modules/tinymce/src/themes/silver/main/ts/ui/context/ContextFormSlider.ts Modified renderContextFormSliderInput to include a new class 'tox-toolbar-nav-js' in inputClasses.
modules/tinymce/src/themes/silver/test/ts/browser/editor/contextform/ContextSliderFormTest.ts Added a new test case for keyboard navigation in the context slider form and updated import statements.

Assessment against linked issues

Objective Addressed Explanation
User can't move focus to toolbar slider using keyboard tab (TINY-11482)

Possibly related PRs

Suggested reviewers

  • TheSpyder
  • hamza0867
  • ltrouton
  • noxuhax
  • spocke
  • HAFRMO
  • ztomaszyk

Poem

In the garden where the sliders play,
A hop and a skip, they find their way.
With a tap of the key, they dance in line,
Fixes and tests, oh how they shine!
TinyMCE, a joy to behold,
Navigating with ease, as the story unfolds. 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1fc91fe and 7b6d68d.

📒 Files selected for processing (1)
  • .changes/unreleased/tinymce-TINY-11482-2024-12-05.yaml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .changes/unreleased/tinymce-TINY-11482-2024-12-05.yaml

🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@lorenzo-pomili lorenzo-pomili requested review from a team, hamza0867, HAFRMO and ztomaszyk and removed request for a team December 5, 2024 08:27
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
modules/tinymce/src/themes/silver/main/ts/ui/context/ContextFormSlider.ts (1)

26-26: LGTM! Consider documenting the navigation class.

The addition of 'tox-toolbar-nav-js' class enables proper tab navigation, aligning with accessibility requirements. The implementation works in conjunction with existing keyboard handlers.

Consider adding a code comment explaining the purpose of 'tox-toolbar-nav-js' class for future maintainability.

modules/tinymce/src/themes/silver/test/ts/browser/editor/contextform/ContextSliderFormTest.ts (1)

157-174: Consider enhancing keyboard navigation test coverage.

While the current test effectively validates basic tab navigation, consider adding:

  1. Reverse navigation testing using Shift+Tab
  2. Verification that focus remains within the component
  3. Additional keyboard interaction tests (e.g., arrow keys on slider)

Here's a suggested enhancement:

  it('TINY-11482: should navigate correctly via keyboard', async () => {
    const editor = hook.editor();
    openToolbar(editor, 'test-form');

    const buttonASelector = '.tox-pop button[aria-label="A"]';
    const sliderSelector = '.tox-pop input';
    const buttonBSelector = '.tox-pop button[aria-label="B"]';

    // Forward tab navigation
    FocusTools.setFocus(SugarDocument.getDocument(), buttonASelector);
    await FocusTools.pTryOnSelector('Focus should be on the A button', SugarDocument.getDocument(), buttonASelector);
    TinyUiActions.keystroke(editor, Keys.tab());

    await FocusTools.pTryOnSelector('Focus should be on the slider', SugarDocument.getDocument(), sliderSelector);
    TinyUiActions.keystroke(editor, Keys.tab());

    await FocusTools.pTryOnSelector('Focus should be on the B button', SugarDocument.getDocument(), buttonBSelector);
    TinyUiActions.keystroke(editor, Keys.tab());
+
+    // Reverse tab navigation
+    await FocusTools.pTryOnSelector('Focus should stay on B button', SugarDocument.getDocument(), buttonBSelector);
+    TinyUiActions.keystroke(editor, Keys.tab(), { shiftKey: true });
+
+    await FocusTools.pTryOnSelector('Focus should be back on slider', SugarDocument.getDocument(), sliderSelector);
+    TinyUiActions.keystroke(editor, Keys.tab(), { shiftKey: true });
+
+    await FocusTools.pTryOnSelector('Focus should be back on A button', SugarDocument.getDocument(), buttonASelector);
+
+    // Test arrow keys on slider
+    TinyUiActions.keystroke(editor, Keys.tab());
+    await FocusTools.pTryOnSelector('Focus should be on slider', SugarDocument.getDocument(), sliderSelector);
+    TinyUiActions.keystroke(editor, Keys.right());
+    const input = UiFinder.findIn<HTMLInputElement>(SugarBody.body(), sliderSelector).getOrDie();
+    assert.isTrue(Number(Value.get(input)) > 37, 'Value should increase with right arrow');
  });
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1f5cefb and cb4732e.

📒 Files selected for processing (3)
  • .changes/unreleased/tinymce-TINY-11482-2024-12-05.yaml (1 hunks)
  • modules/tinymce/src/themes/silver/main/ts/ui/context/ContextFormSlider.ts (1 hunks)
  • modules/tinymce/src/themes/silver/test/ts/browser/editor/contextform/ContextSliderFormTest.ts (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .changes/unreleased/tinymce-TINY-11482-2024-12-05.yaml
🔇 Additional comments (1)
modules/tinymce/src/themes/silver/test/ts/browser/editor/contextform/ContextSliderFormTest.ts (1)

1-1: LGTM! Import addition is appropriate.

The addition of Keys import is necessary for the new keyboard navigation test.

@lorenzo-pomili lorenzo-pomili merged commit 2b49320 into main Dec 6, 2024
6 checks passed
@lorenzo-pomili lorenzo-pomili deleted the feature/TINY-11482 branch December 6, 2024 05:13
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.

3 participants