Skip to content

docs(toast): document toast functions API#2131

Open
marcelovicentegc wants to merge 1 commit intomainfrom
emdash/gh-issue-1812-18m
Open

docs(toast): document toast functions API#2131
marcelovicentegc wants to merge 1 commit intomainfrom
emdash/gh-issue-1812-18m

Conversation

@marcelovicentegc
Copy link
Copy Markdown
Member

Summary

  • Adds a Functions section to the Toast documentation page (toast.mdx) with a table describing all toast methods: informational, success, critical, warning, loading, promise, and dismiss, along with their signatures and descriptions.
  • Adds JSDoc comments to each method in toast-function.ts for IDE intellisense.
  • Adds Related components section linking to ToastStack, Alert, and Modal.

Closes #1812

Test plan

  • Verify the Toast docs page renders the new Functions table correctly
  • Verify the Related components section renders with proper links
  • Confirm toast method JSDoc comments appear in IDE hover/autocomplete

Made with Cursor

Add a Functions section to the toast docs page with a table describing
all toast methods (informational, success, critical, warning, loading,
promise, dismiss), their signatures, and descriptions. Also add Related
components and JSDoc comments to the source for IDE intellisense.

Closes #1812

Co-authored-by: Cursor <cursoragent@cursor.com>
@vercel
Copy link
Copy Markdown
Contributor

vercel bot commented Feb 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
shoreline-docs Ready Ready Preview Feb 18, 2026 1:03pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Document toast functions

1 participant