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: Workspace Permissions overlaps with their descriptions on smaller windows #2127

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

Conversation

harshsbhat
Copy link
Contributor

@harshsbhat harshsbhat commented Sep 24, 2024

What does this PR do?

image

Fixes #2125

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

Summary by CodeRabbit

  • New Features

    • Updated the description text for the permission toggle to improve clarity.
  • Style

    • Adjusted the layout of the PermissionToggle component for better responsiveness across different screen sizes.
    • Enhanced the display of the description text for improved visual alignment.

Copy link

changeset-bot bot commented Sep 24, 2024

⚠️ No Changeset found

Latest commit: 1cc4c26

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 Sep 24, 2024

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

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Sep 24, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces modifications to the Client and PermissionToggle components in the client.tsx file. The changes include a simplification of the description text for the PermissionToggle and adjustments to the layout, specifically the width classes of div elements, to enhance responsiveness on smaller screens.

Changes

File Path Change Summary
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx Modified description text in PermissionToggle and adjusted layout classes for improved responsiveness.

Assessment against linked issues

Objective Addressed Explanation
Permission names should overflow or wrap to the next line (#[2125])

Possibly related PRs

Suggested reviewers

  • chronark
  • mcstepp
  • perkinsjr

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 83927fe and 1cc4c26.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/dashboard/app/(app)/settings/root-keys/new/client.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 Sep 24, 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)/settings/root-keys/new/client.tsx (1)

308-308: Improved responsive layout for permissions.

The modification to the width classes effectively addresses the PR's main objective of fixing the overlap issue on smaller windows. The responsive approach ensures that the layout works well across different screen sizes:

  • Wider layout (4/6) on smaller screens prevents overlap.
  • Added right margin (mr-2) provides better spacing.
  • Original width (1/3) is maintained for medium and larger screens.

This change should resolve the issue described in #2125.

Consider adding a small breakpoint-specific class for extra small screens if needed, e.g., xs:w-full. This would ensure optimal layout on very small devices. Example:

-      <div className="w-4/6 mr-2 md:w-1/3">
+      <div className="w-4/6 mr-2 md:w-1/3 xs:w-full">
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d9a71e8 and 54eecf9.

Files selected for processing (1)
  • apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (2 hunks)
Additional comments not posted (2)
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (2)

198-198: Improved description text clarity.

The modification in the description text enhances readability without changing the meaning. This change aligns well with the PR's objective of addressing visual issues, as it may help reduce text length and potential overlap in the UI.


Line range hint 1-329: Overall assessment: Changes effectively address the UI issue.

The modifications in this file successfully tackle the visual bug described in issue #2125. The combination of text simplification and responsive layout adjustments should prevent permission names from overlapping with their descriptions on smaller windows. The changes are well-implemented and align perfectly with the PR objectives.

Some additional points to consider:

  1. Test the changes on various screen sizes to ensure the layout behaves as expected.
  2. Consider adding unit or integration tests to prevent regression of this UI issue in the future.
  3. Update any relevant documentation or UI/UX guidelines to reflect these changes.

Copy link

vercel bot commented Sep 24, 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 Sep 27, 2024 7:25am
planetfall ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 27, 2024 7:25am
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 27, 2024 7:25am
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 27, 2024 7:25am
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 27, 2024 7:25am

@chronark
Copy link
Collaborator

CleanShot 2024-09-24 at 09 35 10@2x
it still seems to happen, I just tried your PR

@chronark chronark self-assigned this Sep 24, 2024
@harshsbhat
Copy link
Contributor Author

image
After recent changes.

@harshsbhat
Copy link
Contributor Author

CleanShot 2024-09-24 at 09 35 10@2x it still seems to happen, I just tried your PR

it was happening for just one permission. Breaking the permission name didn't look good either. w-full looks decent I have pushed those changes

@mcstepp
Copy link
Collaborator

mcstepp commented Sep 24, 2024

@chronark what do you think about having the permission description flow underneath the permission name at smaller screens?

@chronark
Copy link
Collaborator

