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

style: add wordpress loading #1605

Merged
merged 1 commit into from
Oct 24, 2024
Merged

style: add wordpress loading #1605

merged 1 commit into from
Oct 24, 2024

Conversation

Nick-1979
Copy link
Member

@Nick-1979 Nick-1979 commented Oct 23, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced Progress component with new layout options and a 'wordpress' spinner type.
    • Improved loading indicators in TransactionHistory and HistoryModal components, replacing text with a visual Progress component for better user feedback.
  • Bug Fixes

    • Adjusted rendering logic to ensure loading indicators are displayed correctly based on transaction availability.

@Nick-1979 Nick-1979 requested a review from AMIRKHANEF October 23, 2024 09:39
Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

Walkthrough

The pull request introduces changes to the Progress component in Progress.tsx, enhancing its configurability by adding new optional properties such as direction, titlePaddingTop, and titlePaddingLeft. The type property is also updated to include 'wordpress'. Additionally, the TransactionHistory and HistoryModal components are modified to replace a static loading message with the new Progress component, improving visual feedback during loading states.

Changes

File Path Change Summary
packages/extension-polkagate/src/components/Progress.tsx Updated Props interface to include direction, titlePaddingTop, and titlePaddingLeft. Expanded type to include 'wordpress'. Adjusted Progress function parameters and rendering logic to utilize new properties.
packages/extension-polkagate/src/popup/history/index.tsx Replaced static loading message with Progress component configured with new props for loading indication.
packages/extension-polkagate/src/popup/history/modal/HistoryModal.tsx Updated loading indicator from text to Progress component with enhanced visual feedback during loading.

Possibly related PRs

  • style: add box shadow to the history items #1542: The changes in TransactionHistory and HistoryModal components involve the use of the Progress component, which is directly related to the modifications made in the main PR regarding the Progress component's props and rendering logic.
  • fix: history intersection loader issue #1598: The updates to the TransactionHistory and HistoryModal components include structural changes that enhance the loading mechanism, which aligns with the new features introduced in the Progress component in the main PR.

Suggested reviewers

  • AMIRKHANEF

Poem

In a world where progress flows,
A rabbit hops where the loading goes.
With padding and direction anew,
Our spinner twirls, bright and true.
Through columns and rows, we leap and play,
Making loading brightens the day! 🐇✨


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

@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: 2

🧹 Outside diff range and nitpick comments (4)
packages/extension-polkagate/src/components/Progress.tsx (2)

40-45: Consider adding aria-label for accessibility.

The implementation looks good, but consider adding accessibility attributes for screen readers.

 {type === 'wordpress' &&
   <Wordpress
     color={theme.palette.primary.main}
     size={size}
+    aria-label="Loading"
   />
 }

Line range hint 21-78: Consider splitting spinner implementations for better maintainability.

The component currently handles multiple spinner types with different configurations. Consider extracting each spinner type into its own component for better maintainability and type safety.

Example structure:

// CircleSpinner.tsx, WordpressSpinner.tsx, etc.
const CircleSpinner = ({ size, color }: CircleSpinnerProps) => (
  <Circle size={size} color={color} ... />
);

// Progress.tsx
const spinnerComponents = {
  circle: CircleSpinner,
  wordpress: WordpressSpinner,
  // ...
};

function Progress({ type = 'circle', ...props }: Props) {
  const SpinnerComponent = spinnerComponents[type];
  return (
    <Grid ...>
      <SpinnerComponent {...props} />
      {/* title rendering */}
    </Grid>
  );
}
packages/extension-polkagate/src/popup/history/index.tsx (1)

81-89: LGTM! Consider adding aria-label for accessibility.

The replacement of static text with the Progress component improves the loading state visualization. The configuration with horizontal layout and padding adjustments provides a clean inline loading experience.

Consider adding an aria-label to improve accessibility:

  <Progress
    direction='row'
    pt='5px'
    size={15}
    title={t('Loading...')}
    titlePaddingLeft={5}
    titlePaddingTop={0}
    type='wordpress'
+   aria-label={t('Loading more transactions')}
  />
packages/extension-polkagate/src/popup/history/modal/HistoryModal.tsx (1)

88-96: The Progress component implementation looks good, with some enhancement opportunities.

The loading indicator implementation is functionally correct and aligns with the PR objective of adding WordPress-style loading. However, consider these improvements for better UX:

Consider these enhancements:

 <Progress
   direction='row'
   pt='5px'
-  size={15}
+  size={20}
   title={t('Loading...')}
   titlePaddingLeft={5}
   titlePaddingTop={0}
   type='wordpress'
 />
  1. Increase the size slightly for better visibility
  2. Consider using a more descriptive loading message like "Loading more transactions..."
  3. Consider extracting the padding values to theme constants if they're used elsewhere
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ada7f21 and e43344a.

📒 Files selected for processing (3)
  • packages/extension-polkagate/src/components/Progress.tsx (3 hunks)
  • packages/extension-polkagate/src/popup/history/index.tsx (1 hunks)
  • packages/extension-polkagate/src/popup/history/modal/HistoryModal.tsx (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
packages/extension-polkagate/src/components/Progress.tsx (2)

10-18: LGTM! Well-structured interface updates.

The new props are properly typed and provide good flexibility for layout customization.


21-21: LGTM! Good default values maintaining backward compatibility.

The default values are well-chosen and ensure existing usage won't break.

@Nick-1979 Nick-1979 merged commit 9d8d0ec into main Oct 24, 2024
8 checks passed
@Nick-1979 Nick-1979 deleted the addWordpressLoading branch October 24, 2024 12:52
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.

1 participant