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(suite): restructure SettingsSection to properly display explanato… #16957

Merged
merged 1 commit into from
Feb 13, 2025

Conversation

vojtatranta
Copy link
Contributor

@vojtatranta vojtatranta commented Feb 12, 2025

…ry tooltips
TODO:

  • Level the tooltip icon with the rest of the text
  • test out properly that nothing else in the settings is broken SettingsSection is used just in settings

Description

Related Issue

Resolve #16610

Screenshots:

BRF
406865411-609c1028-bc8c-4121-935b-e3dc6b5b4603

AFTR
Screenshot 2025-02-12 at 2 22 28 PM

@jvaclavik

This comment was marked as outdated.

@vojtatranta vojtatranta force-pushed the 16610-fix-text-breaking-coins branch from c770f64 to 528e0e6 Compare February 12, 2025 13:21
@vojtatranta
Copy link
Contributor Author

QA instruct: please, test out other languages / windows / all of the other settings sections if the styling is correct and texts are readable and tooltips are displayed properly with correct texts, thanks

@@ -44,6 +44,7 @@ const Container = styled.div<ContainerProps>`

export type InfoItemProps = AllowedFrameProps &
AllowedTextProps & {
allowTextWrap?: boolean;
Copy link
Contributor

@jvaclavik jvaclavik Feb 12, 2025

Choose a reason for hiding this comment

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

What about do it with textProps using ellipsisLineCount? It's the same principle like frameProps

Check it here: packages/components/src/components/typography/utils.tsx

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good idea

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The it woul be liie ellipsisLineCOunt={0}, right?

Copy link
Contributor

Choose a reason for hiding this comment

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

Why 0? I think it's correct this way: ellipsisLineCount ?? 1

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As we discussed: you need to pass then to this compoennt ellipsisLineCount={0} to disable line breaking (the inner comopnent has check ellipsisLineCount > 0 to enable text overflow and ellipsis.

packages/components/src/components/Tooltip/Tooltip.tsx Outdated Show resolved Hide resolved
@vojtatranta vojtatranta force-pushed the 16610-fix-text-breaking-coins branch from 528e0e6 to 4beba2e Compare February 12, 2025 14:04
Copy link
Contributor

@jvaclavik jvaclavik left a comment

Choose a reason for hiding this comment

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

Magnifigue!

@bosomt
Copy link
Contributor

bosomt commented Feb 13, 2025

QA OK

Screen.Recording.2025-02-13.at.09.53.53.mov

Info:

  • Suite version: web 25.3.0 (8eddce5)
  • Browser: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36
  • OS: MacIntel
  • Screen: 1470x956
  • Device: Trezor T1B1 1.13.0 regular (revision null)
  • Transport: WebUsbTransport

@vojtatranta vojtatranta marked this pull request as ready for review February 13, 2025 09:45
@vojtatranta vojtatranta requested a review from a team as a code owner February 13, 2025 09:45
@vojtatranta vojtatranta force-pushed the 16610-fix-text-breaking-coins branch from 4beba2e to e2ece74 Compare February 13, 2025 09:45
Copy link

coderabbitai bot commented Feb 13, 2025

Walkthrough

This pull request implements modifications to three sections of the codebase. In the InfoItem component, an extra property (ellipsisLineCount) is added to the allowed text props and integrated with the Text component’s ellipsis configuration, allowing for more configurable text overflow handling. The SettingsSection component now accepts an optional tooltipText property, which is conditionally rendered alongside the title, utilizing a Box and Tooltip component. Additionally, the ellipsisLineCount for the InfoItem within SettingsSection is set to 0, indicating no text truncation. The SettingsCoins view has been updated to align with the revised SettingsSection API by replacing the previous Tooltip wrapper with direct assignment of tooltip content via the new tooltipText prop, simplifying the tooltip handling for testnet and unsupported coins sections.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9007adf and 58057ef.

📒 Files selected for processing (3)
  • packages/components/src/components/InfoItem/InfoItem.tsx (3 hunks)
  • packages/suite/src/components/settings/SettingsSection.tsx (1 hunks)
  • packages/suite/src/views/settings/SettingsCoins/SettingsCoins.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • packages/suite/src/views/settings/SettingsCoins/SettingsCoins.tsx
  • packages/suite/src/components/settings/SettingsSection.tsx
  • packages/components/src/components/InfoItem/InfoItem.tsx
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: run-desktop-tests (@group=wallet, trezor-user-env-unix bitcoin-regtest)
  • GitHub Check: run-desktop-tests (@group=other, trezor-user-env-unix)
  • GitHub Check: run-desktop-tests (@group=settings, trezor-user-env-unix bitcoin-regtest)
  • GitHub Check: run-desktop-tests (@group=device-management, trezor-user-env-unix)
  • GitHub Check: run-desktop-tests (@group=suite, trezor-user-env-unix)
  • GitHub Check: Setup and Cache Dependencies
  • GitHub Check: build-web
  • GitHub Check: Analyze with CodeQL (javascript)
  • GitHub Check: build-web

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

@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

🧹 Nitpick comments (2)
packages/suite/src/components/settings/SettingsSection.tsx (1)

33-51: Consider extracting tooltip rendering to a separate component.

The tooltip rendering logic could be moved to a dedicated component to improve maintainability and reusability.

+const TooltipIcon = ({ content }: { content: ReactNode }) => (
+    <Box
+        as="span"
+        position={{
+            type: 'relative',
+            top: 2,
+            left: 5,
+        }}
+    >
+        <Tooltip isInline content={content}>
+            <Icon name="question" size="medium" />
+        </Tooltip>
+    </Box>
+);

 export const SettingsSection = ({ title, icon, children, tooltipText }: SettingsSectionProps) => {
     // ...
     label={
         <>
             {title}
-            {tooltipText && (
-                <Box
-                    as="span"
-                    position={{
-                        type: 'relative',
-                        top: 2,
-                        left: 5,
-                    }}
-                >
-                    <Tooltip isInline content={tooltipText}>
-                        <Icon name="question" size="medium" />
-                    </Tooltip>
-                </Box>
-            )}
+            {tooltipText && <TooltipIcon content={tooltipText} />}
         </>
     }
     // ...
packages/components/src/components/InfoItem/InfoItem.tsx (1)

50-50: Consider documenting the allowTextWrap prop.

The allowTextWrap prop lacks documentation explaining its purpose and usage.

 export type InfoItemProps = AllowedFrameProps &
     AllowedTextProps & {
+        /** Controls whether text should wrap to multiple lines */
         allowTextWrap?: boolean;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4687ef6 and e2ece74.

📒 Files selected for processing (3)
  • packages/components/src/components/InfoItem/InfoItem.tsx (4 hunks)
  • packages/suite/src/components/settings/SettingsSection.tsx (1 hunks)
  • packages/suite/src/views/settings/SettingsCoins/SettingsCoins.tsx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: run-desktop-tests (@group=wallet, trezor-user-env-unix bitcoin-regtest)
  • GitHub Check: run-desktop-tests (@group=other, trezor-user-env-unix)
  • GitHub Check: run-desktop-tests (@group=settings, trezor-user-env-unix bitcoin-regtest)
  • GitHub Check: run-desktop-tests (@group=device-management, trezor-user-env-unix)
  • GitHub Check: Setup and Cache Dependencies
  • GitHub Check: build-web
  • GitHub Check: build-web
  • GitHub Check: run-desktop-tests (@group=suite, trezor-user-env-unix)
  • GitHub Check: Analyze with CodeQL (javascript)
🔇 Additional comments (4)
packages/suite/src/components/settings/SettingsSection.tsx (1)

21-21: LGTM! New tooltipText prop added.

The addition of the optional tooltipText prop enhances the component's flexibility for displaying explanatory tooltips.

packages/components/src/components/InfoItem/InfoItem.tsx (2)

26-29: LGTM! Added ellipsisLineCount to allowed text props.

The addition of ellipsisLineCount to allowedInfoItemTextProps enables better control over text truncation.


102-102: LGTM! Default ellipsisLineCount implementation.

The nullish coalescing operator provides a sensible default of 1 while allowing explicit override.

packages/suite/src/views/settings/SettingsCoins/SettingsCoins.tsx (1)

130-144: LGTM! Consistent usage of tooltipText prop.

The implementation correctly uses the new tooltipText prop across all SettingsSection components, improving code consistency and readability.

@vojtatranta vojtatranta force-pushed the 16610-fix-text-breaking-coins branch 2 times, most recently from 7e9ba2d to 9007adf Compare February 13, 2025 14:22
@vojtatranta vojtatranta force-pushed the 16610-fix-text-breaking-coins branch from 9007adf to 58057ef Compare February 13, 2025 15:11
@jvaclavik jvaclavik merged commit 5623df7 into develop Feb 13, 2025
28 of 29 checks passed
@jvaclavik jvaclavik deleted the 16610-fix-text-breaking-coins branch February 13, 2025 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🤝 Needs QA
Development

Successfully merging this pull request may close these issues.

Missing text in Supported on newer Trezor section
3 participants