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: truncate long permission names with ellipses #2071

Merged
merged 4 commits into from
Sep 9, 2024

Conversation

DeepaPrasanna
Copy link
Contributor

@DeepaPrasanna DeepaPrasanna commented Sep 7, 2024

What does this PR do?

Truncates long permission names with ellipses so that elements are not pushed off the screen.

Before:
Screenshot 2024-09-07 212845

As the permission name in the breadcrumbs seemed a bit weird, I have truncated the text with ellipses there too. Hope that's fine!

After:

Screenshot 2024-09-07 223041

Tooltip provided for full length name

Screenshot 2024-09-07 223109

Fixes #1976

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?

  • Create a very long permission name. Now, it should not push the elements off the screen.

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

    • Enhanced the RolesPage component with a tooltip feature for permission names, improving interactivity and user experience.
    • Updated the BreadcrumbPage component with new styling for better visual presentation and usability.
  • Bug Fixes

    • Improved alignment and spacing of elements on the RolesPage for a cleaner layout.

Copy link

changeset-bot bot commented Sep 7, 2024

⚠️ No Changeset found

Latest commit: 1d4fa05

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

@DeepaPrasanna 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 7, 2024

Walkthrough

Walkthrough

The changes involve enhancements to the BreadcrumbPage and RolesPage components within the application. The BreadcrumbPage now includes additional CSS classes for improved text truncation, while the RolesPage has integrated a tooltip feature around permission names to prevent layout issues caused by long names, ensuring better usability and visual alignment.

Changes

Files Change Summary
apps/dashboard/app/(app)/@breadcrumb/authorization/permissions/[permissionId]/page.tsx Added CSS classes truncate and w-96 to BreadcrumbPage for text truncation.
apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx Wrapped permission name and copy button in a Tooltip component for improved interaction.

Assessment against linked issues

Objective Addressed Explanation
Long permission name makes settings hard to navigate (Issue #1976)

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 7, 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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d0a57fd and dcac204.

Files selected for processing (2)
  • apps/dashboard/app/(app)/@breadcrumb/authorization/permissions/[permissionId]/page.tsx (1 hunks)
  • apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx (2 hunks)
Files skipped from review due to trivial changes (1)
  • apps/dashboard/app/(app)/@breadcrumb/authorization/permissions/[permissionId]/page.tsx
Additional comments not posted (2)
apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx (2)

1-1: Imports are appropriate for the new functionality.

The imports of Tooltip, TooltipContent, and TooltipTrigger are correctly aligned with the PR's objectives to handle long permission names with a tooltip.


Line range hint 183-197: Subcomponent Metric is well-implemented.

The Metric subcomponent is straightforward and effectively displays various metrics about the permission. It is not directly affected by the PR changes but continues to function as expected within the context of the page.

Comment on lines 83 to 95
className="w-40 font-mono font-medium ph-no-capture"
>
{permission.name}
<CopyButton value={permission.name} />
<Tooltip>
<TooltipTrigger className="flex items-center justify-between gap-2 truncate">
<span className="truncate">{permission.name}</span>
<div>
<CopyButton value={permission.name} />
</div>
</TooltipTrigger>
<TooltipContent>
<span className="text-xs font-medium">{permission.name}</span>
</TooltipContent>
</Tooltip>
Copy link
Contributor

Choose a reason for hiding this comment

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

Tooltip implementation enhances usability.

The integration of the Tooltip component within the Badge for the permission name is well-implemented. It addresses the issue of long permission names by truncating them and providing a full view on hover, which aligns with the PR objectives.

However, consider adding a conditional rendering for the tooltip to only appear when the permission name exceeds a certain length. This would prevent unnecessary tooltip triggers for shorter names.

Consider adding a conditional rendering for the tooltip:

+ const shouldShowTooltip = permission.name.length > 20;
+
  <Tooltip>
    <TooltipTrigger className="flex items-center justify-between gap-2 truncate">
      <span className="truncate">{permission.name}</span>
      <div>
        <CopyButton value={permission.name} />
      </div>
    </TooltipTrigger>
+   {shouldShowTooltip && (
    <TooltipContent>
      <span className="text-xs font-medium">{permission.name}</span>
    </TooltipContent>
+   )}
  </Tooltip>

Committable suggestion was skipped due to low confidence.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dcac204 and fcd60d6.

Files selected for processing (1)
  • apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx

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, codebase verification and nitpick comments (1)
apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx (1)

84-98: Tooltip Implementation for Long Permission Names

The integration of the Tooltip component within the Badge for the permission name is well-implemented. It addresses the issue of long permission names by truncating them and providing a full view on hover, which aligns with the PR objectives.

Suggestion:
Consider using a more descriptive class name for the tooltip trigger to enhance code readability and maintainability.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fcd60d6 and 1d4fa05.

Files selected for processing (1)
  • apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx (3 hunks)
Additional comments not posted (1)
apps/dashboard/app/(app)/authorization/permissions/[permissionId]/page.tsx (1)

73-73: Conditional Tooltip Rendering Implemented

The implementation of conditional rendering for the tooltip based on the length of the permission name is a good practice. It ensures that tooltips are only used when necessary, which enhances performance and user experience.

Copy link

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

Copy link
Collaborator

@perkinsjr perkinsjr left a comment

Choose a reason for hiding this comment

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

LGTM Thanks

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.

Long permission name makes settings hard to navigate as it pushes elements off screen.
2 participants