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

displaying full names on hover for long names only #8972

Conversation

SwanandBhuskute
Copy link
Contributor

@SwanandBhuskute SwanandBhuskute commented Oct 30, 2024

Proposed Changes

  • Fixes Lengthy asset name is not properly handled in asset list page #7787
  • Displaying asset names for long names only
  • asset.name > 18 seems logical considering w-48 remains constant, but if we change w-48 to some other value, we can increase 18 to something else, but don't think w-48 will change, even if it does, we can adjust 18 to some sensible mid-number like 15-16

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

  • New Features

    • Introduced a tooltip for asset names that exceed 20 characters, providing full visibility without cluttering the interface.
  • Bug Fixes

    • Improved error handling for QR code processing, ensuring consistent management of the loading state and clarity in error notifications.

@SwanandBhuskute SwanandBhuskute requested a review from a team as a code owner October 30, 2024 17:53
Copy link

netlify bot commented Oct 30, 2024

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 137096a
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/672a12ceb7a079000825a3ef
😎 Deploy Preview https://deploy-preview-8972--care-ohc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@gigincg
Copy link
Member

gigincg commented Nov 4, 2024

@SwanandBhuskute Can you add links to example assets where the feature can be seen in action? Also attach Before and After Screenshots

@SwanandBhuskute
Copy link
Contributor Author

@SwanandBhuskute Can you add links to example assets where the feature can be seen in action? Also attach Before and After Screenshots

https://care.ohc.network/assets
the feature can be seen into action on this route
currently this is how it works on localhost

Before hovering:
image

After hovering
image

optional working video

Recording.2024-11-04.195846.mp4

Copy link
Member

@rithviknishad rithviknishad left a comment

Choose a reason for hiding this comment

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

  1. let's not use css when tailwind classes can achieve the same.
  2. have a look at how tooltip's shown in other places in care. We have a custom CSS class defined to show tooltips. Utilise those classes instead.

.tooltip .tooltip-text {

@SwanandBhuskute
Copy link
Contributor Author

Member

so I should do changes in CAREUI.css file?

@rithviknishad
Copy link
Member

rithviknishad commented Nov 4, 2024

so I should do changes in CAREUI.css file?

No why? Just use those classes like how it's used in other places to show tooltips.

@SwanandBhuskute
Copy link
Contributor Author

SwanandBhuskute commented Nov 4, 2024

so I should do changes in CAREUI.css file?

No why? Just use those classes like how it's used in other places to show tooltips.

Using tooltip and tooltip-top classes
the hover doesn't position that good
image

so using tailwind only, to achieve same effect as earlier without extra style attribute inside

@rithviknishad
Copy link
Member

@SwanandBhuskute you can use it in conjuction with translate-* classes to control where it's positioned like how it's done in most other usages of the tooltip classes.

Copy link
Contributor

coderabbitai bot commented Nov 5, 2024

Walkthrough

The changes made in the AssetsList component enhance how lengthy asset names are displayed by introducing a tooltip feature. When asset names exceed 20 characters, a tooltip appears to show the full name, addressing previous truncation issues. Additionally, the error handling in the accessAssetIdFromQR function has been refined to ensure consistent management of the loading state. These modifications focus on improving user experience and error clarity without altering the core functionality of the component.

Changes

File Path Change Summary
src/components/Assets/AssetsList.tsx Updated rendering of asset names to include a tooltip for names exceeding 20 characters; refined error handling in accessAssetIdFromQR function.

Assessment against linked issues

Objective Addressed Explanation
Lengthy asset name is not properly handled in asset list page (#7787)
- Show full asset names based on screen size if space is available.
- Add a tooltip for truncated asset names to display the full name.

Poem

🐇 In the land of assets, where names can be long,
A tooltip now dances, where it once felt wrong.
Hover and see, the full name will gleam,
No more hidden secrets, just a smooth, clear dream!
With loading states tidy, we hop with delight,
In the world of our assets, everything's bright! 🌟


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.

@SwanandBhuskute
Copy link
Contributor Author

@SwanandBhuskute you can use it in conjuction with translate-* classes to control where it's positioned like how it's done in most other usages of the tooltip classes.

@rithviknishad i have done as you said, kindly review

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

🧹 Outside diff range and nitpick comments (1)
src/components/Assets/AssetsList.tsx (1)

Line range hint 89-142: Optimize error handling in QR code processing

The error handling can be improved by:

  1. Consolidating the loading state management
  2. Adding specific error types
  3. Improving error messages

Consider this refactor:

   const accessAssetIdFromQR = async (assetURL: string) => {
+    const resetLoadingState = () => {
+      setIsLoading(false);
+      setIsScannerActive(false);
+    };
+
     try {
       setIsLoading(true);
-      setIsScannerActive(false);
       if (!isValidURL(assetURL)) {
-        setIsLoading(false);
+        resetLoadingState();
         Notification.Error({
-          msg: t("invalid_asset_id_msg"),
+          msg: t("invalid_qr_url_format"),
         });
         return;
       }
       const params = parseQueryParams(assetURL);
       const assetId = params.asset || params.assetQR;

       if (assetId) {
         const { data } = await request(routes.listAssetQR, {
           pathParams: { qr_code_id: assetId },
         });
         if (!data) {
-          setIsLoading(false);
+          resetLoadingState();
           Notification.Error({
-            msg: t("invalid_asset_id_msg"),
+            msg: t("asset_qr_not_found"),
           });
           return;
         }
         const { data: assetData } = await request(routes.listAssets, {
           query: { qr_code_id: assetId, limit: 1 },
         });
         if (assetData?.results.length === 1) {
           navigate(
             `/facility/${assetData.results[0].location_object.facility?.id}/assets/${assetData.results[0].id}`,
           );
         } else {
-          setIsLoading(false);
+          resetLoadingState();
           Notification.Error({
             msg: t("asset_not_found_msg"),
           });
         }
       } else {
-        setIsLoading(false);
+        resetLoadingState();
         Notification.Error({
-          msg: t("invalid_asset_id_msg"),
+          msg: t("missing_asset_id_in_qr"),
         });
       }
-    } catch (err) {
+    } catch (err: unknown) {
+      resetLoadingState();
       Notification.Error({
-        msg: t("invalid_asset_id_msg"),
+        msg: err instanceof Error ? err.message : t("qr_processing_error"),
       });
-    } finally {
-      setIsLoading(false);
     }
   };
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a65d7ec and cb8aa84.

📒 Files selected for processing (1)
  • src/components/Assets/AssetsList.tsx (1 hunks)

src/components/Assets/AssetsList.tsx Outdated Show resolved Hide resolved
Copy link
Member

@rithviknishad rithviknishad left a comment

Choose a reason for hiding this comment

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

the tooltip classes already applies most of the classes required for you, skip repeating it.

src/components/Assets/AssetsList.tsx Outdated Show resolved Hide resolved
src/components/Assets/AssetsList.tsx Outdated Show resolved Hide resolved
@nihal467
Copy link
Member

nihal467 commented Nov 6, 2024

LGTM

@rithviknishad rithviknishad merged commit 4f775ad into ohcnetwork:develop Nov 6, 2024
19 checks passed
Copy link

github-actions bot commented Nov 6, 2024

@SwanandBhuskute Your efforts have helped advance digital healthcare and TeleICU systems. 🚀 Thank you for taking the time out to make CARE better. We hope you continue to innovate and contribute; your impact is immense! 🙌

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.

Lengthy asset name is not properly handled in asset list page
4 participants