@chronark what do you think about having the permission description flow underneath the permission name at smaller screens?

that would be nice @mcstepp

@harshsbhat
Copy link
Contributor Author

@chronark @mcstepp

image
this looks good, right? But in my opinion, lets just keep this for mobile (smaller screens). Doesn't look too good on PC as it leaves too much whitespace on right hand side.

image

@chronark
Copy link
Collaborator

chronark commented Sep 24, 2024

yes, only for small screens

also I think there's a max width or something we need to remove on small screens, there's plenty of space, yet we have a linebreak here
CleanShot 2024-09-24 at 16 12 03@2x

@harshsbhat
Copy link
Contributor Author

yes, I just quickly added flex-col to see how it looks. I will push in a few minutes

@harshsbhat
Copy link
Contributor Author

image

Latest changes @chronark

@chronark
Copy link
Collaborator

what if we align the text?

[ ] TITLE
    description

wdyt?

@harshsbhat harshsbhat closed this Sep 24, 2024
@harshsbhat harshsbhat reopened this Sep 24, 2024
@harshsbhat
Copy link
Contributor Author

@chronark

image

LGTM. wdyt? Should I push this?

Copy link
Collaborator

yes please

@harshsbhat
Copy link
Contributor Author

yes please

done

Copy link
Collaborator

@chronark chronark left a comment

Choose a reason for hiding this comment

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

This messes up the alignment of category descriptions

Before:
CleanShot 2024-09-26 at 13 30 16@2x

After:
CleanShot 2024-09-26 at 13 29 36@2x

Why did you remove the items-center?

@harshsbhat
Copy link
Contributor Author

This messes up the alignment of category descriptions

Before:
CleanShot 2024-09-26 at 13 30 16@2x

After:
CleanShot 2024-09-26 at 13 29 36@2x

Why did you remove the items-center?

I accidentally removed it and didn't realise it as the changes in ui were very minimal. I will do the changes and push asap

@harshsbhat
Copy link
Contributor Author

@chronark should work now

@chronark
Copy link
Collaborator

CleanShot 2024-09-26 at 19 20 28@2x
it's still misaligned

@harshsbhat
Copy link
Contributor Author

that's weird. I checked at least a few times.

@harshsbhat
Copy link
Contributor Author

It's probably because I was referring to the live app. Which also has this misalignment.
image

@harshsbhat
Copy link
Contributor Author

@chronark

image

this issue I should have solved in #2062. As we are using label={<span className="text-base font-bold">{category}</span>} for the Select all buttons which is causing the alignment issues.

@chronark
Copy link
Collaborator

It's probably because I was referring to the live app. Which also has this misalignment. image

wdym?

it's aligned in prod
CleanShot 2024-09-26 at 21 30 54@2x

@harshsbhat
Copy link
Contributor Author

The SS you shared is for smaller screens. I think this PR is ready for review.

BIGGER SCREENS:

image

SMALLER SCREENS:

image

@chronark
Copy link
Collaborator

Yes the previous screenshot was on a smaller screen, but it's also correctly aligned on large screens in prod
CleanShot 2024-09-27 at 09 19 22@2x

@chronark
Copy link
Collaborator

I never said this explicitely, but I mean center-aligned, the items-center you removed is very much needed

@harshsbhat
Copy link
Contributor Author

I never said this explicitely, but I mean center-aligned, the items-center you removed is very much needed

it's required for a PC ( it makes just a little difference)

@chronark
Copy link
Collaborator

I'm sorry, what's PC?

@harshsbhat
Copy link
Contributor Author

I'm sorry, what's PC?

ah, I meant longer screen ( PC screen ). My bad should have been more clear about it

2 similar comments
@harshsbhat
Copy link
Contributor Author

I'm sorry, what's PC?

ah, I meant longer screen ( PC screen ). My bad should have been more clear about it

@harshsbhat
Copy link
Contributor Author

I'm sorry, what's PC?

ah, I meant longer screen ( PC screen ). My bad should have been more clear about it

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.

[VISUAL/UI] Workspace Permissions overlaps with their descriptions on smaller windows
3 participants