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.

Sign up for GitHub

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

Jump to bottom

feat: Added support to sidebar #2119

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

feat: Added support to sidebar #2119

wants to merge 10 commits into from
+186 −3

Conversation

harshsbhat
Copy link
Contributor

@harshsbhat harshsbhat commented Sep 20, 2024 •
edited by coderabbitai bot
Loading

What does this PR do?

Fixes #2095

Adds the support options to side bar

image

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features
    • Introduced a Discord navigation item in the sidebar for easy access.
    • Added a Feedback component for users to report issues directly from the dashboard.
  • Enhancements
    • Expanded the types of icons that can be used in the sidebar navigation.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Sep 20, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 56467f6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel Vercel
Copy link

vercel bot commented Sep 20, 2024

@harshsbhat is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 20, 2024 •
edited
Loading

Walkthrough

Walkthrough

The changes introduce a new DiscordIcon component and modify the NavItem type to support a broader range of icons. A "Discord" navigation item is added to the sidebar, along with a new Feedback component for user feedback. Additionally, a new file for the feedback dialog component is created, which includes form validation and submission handling for reporting issues within the dashboard application.

Changes

Files Change Summary
apps/dashboard/app/(app)/desktop-sidebar.tsx Added DiscordIcon component, updated NavItem type to accept React.ElementType, added "Discord" navigation item, and included <Feedback /> component in the sidebar.
apps/dashboard/components/dashboard/feedback-component.tsx Introduced a feedback dialog component with form handling, validation using Zod, and TRPC mutation for submitting feedback.

Assessment against linked issues

Objective Addressed Explanation
Add Discord + Support to the left navigation (#2095) ✅
Improve visibility of support features (#2095) ✅

Possibly related PRs

Suggested reviewers

  • mcstepp
  • perkinsjr
  • chronark

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>, 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.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 20, 2024 •
edited
Loading

Thank you for following the naming conventions for pull request titles! 🙏

coderabbitai[bot]
coderabbitai bot reviewed Sep 20, 2024
View reviewed changes
Copy link
Contributor

@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 (3)
apps/dashboard/components/dashboard/feedback-component.tsx (3)

1-22: Looks good! Consider grouping the imports for better readability.

The imports are correctly used and cover all the necessary dependencies. However, consider grouping them based on their origin (e.g., separate groups for @/components, @/lib, external libraries) to improve readability.

23-53: The component logic is well-structured. Consider adding error handling for the trpc mutation.

The component manages the dialog state and form handling correctly. The usage of react-hook-form and zod for form validation is a good practice.

However, consider adding error handling for the trpc mutation to handle potential network or server errors gracefully. You can use the onError callback of the useMutation hook to display an error message to the user.

55-157: The JSX is properly structured. Consider extracting the form fields into separate components.

The JSX correctly renders the feedback dialog and form. The usage of custom UI components enhances the consistency and reusability of the code.

However, the form fields (issueType, severity, message) are quite verbose and contain similar logic. Consider extracting them into separate components (e.g., IssueTypeField, SeverityField, MessageField) to improve maintainability and reduce duplication.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2d99e07 and acba9f7.

Files selected for processing (2)
  • apps/dashboard/app/(app)/desktop-sidebar.tsx (5 hunks)
  • apps/dashboard/components/dashboard/feedback-component.tsx (1 hunks)
Additional comments not posted (5)
apps/dashboard/app/(app)/desktop-sidebar.tsx (5)

2-2: LGTM!

The import statement for the Feedback component is correctly added.

41-41: LGTM!

The modification to the icon property in the NavItem type is a good change. It allows using custom React components as icons, providing more flexibility in the sidebar navigation.

50-65: LGTM!

The DiscordIcon component is correctly implemented as a functional component. The SVG code for the Discord logo is properly included, and the component can be used in other parts of the codebase.

148-153: LGTM!

The "Discord" navigation item is correctly added to the resourcesNavigation array. It uses the DiscordIcon component as the icon and links to the external Discord URL. The external property is properly set to true to open the link in a new tab.

202-204: LGTM!

The Feedback component is correctly included as a list item within the "Resources" section of the sidebar. This provides users with convenient access to the feedback functionality.

@harshsbhat
Copy link
Contributor Author

I have created a new component for the sidebar because it was not allowing me to use CommandItem outside the Commands. Or even use the div in CommandGroup

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai coderabbitai left review comments

@perkinsjr perkinsjr Awaiting requested review from perkinsjr perkinsjr is a code owner

@chronark chronark Awaiting requested review from chronark chronark is a code owner

@mcstepp mcstepp Awaiting requested review from mcstepp mcstepp is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add Discord + Support to the left navigation
1 participant
@harshsbhat