Installation

Package Manager

Install Nudge UI using your preferred package manager:

npm

npm install nudge-ui

yarn

yarn add nudge-ui

pnpm

pnpm add nudge-ui

bun

bun add nudge-ui

CDN (no build step)

Use the ESM build directly from a CDN for quick prototyping:

<!-- Latest version -->
<script type="module">
  import { toast } from "https://cdn.jsdelivr.net/npm/nudge-ui/dist/index.esm.js";
  toast.success("Hello from CDN!");
</script>

Peer Dependencies

If you are using the React bindings, ensure React is installed:

npm install react react-dom

TypeScript

Nudge UI is written in TypeScript - types are bundled automatically. No additional @types/ packages are required.

CSS

Import the default CSS stylesheet once at the root of your app:

// In your layout or _app file
import "nudge-ui/dist/toaster.css";

Or copy the styles from toaster.css and customize them to match your brand. All class names follow the BEM .toast__* convention so they are easy to override.