inbox-zero icon indicating copy to clipboard operation
inbox-zero copied to clipboard

added shortcuts in /mail

Open Saksham1387 opened this issue 8 months ago • 5 comments

Fixes: #343

I have added the mentioned shortcuts

E --> archive R --> Reply

and have also added Arrow up/down

Screenshot 2025-04-06 at 23 54 20

Summary by CodeRabbit

  • New Features
    • Introduced keyboard navigation for the email list, allowing users to reply and archive emails quickly using the keyboard.
    • Enhanced visual cues now clearly indicate the currently selected email thread for an improved user experience.

Saksham1387 avatar Apr 06 '25 18:04 Saksham1387

@Saksham1387 is attempting to deploy a commit to the Inbox Zero Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Apr 06 '25 18:04 vercel[bot]

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Apr 06 '25 18:04 CLAassistant

Walkthrough

The changes add keyboard navigation to the EmailList component. A new custom hook, useEmailListKeyboardNav, manages keyboard actions for replying and archiving email threads. The mapping over threads now includes an index to visualize the focused state, and the handleAction function is updated accordingly. The previous keyboard event listener hook has been removed in favor of the new encapsulated approach.

Changes

File(s) Summary of Changes
apps/web/components/…/EmailList.tsx - Added useEmailListKeyboardNav hook to manage keyboard interactions.
- Updated threads.map to include the index parameter for focus handling.
- Revised handleAction function for "reply" and "archive" actions.
- Removed the old useEffect for keyboard event listeners.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EmailList
    participant KeyboardNav

    User->>EmailList: Press key (R, E, or Arrow)
    EmailList->>KeyboardNav: Handle key event via hook
    KeyboardNav->>EmailList: Trigger action (reply/archive or update focus)
    EmailList->>User: Update UI with focused thread/action executed

Assessment against linked issues

Objective Addressed Explanation
Mail: Add keyboard shortcuts (#343)

Possibly related PRs

  • elie222/inbox-zero#369: Modifies keyboard navigation and updates the handleAction function in the EmailList component.
  • elie222/inbox-zero#326: Implements keyboard navigation using custom hooks, similar to the approach in this PR.

Suggested reviewers

  • elie222

Poem

In the world of code, I happily hop,
Adding shortcuts that make the UI pop.
With keys to reply and archive on cue,
Each press a little dance, so fresh and new.
Cheers from a rabbit, in this code breakthrough! 🐇✨

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

Scope: all 2 workspace projects  WARN  GET http://10.0.0.28:4873/turbo error (503). Will retry in 10 seconds. 2 retries left.  WARN  GET http://10.0.0.28:4873/eslint/-/eslint-9.23.0.tgz error (ERR_PNPM_FETCH_503). Will retry in 10 seconds. 2 retries left.  WARN  GET http://10.0.0.28:4873/@vercel/style-guide/-/style-guide-6.0.0.tgz error (ERR_PNPM_FETCH_503). Will retry in 10 seconds. 2 retries left.  WARN  GET http://10.0.0.28:4873/eslint-plugin-only-warn/-/eslint-plugin-only-warn-1.1.0.tgz error (ERR_PNPM_FETCH_503). Will retry in 10 seconds. 2 retries left.  WARN  GET http://10.0.0.28:4873/typescript/-/typescript-5.8.2.tgz error (ERR_PNPM_FETCH_503). Will retry in 10 seconds. 2 retries left.  WARN  GET http://10.0.0.28:4873/@typescript-eslint/parser/-/parser-8.28.0.tgz error (ERR_PNPM_FETCH_503). Will retry in 10 seconds. 2 retries left.  WARN  GET http://10.0.0.28:4873/eslint-config-prettier/-/eslint-config-prettier-10.1.1.tgz error (ERR_PNPM_FETCH_503). Will retry in 10 seconds. 2 retries left.  WARN  GET http://10.0.0.28:4873/eslint-config-turbo/-/eslint-config-turbo-2.4.4.tgz error (ERR_PNPM_FETCH_503). Will retry in 10 seconds. 2 retries left.  WARN  GET http://10.0.0.28:4873/turbo/-/turbo-2.4.4.tgz error (ERR_PNPM_FETCH_503). Will retry in 10 seconds. 2 retries left.  WARN  GET http://10.0.0.28:4873/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.28.0.tgz error (ERR_PNPM_FETCH_503). Will retry in 10 seconds. 2 retries left.  WARN  GET http://10.0.0.28:4873/prettier/-/prettier-3.5.3.tgz error (ERR_PNPM_FETCH_503). Will retry in 10 seconds. 2 retries left.  WARN  GET http://10.0.0.28:4873/turbo error (503). Will retry in 1 minute. 1 retries left.  WARN  GET http://10.0.0.28:4873/eslint/-/eslint-9.23.0.tgz error (ERR_PNPM_FETCH_503). Will retry in 1 minute. 1 retries left.  WARN  GET http://10.0.0.28:4873/@vercel/style-guide/-/style-guide-6.0.0.tgz error (ERR_PNPM_FETCH_503). Will retry in 1 minute. 1 retries left.  WARN  GET http://10.0.0.28:4873/eslint-plugin-only-warn/-/eslint-plugin-only-warn-1.1.0.tgz error (ERR_PNPM_FETCH_503). Will retry in 1 minute. 1 retries left.  WARN  GET http://10.0.0.28:4873/typescript/-/typescript-5.8.2.tgz error (ERR_PNPM_FETCH_503). Will retry in 1 minute. 1 retries left.  WARN  GET http://10.0.0.28:4873/@typescript-eslint/parser/-/parser-8.28.0.tgz error (ERR_PNPM_FETCH_503). Will retry in 1 minute. 1 retries left.  WARN  GET http://10.0.0.28:4873/eslint-config-prettier/-/eslint-config-prettier-10.1.1.tgz error (ERR_PNPM_FETCH_503). Will retry in 1 minute. 1 retries left.  WARN  GET http://10.0.0.28:4873/eslint-config-turbo/-/eslint-config-turbo-2.4.4.tgz error (ERR_PNPM_FETCH_503). Will retry in 1 minute. 1 retries left.  WARN  GET http://10.0.0.28:4873/turbo/-/turbo-2.4.4.tgz error (ERR_PNPM_FETCH_503). Will retry in 1 minute. 1 retries left.  WARN  GET http://10.0.0.28:4873/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.28.0.tgz error (ERR_PNPM_FETCH_503). Will retry in 1 minute. 1 retries left.  WARN  GET http://10.0.0.28:4873/prettier/-/prettier-3.5.3.tgz error (ERR_PNPM_FETCH_503). Will retry in 1 minute. 1 retries left. /tmp/eslint/packages/eslint-config:  ERR_PNPM_FETCH_503  GET http://10.0.0.28:4873/eslint-plugin-only-warn/-/eslint-plugin-only-warn-1.1.0.tgz: Service Unavailable - 503

This error happened while installing a direct dependency of /tmp/eslint/packages/eslint-config

✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

🪧 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

coderabbitai[bot] avatar Apr 06 '25 18:04 coderabbitai[bot]

would take a look at how we do this in other places in the codebase to keep consistency. eg:

  • apps/web/hooks/useTableKeyboardNavigation.ts
  • apps/web/app/(app)/reply-zero/ReplyTrackerEmails.tsx

elie222 avatar Apr 06 '25 19:04 elie222

I made the required changes and changed the implementation same as it is been done in other places

Saksham1387 avatar Apr 06 '25 20:04 Saksham1387