> For the complete documentation index, see [llms.txt](https://2600hz.gitbook.io/sds/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://2600hz.gitbook.io/sds/sds-3.0/sds-components/components/toast.md).

# Toast

### Use Cases:

✅ Displaying success messages after a user successfully completes an action (e.g., "Your changes have been saved.")

✅ Showing error messages when a user encounters a problem (e.g., "An error occurred. Please try again.")

✅ Providing informative messages or notifications (e.g., "You have a new message.")

✅ Showing warning messages to alert users about potential issues (e.g., "Your password will expire in 3 days.")

### Not to Use Cases:

❌ Displaying critical system errors that require immediate action (e.g., "Database connection failed. Please contact support immediately.") - Critical errors should be handled with a more prominent and comprehensive error handling system, not just a Toast component.

❌ Showing long or complex messages with detailed instructions or explanations - Toasts are typically used for short and concise messages, so it's not suitable for displaying lengthy content.

❌ Using Toasts for interactive components or forms that require user input - Toasts are meant for displaying messages and should not be used as a replacement for interactive UI elements like forms or modals.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://2600hz.gitbook.io/sds/sds-3.0/sds-components/components/toast.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.