🚀 Big News:Socket Has Acquired Secure Annex.Learn More →
Socket
Book a DemoSign in
Socket

@trycourier/courier-ui-toast

Package Overview
Dependencies
Maintainers
4
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@trycourier/courier-ui-toast

Toast components for the Courier web UI

latest
Source
npmnpm
Version
2.1.4
Version published
Weekly downloads
5.8K
22.51%
Maintainers
4
Weekly downloads
 
Created
Source

Courier Toast Web Components

Embed customizable toast notifications in your web app using Web Components. Courier Toast provides the <courier-toast> element that works with any JavaScript framework or vanilla JS. Toasts are synced with the feed of Courier Inbox messages.

Using React? Check out the Courier React SDK for React-native components and hooks.

Installation

npm install @trycourier/courier-ui-toast

Works with any JavaScript build system; no additional build configuration required.

Quick Start

<body>
  <courier-toast></courier-toast>

  <script type="module">
    import { Courier } from "@trycourier/courier-ui-toast";

    // Generate a JWT for your user on your backend server
    const jwt = "your-jwt-token";

    // Authenticate the user
    Courier.shared.signIn({
      userId: "your-user-id",
      jwt: jwt,
    });
  </script>
</body>

Authentication

The SDK requires a JWT (JSON Web Token) for authentication. Always generate JWTs on your backend server, never in client-side code.

If you've already set up authentication for Courier Inbox, you can skip this step; toasts and inbox share an authentication mechanism.

  • Your client calls your backend to request a token.
  • Your backend calls the Courier Issue Token endpoint using your API key.
  • Your backend returns the JWT to your client and passes it to the SDK.
curl --request POST \
     --url https://api.courier.com/auth/issue-token \
     --header 'Authorization: Bearer $YOUR_API_KEY' \
     --header 'Content-Type: application/json' \
     --data '{
       "scope": "user_id:$YOUR_USER_ID inbox:read:messages inbox:write:events",
       "expires_in": "1 day"
     }'

Features

  • Auto-Dismiss — configurable timeout with countdown bar (auto-dismiss, auto-dismiss-timeout-ms)
  • Click Handling — onToastItemClick() and onToastItemActionClick() for toast and action button clicks
  • Theming — full light/dark theme support with setLightTheme() and setDarkTheme()
  • Custom Elements — replace toast content (setToastItemContent) or entire toast items (setToastItem)
  • Datastore — CourierToastDatastore.shared.addMessage() and removeMessage() for programmatic control

Documentation

Full documentation: courier.com/docs/sdk-libraries/courier-ui-toast-web

Share feedback with Courier

Have an idea or feedback about our SDKs? Let us know!

Open an issue: Courier Web Issues

Keywords

courier

FAQs

Package last updated on 20 Apr 2026

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts