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

fix: make keys UI responsive to mobile devices #2145

Merged
merged 1 commit into from
Oct 2, 2024

Conversation

geraldmaboshe
Copy link
Contributor

@geraldmaboshe geraldmaboshe commented Oct 1, 2024

What does this PR do?

Fixes #2142

This PR fixes the broken Keys UI on mobile devices by making the UI more responsive on smaller devices.

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

How should this be tested?

  • Test A
  • Test B

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
Screenshot 2024-10-02 at 1 53 43 AM

Summary by CodeRabbit

  • New Features
    • Enhanced the Keys component with responsive design features for improved layout on different screen sizes.
    • Added spacing between grid items for better visual organization.

Copy link

changeset-bot bot commented Oct 1, 2024

⚠️ No Changeset found

Latest commit: 3ecb62c

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

Copy link

vercel bot commented Oct 1, 2024

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

A member of the Team first needs to authorize it.

@CLAassistant
Copy link

CLAassistant commented Oct 1, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

coderabbitai bot commented Oct 1, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes made in the pull request focus on the Keys component within the keys.tsx file. The primary modification involves updating the class attribute of the Link component to enhance responsiveness on mobile devices. This includes the addition of a responsive grid class and a gap class for improved spacing between grid items. There are no other functional or structural changes to the component's logic or control flow.

Changes

File Path Change Summary
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/keys.tsx Updated class attribute in Link component to include responsive design and spacing adjustments.

Assessment against linked issues

Objective Addressed Explanation
UI should not break on mobile (#2142)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fb152be and 3ecb62c.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/keys.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/keys.tsx

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.

Copy link
Contributor

github-actions bot commented Oct 1, 2024

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

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 (1)
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/keys.tsx (1)

Line range hint 1-146: Consider additional responsive design improvements

While the change made is a great start in addressing the mobile responsiveness issue, consider the following suggestions to further enhance the mobile user experience:

  1. Key item layout: The content within each key item (name, ID, environment, permissions, roles) might benefit from a more stacked layout on mobile. Consider using flexbox with flex-direction: column for smaller screens.

  2. Badges and buttons: The badges for environment, permissions, and roles, as well as the chevron button, might need adjustments for smaller screens. Consider reducing their size or stacking them vertically on mobile.

  3. Empty state placeholder: Ensure that the empty state layout (including the buttons) is responsive and properly aligned on mobile devices.

Here's a sample of how you might implement some of these changes:

<Link
  href={`/apis/${apiId}/keys/${k.keyAuthId}/${k.id}`}
  key={k.id}
  className="grid items-center sm:grid-cols-12 px-4 py-2 duration-250 hover:bg-background-subtle gap-2"
>
  <div className="flex flex-col items-start col-span-6 sm:col-span-4">
    <span className="text-sm text-content">{k.name}</span>
    <pre className="text-xs text-content-subtle">{k.id}</pre>
  </div>

  <div className="flex flex-wrap items-center col-span-6 sm:col-span-8 gap-2">
    {k.environment && <Badge variant="secondary">env: {k.environment}</Badge>}
    <Badge variant="secondary">
      {Intl.NumberFormat(undefined, { notation: "compact" }).format(k.permissions)} Permission
      {k.permissions !== 1 ? "s" : ""}
    </Badge>
    <Badge variant="secondary">
      {Intl.NumberFormat(undefined, { notation: "compact" }).format(k.roles)} Role
      {k.roles !== 1 ? "s" : ""}
    </Badge>
    <Button variant="ghost" className="ml-auto">
      <ChevronRight className="w-4 h-4" />
    </Button>
  </div>
</Link>

These additional changes will help ensure that the Keys UI is fully responsive and provides an optimal experience across all device sizes.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 889e073 and fb152be.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/keys.tsx (1 hunks)
🔇 Additional comments (1)
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/keys.tsx (1)

101-101: Excellent responsive design improvement!

This change effectively addresses the mobile responsiveness issue mentioned in the PR objectives:

  1. By changing grid-cols-12 to sm:grid-cols-12, the layout now adapts to smaller screens. On mobile devices (smaller than the 'sm' breakpoint), the grid will use a single column layout, preventing overflow issues.
  2. The addition of gap-2 introduces a small gap between grid items, improving spacing and readability, which is particularly beneficial on mobile devices where space is limited.

These modifications will significantly enhance the user experience on mobile devices while maintaining the existing layout for larger screens.

@perkinsjr perkinsjr self-assigned this Oct 2, 2024
Copy link

vercel bot commented Oct 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 6:44pm
planetfall ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 6:44pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 6:44pm
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 6:44pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 6:44pm

@perkinsjr
Copy link
Collaborator

Hey @geraldmaboshe can you sign the CLA, once done we should be good with this change. Thanks 🙇

image

@geraldmaboshe
Copy link
Contributor Author

Thanks @perkinsjr. I didn't realize my git config wasn't set up. It should be fixed now

@perkinsjr perkinsjr added this pull request to the merge queue Oct 2, 2024
Merged via the queue into unkeyed:main with commit 2653729 Oct 2, 2024
25 checks passed
harshsbhat pushed a commit to harshsbhat/unkey that referenced this pull request Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Keys UI breaks on mobile
3 participants