fix!: add close event to toast component

[robluton]

Closes # 1348

📑 Description

This PR adds an on:close event to the Toast component, allowing custom logic to be executed when the toast is closed.

Status

• Not Completed
• Completed

✅ Checks

• My pull request adheres to the code style of this project
• My code requires changes to the documentation
• I have updated the documentation as required
• I have checked the page with https://validator.unl.edu/
• All the tests have passed
• My pull request is based on the latest commit (not the npm version).

Summary by CodeRabbit

• New Features
  • Added a 'close' event to the Toast component, allowing custom actions when the toast is closed.
• Documentation
  • Updated documentation to include a new section on the 'close' event for the Toast component.

[vercel]

@robluton is attempting to deploy a commit to the Themesberg Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The update introduces a new 'close' event to the Toast component and its documentation. This event, triggered upon the toast element being clicked, allows developers to implement custom logic for handling toast closures.

Changes

File	Change Summary
src/lib/toast/Toast.svelte	Added createEventDispatcher to dispatch 'close' events on click.
src/routes/component-data/Toast.json	Updated to include "on:close" event in the events array.
src/routes/docs/components/toast.md	Added a new Events section demonstrating usage of on:close event.

Possibly related issues

• Toast close events don't propagate #1348: The changes introduce the on:close event which dispatches properly, resolving an issue where close events didn't propagate.

Poem

In the realm of code we toast,
Where events and toasts make the most,
A click and poof, the toast is gone,
A 'close' event, to carry on.
With Svelte we craft, with joy so vast,
Our updates swift, and changes fast. 🍞✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

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 6d5352c and 927e38f.

Files selected for processing (3)

• src/lib/toast/Toast.svelte (3 hunks)
• src/routes/component-data/Toast.json (1 hunks)
• src/routes/docs/components/toast.md (1 hunks)

Additional comments not posted (5)

src/routes/component-data/Toast.json (1)

4-4: Approved: Addition of on:close event.

The addition of the on:close event to the Toast component metadata is correct and aligns with the new functionality.

src/lib/toast/Toast.svelte (3)

3-3: Approved: Import createEventDispatcher from 'svelte'.

The import statement for createEventDispatcher is correct and necessary for dispatching events.

---

24-24: Approved: Create dispatch constant.

The dispatch constant is correctly created using createEventDispatcher.

---

99-99: Approved: Dispatch 'close' event on toast close.

The 'close' event is correctly dispatched when the toast is closed, allowing for custom logic to be executed.

src/routes/docs/components/toast.md (1)

348-360: Approved: Addition of "Events" section with on:close event example.

The documentation correctly adds a new "Events" section and provides a clear example of how to use the on:close event.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
flowbite-svelte	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 8, 2024 3:38am