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

Bug Fix: Improved full-width layout and text truncation to prevent overlap with button #2374

Merged
merged 5 commits into from
Oct 28, 2024

Conversation

adityaraj-09
Copy link
Contributor

@adityaraj-09 adityaraj-09 commented Oct 13, 2024

What does this PR do?

Added w-full to ensure the container takes the full width and added a max-w-[calc(100%-32px)] to the span containing permission.name to prevent it from overlapping with the button.

Fixes #2348

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?

Just go to Authorization/Permissions/ and then go to particular permission.

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
    • Improved layout and styling of the RolesPage component for better visual presentation of permissions.
    • Enhanced tooltip functionality for displaying permission names with a copy button.
    • Tooltip trigger area now occupies the full width of its container for better accessibility.

Copy link

changeset-bot bot commented Oct 13, 2024

⚠️ No Changeset found

Latest commit: 2b628c4

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 13, 2024

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

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 1 unresolved
✅ 5 resolved
Oct 24, 2024 1:25pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 24, 2024 1:25pm

@CLAassistant
Copy link

CLAassistant commented Oct 13, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

vercel bot commented Oct 13, 2024

@adityaraj-09 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 Oct 13, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request modifies the RolesPage component located in apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx. Key changes include the addition of a w-full class to the div wrapping the TooltipTrigger, ensuring full width occupancy. The previous w-full class was removed from the TooltipTrigger. Additionally, the span displaying permission.name now includes a max-w-[calc(100%-32px)] class for better layout management. The overall logic and control flow of the component remain unchanged.

Changes

File Change Summary
apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx Updated the layout of the TooltipTrigger and permission.name display in the RolesPage component.

Assessment against linked issues

Objective Addressed Explanation
The copy icon should remain on the right side of the permission name (2348)

Possibly related PRs

  • fix: truncate long permission names with ellipses #2071: This PR modifies the RolesPage component to enhance the user interface by integrating a tooltip feature around the permission name display, which is directly related to the changes made in the main PR regarding the TooltipTrigger and layout adjustments.
  • fix(dashboard): hydration warnings #2253: This PR also modifies the RolesPage component, specifically updating the TooltipTrigger to use the asChild prop, which is relevant to the changes in the main PR that involve layout enhancements around the tooltip functionality.

Suggested labels

Bug, 🕹️ oss.gg, :joystick: 150 points

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr

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 13, 2024

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.
Here is an example:

<type>[optional scope]: <description>
fix: I fixed something for Unkey

Details:

No release type found in pull request title "Bug Fix: Improved full-width layout and text truncation to prevent overlap with button". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

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)/authorization/permissions/[permissionId]/page.tsx (1)

88-93: Approved: Layout improvements effectively address the reported issue.

The changes successfully implement a full-width layout and prevent text overlap with the copy button. The use of w-full and max-w-[calc(100%-32px)] classes effectively manages the space distribution.

For improved readability, consider extracting the inline styles into a separate CSS class. This would make the JSX cleaner and easier to maintain. For example:

+ // Add this class to your CSS file
+ .permission-name-container {
+   @apply flex items-center justify-between gap-2 w-full truncate;
+ }
+ 
+ .permission-name {
+   @apply truncate max-w-[calc(100%-32px)];
+ }

- <div className="flex items-center justify-between gap-2 w-full truncate">
-   <span className="truncate max-w-[calc(100%-32px)]">{permission.name}</span>
+ <div className="permission-name-container">
+   <span className="permission-name">{permission.name}</span>
    <div>
      <CopyButton value={permission.name} />
    </div>
  </div>

This change would maintain the same functionality while improving code maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7972170 and a892d1f.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx (1 hunks)
🧰 Additional context used

@nil-frontend
Copy link

/assign

Copy link

oss-gg bot commented Oct 15, 2024

This issue is not part of oss.gg hackathon. Please pick a different one or start with a side quest

@chronark
Copy link
Collaborator

please sign the CLA and fix the pr title

@chronark chronark merged commit 26febb5 into unkeyed:main Oct 28, 2024
2 of 7 checks passed
Copy link

oss-gg bot commented Oct 28, 2024

Awarding adityaraj-09: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/adityaraj-09

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.

Copy Icon Misalignment for Short Permission Names
4 participants