frontend icon indicating copy to clipboard operation
frontend copied to clipboard
verified publisher icon codecrafters-io

CC-1204 add keyboard shortcuts for concept questions

Open libmartinito opened this issue 1 year ago • 7 comments

Summary by CodeRabbit

  • New Features

    • Enhanced keyboard navigation for question cards, including support for number, letter, and arrow keys.
    • Added visual focus indicators and feedback text on question selection.

  • Tests

    • Implemented new tests to verify keyboard interactions with question options.

  • Refactor

    • Updated event handlers for better clarity and functionality in question card interactions.

libmartinito avatar May 08 '24 14:05 libmartinito

Walkthrough

The recent updates enhance user interaction by improving keyboard functionality for navigating and selecting options within question cards. These changes introduce new tests for key-based navigation, update page object methods for focus and key events, and refine component logic to handle key inputs for option selection and movement effectively.

Changes

File Path Change Summary
tests/acceptance/concepts-test.js Added tests for simulating user interactions with questions using keys for option selection.
tests/pages/concept-page.js Updated concept-page.js with functions for focus, text presence, and key event triggering.
app/components/concept-page/question-card.hbs Improved key event management in question cards by updating event handlers.
app/components/concept-page/question-card.ts Enhanced component logic for key-based option selection and navigation.

🐇✨ A rabbit hopped through code, quite spry, With keys on the board, it could fly. Up, down, letters, and digits align, Questions answered, one hop at a time. Cheers to the devs, oh so wise! 🎉 🐇✨

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[bot] avatar May 08 '24 14:05 coderabbitai[bot]

CC-1204 Add keyboard shortcuts for concept questions

linear[bot] avatar May 08 '24 14:05 linear[bot]

Test Results

  1 files  ±0    1 suites  ±0   4m 27s :stopwatch: - 4m 41s 436 tests +7  435 :white_check_mark: +10  1 :zzz: ±0  0 :x: ±0  451 runs  +7  450 :white_check_mark: +13  1 :zzz: ±0  0 :x:  - 3 

Results for commit 90ef27b0. ± Comparison against base commit 6664d551.

:recycle: This comment has been updated with latest results.

github-actions[bot] avatar May 08 '24 14:05 github-actions[bot]

Codecov Report

Attention: Patch coverage is 66.66667% with 10 lines in your changes are missing coverage. Please review.

:white_check_mark: All tests successful. No failed tests found.

Files Patch % Lines
app/components/concept-page/question-card.ts 66.66% 5 Missing and 5 partials :warning:
Additional details and impacted files

:loudspeaker: Thoughts on this report? Let us know!

codecov[bot] avatar May 08 '24 14:05 codecov[bot]

had to remove tests for navigation. problems were with how ember-cli-page-object behaves:

  • for j/k: triggerable + keydown event doesn't accept lowercase keys
  • for Enter: triggerable + keydown requires a selector where the element would be triggered. this is a problem because we removed explicit handling for keydown events with 'Enter' as this is an expected browser behavior

libmartinito avatar May 10 '24 18:05 libmartinito

@libmartinito Managed to add tests here, recorded videos:

  • https://www.loom.com/share/13ce0573c4cd4dda949524488b3d835f
  • https://www.loom.com/share/55f50d498fdd41d48d26352ef38f4cf4

rohitpaulk avatar May 11 '24 00:05 rohitpaulk

@libmartinito when using arrow keys, the page moves too - is this intended? I'd expect scrolling to be hijacked when a question card is "active" (i.e. after it's answered, arrow keys should work like normal but when it's active arrow keys should just select options and not move the page)

rohitpaulk avatar May 12 '24 19:05 rohitpaulk