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 toast #102

Merged
merged 1 commit into from
Oct 10, 2024
Merged

feat: add toast #102

merged 1 commit into from
Oct 10, 2024

Conversation

ahsanshaheen199
Copy link
Contributor

@ahsanshaheen199 ahsanshaheen199 commented Oct 10, 2024

Summary by CodeRabbit

  • New Features

    • Introduced customizable toast notifications with different types (success, error, warning, info) via the new ToastBody component.
    • Added a custom hook useToast for easy toast notification creation.
    • New Storybook stories for the ToastBody component showcasing different toast variations.
  • Chores

    • Updated .gitignore to exclude the storybook-static directory.
    • Added react-hot-toast dependency to package.json.

Copy link

coderabbitai bot commented Oct 10, 2024

Walkthrough

The changes involve updates to several files in the project. The .gitignore file now includes the storybook-static directory. The package.json file has added a new dependency on react-hot-toast and made a minor formatting adjustment. A new ToastBody component has been created to display customizable toast notifications, along with a custom hook useToast for managing these notifications. Additionally, exports have been updated to include the new Toast component, and Storybook stories for the ToastBody component have been added.

Changes

File Change Summary
.gitignore Added entry for storybook-static to be ignored by Git.
package.json Added dependency: "react-hot-toast": "^2.4.1"; minor formatting change for react-dom.
src/components/toast-body.tsx Introduced ToastBody component with props for customizable notifications.
src/components/use-toast.tsx Added useToast hook for creating toast notifications; defined ToastTypes and ToastOptions.
src/index.tsx Exported Toast component from use-toast.tsx.
src/stories/Toast.stories.tsx Created Storybook stories for ToastBody: Default, Error, and Description.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ToastHook as useToast
    participant ToastBody

    User->>ToastHook: Call useToast()
    ToastHook->>ToastBody: Render toast with options
    ToastBody->>User: Display toast notification
    User->>ToastBody: Click close button
    ToastBody->>ToastHook: Update state to hide toast
Loading

🐇 "In the garden, toasts will fly,
With colors bright, they catch the eye.
A sprinkle of joy, a dash of cheer,
With every toast, we spread good cheer!
So hop along, let notifications sing,
For every moment, let joy take wing!" 🥳


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 65eb541 and 1bd9435.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (6)
  • .gitignore (1 hunks)
  • package.json (1 hunks)
  • src/components/toast-body.tsx (1 hunks)
  • src/components/use-toast.tsx (1 hunks)
  • src/index.tsx (1 hunks)
  • src/stories/Toast.stories.tsx (1 hunks)

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 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.

@arafatkn arafatkn merged commit 6cbef94 into develop Oct 10, 2024
1 check failed
@arafatkn arafatkn deleted the feat/toast branch October 10, 2024 12:03
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