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 toastr service #23

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: add toastr service #23

wants to merge 3 commits into from

Conversation

Hitesh-Kandpal
Copy link
Contributor

@Hitesh-Kandpal Hitesh-Kandpal commented Aug 26, 2024

Changes in PR:

  1. Add toastr service
  2. Add packages for toastr service

Summary by CodeRabbit

  • New Features

    • Introduced toast notifications using the Toastr library for improved user feedback.
    • Added a centralized ToastrService for easy integration of notifications throughout the application.
  • Enhancements

    • Updated project configurations to include Toastr styles and improved analytics tracking.
    • Enhanced TypeScript module import capabilities with new configuration options.
  • Dependencies

    • Added toastr and its type definitions for notification support.

Copy link

coderabbitai bot commented Aug 26, 2024

Walkthrough

The update introduces enhancements to the Angular project by integrating the Toastr notification library, adding its CSS to the angular.json file and including necessary dependencies in package.json. A new ToastrService is implemented to manage toast notifications, while the TypeScript configuration is adjusted to allow synthetic default imports. These changes collectively improve user feedback mechanisms and streamline module imports.

Changes

File Change Summary
angular.json Added Toastr CSS file to styles array; updated CLI settings with an analytics property.
package.json Added dependencies for toastr and @types/toastr.
src/app/shared/services/toastr.service.ts Introduced ToastrService class for managing toast notifications with methods for different types.
tsconfig.json Added "allowSyntheticDefaultImports": true configuration option.

Poem

🐇 In a world of toast so bright,
Notifications take their flight.
With Toastr's charm, we now can say,
"Hooray for updates, hip-hip-hooray!"
A sprinkle of joy, a dash of cheer,
Our app is better, oh so dear! 🎉


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 generate interesting stats about this repository and render them as a table.
    -- @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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 10ffe80 and c5647ef.

Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
Files selected for processing (4)
  • angular.json (3 hunks)
  • package.json (3 hunks)
  • src/app/shared/services/toastr.service.ts (1 hunks)
  • tsconfig.json (1 hunks)
Additional comments not posted (11)
tsconfig.json (1)

9-9: LGTM!

The addition of "allowSyntheticDefaultImports": true is a good enhancement for compatibility with various JavaScript modules and libraries.

The code changes are approved.

src/app/shared/services/toastr.service.ts (5)

9-17: LGTM!

The constructor correctly initializes the toastr options. Consider adding comments to explain the configuration options if needed.

The code changes are approved.


19-21: LGTM!

The success method correctly displays a success message using toastr.

The code changes are approved.


23-25: LGTM!

The error method correctly displays an error message using toastr.

The code changes are approved.


27-29: LGTM!

The info method correctly displays an info message using toastr.

The code changes are approved.


31-33: LGTM!

The warning method correctly displays a warning message using toastr.

The code changes are approved.

package.json (2)

34-34: LGTM!

The addition of toastr as a dependency is appropriate for the toastr service.

The code changes are approved.


49-49: LGTM!

The addition of @types/toastr as a dependency is appropriate for TypeScript type definitions.

The code changes are approved.

angular.json (3)

30-30: LGTM!

The addition of the Toastr CSS file to the styles array is appropriate and necessary for styling the Toastr notifications.

The code changes are approved.


90-90: LGTM!

The addition of the Toastr CSS file to the styles array in the test options is appropriate and necessary for styling the Toastr notifications during testing.

The code changes are approved.


106-107: LGTM!

The addition of the analytics property with a unique identifier in the CLI settings is appropriate for tracking and analytics purposes.

The code changes are approved.

package.json Outdated
@@ -31,6 +31,7 @@
"primeicons": "^6.0.1",
"primeng": "^16.7.2",
"rxjs": "~7.8.0",
"toastr": "^2.1.4",
Copy link
Contributor

Choose a reason for hiding this comment

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

Any reason why we are using this?
We have created this foundation using primeNG. So we should be using toast from primeNG too?

https://primeng.org/toast

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i took the toastr service from pickleball initial setup as suggested by Raj, there we were using toastr, also I don't see any primeng module imported in foundation right now, should I go ahead an add primeng.module.ts and use primeng toastr instead of this?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes use primeng toastrs only. For Foundation we will rely on PrimeNG only
https://primeng.org/toast

package.json Outdated
@@ -31,6 +31,7 @@
"primeicons": "^6.0.1",
"primeng": "^16.7.2",
"rxjs": "~7.8.0",
"toastr": "^2.1.4",
Copy link
Contributor

Choose a reason for hiding this comment

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

Yes use primeng toastrs only. For Foundation we will rely on PrimeNG only
https://primeng.org/toast

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.

2 participants