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

feat: add reload button for portal #346

Merged
merged 1 commit into from
Oct 24, 2024
Merged

feat: add reload button for portal #346

merged 1 commit into from
Oct 24, 2024

Conversation

kshitij-k-osmosys
Copy link
Contributor

@kshitij-k-osmosys kshitij-k-osmosys commented Oct 24, 2024

Portal PR Checklist

Pre-requisites

  • I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
  • I have performed unit testing for the new feature added or updated to ensure the new features added are working as expected.
  • I have performed preliminary testing to ensure that any existing features are not impacted and any new features are working as expected as a whole.

PR Details

PR details have been updated as per the given format (see below)

  • PR title adheres to the format specified in guidelines (e.g., feat: add admin login page)
  • Description has been added
  • Related changes have been added (optional)
  • Screenshots have been added (optional, may include unit testing screenshots as well)
  • Pending actions have been added (optional)
  • Any other additional notes have been added (optional)

Additional Information

  • Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
  • Assignee(s) and reviewer(s) have been added (optional)

Note: Reviewer should ensure that the checklist and description have been populated and followed correctly, and the PR should be merged only after resolving all conversations and verifying that CI checks pass.


Description:

Add reload button to reload notifications for portal

Related changes:

  • Add reload button
  • On click, LoadNotificationLazy function retains all filters and page values
  • Add grid css for styling components
  • Test local build
  • Test dockerized build using local api endpoint

Screenshots:

image

Pending actions:
NA

Additional notes:
NA

Summary by CodeRabbit

  • New Features

    • Introduced a new "Clear" button for the notification search, enabling users to reset the search input easily.
    • Updated the "Reload" button's label and functionality for better clarity and user experience.
  • Style

    • Implemented a new grid layout for the notification filters, enhancing the overall structure and accessibility of the component.

Copy link

coderabbitai bot commented Oct 24, 2024

Walkthrough

The changes involve modifications to the notifications.component.html and notifications.component.scss files. The HTML file has been updated to reorganize the notification filter layout into a grid format, introducing a new "Clear" button alongside the existing "Search" button. The "Reload" button has been relabeled and its functionality adjusted. In the SCSS file, a new .grid-row class has been added to implement a two-column grid layout for better element arrangement.

Changes

File Path Change Summary
apps/portal/src/app/views/notifications/notifications.component.html Modified layout to a grid structure, added "Clear" button, and adjusted "Reload" button functionality and label. Removed previous filter row structure.
apps/portal/src/app/views/notifications/notifications.component.scss Introduced a new CSS class .grid-row for a two-column grid layout.

Possibly related PRs

  • feat: add search notifier field #312: The changes in this PR also involve modifications to the notifications.component.html file, specifically adding a search functionality and a clear button, which directly relates to the changes made in the main PR regarding the search and clear functionalities.

Suggested labels

enhancement

Suggested reviewers

  • xixas

Poem

In the land of notifications bright,
A "Clear" button shines, what a sight!
With grids aligned, all neat and fair,
Reloading with ease, without a care.
Hopping through filters, we find our way,
A joyful update, hip-hip-hooray! 🐇✨


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

@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 (3)
apps/portal/src/app/views/notifications/notifications.component.scss (1)

174-177: Consider enhancing the grid layout with additional properties.

While the current implementation works, it could benefit from some improvements:

Consider applying this enhancement:

 .grid-row {
   display: grid;
   grid-template-columns: 1fr auto; /* 1fr for left, auto for right */
+  gap: 1rem; /* Add consistent spacing between grid items */
+  /* Consider renaming to something more specific like .notification-filter-row */
 }
apps/portal/src/app/views/notifications/notifications.component.html (2)

59-83: LGTM! Consider adding ARIA labels for accessibility.

The grid layout implementation and search functionality are well-structured. The email validation pattern and button states are properly handled.

Consider adding ARIA labels to improve accessibility:

 <input
   type="email"
   pInputText
   [(ngModel)]="searchValue"
   placeholder="Search Notifier Email"
+  aria-label="Search by notifier email"
   class="grid-input"
   pattern="^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"
   #searchInput="ngModel"
 />

85-87: Consider UX improvements for the reload functionality.

While the reload button correctly preserves filters and pagination as required, consider these UX enhancements:

  1. The warning severity might not be the most appropriate choice for a reload action. Consider using primary or info severity instead.
  2. Add visual feedback during reload operation.
 <p-button
   (onClick)="loadNotificationsLazy({ first: this.currentPage, rows: this.pageSize })"
   label="Reload"
-  severity="warning"
+  severity="info"
+  [loading]="loading"
   class="grid-button"
 />
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fa5b44d and 302d271.

📒 Files selected for processing (2)
  • apps/portal/src/app/views/notifications/notifications.component.html (1 hunks)
  • apps/portal/src/app/views/notifications/notifications.component.scss (1 hunks)
🔇 Additional comments (1)
apps/portal/src/app/views/notifications/notifications.component.scss (1)

174-177: LGTM! Clean grid implementation.

The grid layout implementation is well-structured and aligns with modern CSS practices.

@kshitij-k-osmosys kshitij-k-osmosys changed the title feat: add reload button feat: add reload button for portal Oct 24, 2024
@xixas xixas merged commit 563a3f3 into main Oct 24, 2024
6 checks passed
@xixas xixas deleted the feat/portal-refresh branch October 24, 2024 13:23
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.

2 participants