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 search notifier field #312

Merged
merged 4 commits into from
Sep 9, 2024
Merged

feat: add search notifier field #312

merged 4 commits into from
Sep 9, 2024

Conversation

ghost
Copy link

@ghost ghost commented Aug 22, 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 brief description about the changes made in this PR and their purpose. This section can also include mention to any other PRs or issues if needed.

Related changes:

  • Add a search field, button that calls the notification loading method along with a clear button, with proper validation
  • Update notification component ts code to add logic for adding filter for contains on data field if notifier search value exists
  • Add the required styles for displaying the text field and button correctly

Screenshots:
image
image
image

Pending actions:

N/A

Additional notes:

N/A

Summary by CodeRabbit

  • New Features
    • Introduced a search functionality to filter notifications by email.
    • Added input field and buttons for searching and clearing search input.
  • Style
    • Enhanced CSS for a unified look of search elements and improved spacing.
  • Bug Fixes
    • Improved logic for filtering notifications based on search input, enhancing user experience.

Add a search field, button that calls the notification loading method along with a clear button, with proper validation
Update notification component ts code to add logic for adding filter for contains on data field if notifier search value exists
Add the required styles for displaying the text field and button correctly
@ghost ghost added enhancement New feature or request ready for review labels Aug 22, 2024
@ghost ghost self-assigned this Aug 22, 2024
Copy link

coderabbitai bot commented Aug 22, 2024

Walkthrough

The changes introduced a search functionality in the notifications component, enabling users to filter notifications by email. This includes a new input field for email addresses, validation for the input, and buttons for searching and clearing the input. Additionally, modifications were made to the associated styles for improved layout consistency, and the component's logic was updated to filter notifications based on the search input.

Changes

Files Change Summary
apps/portal/src/app/views/notifications/notifications.component.html
apps/portal/src/app/views/notifications/notifications.component.scss
apps/portal/src/app/views/notifications/notifications.component.ts
Added a search input for filtering notifications by email, including validation and associated buttons. Updated styles for consistent layout and modified component logic to incorporate email filtering.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NotificationsComponent

    User->>NotificationsComponent: Enter email in search input
    NotificationsComponent-->>User: Validate email input
    User->>NotificationsComponent: Click Search Button
    NotificationsComponent-->>User: Filter notifications based on email
    User->>NotificationsComponent: Click Clear Button
    NotificationsComponent-->>User: Clear search input
Loading

Poem

In the meadow where bunnies play,
A search for notifications brightens the day.
With buttons to click and emails to find,
Hopping through filters, leaving worries behind. 🐇✨
A joyful leap, a clear pathway,
Bunnies rejoice in their own special way!


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

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

62-62: Consider specifying a type for searchValue.

Currently, searchValue is of type any. Consider specifying a more precise type, such as string, to improve type safety.

- searchValue = null;
+ searchValue: string = null;
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6606e17 and 9ade244.

Files selected for processing (3)
  • apps/portal/src/app/views/notifications/notifications.component.html (2 hunks)
  • apps/portal/src/app/views/notifications/notifications.component.scss (1 hunks)
  • apps/portal/src/app/views/notifications/notifications.component.ts (3 hunks)
Files skipped from review due to trivial changes (1)
  • apps/portal/src/app/views/notifications/notifications.component.scss
Additional comments not posted (4)
apps/portal/src/app/views/notifications/notifications.component.ts (2)

142-144: LGTM! The onSearchClear method is well-implemented.

The method effectively resets the searchValue to null, allowing users to clear their search input.


215-221: LGTM! The filtering logic in loadNotificationsLazy is correctly implemented.

The logic for filtering notifications based on searchValue is well-integrated and aligns with the PR objectives.

apps/portal/src/app/views/notifications/notifications.component.html (2)

60-68: LGTM! The search input field is well-implemented with validation.

The input field is correctly bound to the searchValue model and includes a validation pattern for email format.


69-81: LGTM! The search and clear buttons are well-implemented.

The buttons are correctly enabled/disabled based on the input validity and value, ensuring proper user interaction.

@xixas xixas merged commit 2e05661 into main Sep 9, 2024
6 checks passed
@xixas xixas deleted the feat/search-notifier branch September 9, 2024 05:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants