robot-toast 1.0.0-beta.0 → 1.0.0

package/README.md

@@ -2,10 +2,35 @@
 
 A lightweight, zero-dependency, framework-agnostic toast notification library featuring an animated robot companion. Fully draggable, typewriter-style messages, multiple themes, rich transitions, and a cast of **16 built-in robots** — or bring your own.
 
+<p align="left">
+  <a href="https://stackblitz.com/your-demo-link" 
+     style="color:#e53935; font-weight:600; text-decoration:none;">
+    Demo
+  </a>
+</p>
+<p align="center">
+  <a href="https://pratham-potfolio.vercel.app/" target="_blank">
+    <img src="https://img.shields.io/badge/Portfolio-000?style=for-the-badge&logo=vercel&logoColor=white" />
+  </a>
+  <a href="https://www.linkedin.com/in/pratham-kumar-a6b672275/" target="_blank">
+    <img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" />
+  </a>
+  <a href="https://github.com/Pratham2703005" target="_blank">
+    <img src="https://img.shields.io/badge/GitHub-000?style=for-the-badge&logo=github&logoColor=white" />
+  </a>
+</p>
+<p align="center">
+  <a href="https://www.npmjs.com/package/robot-toast">
+    <img src="https://img.shields.io/npm/v/robot-toast?style=flat-square" />
+  </a>
+  <img src="https://img.shields.io/npm/dt/robot-toast?style=flat-square" />
+  <img src="https://img.shields.io/bundlephobia/minzip/robot-toast?style=flat-square" />
+</p>
+
 <p align="center">
-  <img src="public/lightmode.png" alt="Light mode" width="320" />
-  <img src="public/darkmode.png" alt="Dark mode" width="320" />
-  <img src="public/custom.png" alt="Custom styled" width="320" />
+  <img src="https://raw.githubusercontent.com/Pratham2703005/robot-toast/refs/heads/main/public/offiicial-page/lightmode.png" alt="Light mode" width="320" />
+  <img src="https://raw.githubusercontent.com/Pratham2703005/robot-toast/refs/heads/main/public/offiicial-page/darkmode.png" alt="Dark mode" width="320" />
+  <img src="https://raw.githubusercontent.com/Pratham2703005/robot-toast/refs/heads/main/public/offiicial-page/custom.png" alt="Custom styled" width="320" />
 </p>
 
 ---
@@ -58,15 +83,6 @@ toast({
 });
 ```
 
-## Type Shorthands
-
-```ts
-toast.success('Saved!');
-toast.error('Something went wrong');
-toast.info('Did you know…');
-toast.warning('Check your input');
-```
-
 ## Close Programmatically
 
 ```ts
@@ -79,7 +95,76 @@ toast.closeAll();
 ```
 
 ---
+## All Options at a Glance
+
+A single `toast()` call using **every available option** so you can see the full API in one place:
+
+```ts
+import { toast } from 'robot-toast';
+
+toast({
+  // ─── Content ───────────────────────────────────────────
+  message: 'This is the full kitchen-sink example!',
+
+  // ─── Appearance ────────────────────────────────────────
+  type: 'success',                // 'default' | 'info' | 'success' | 'warning' | 'error'
+  theme: 'dark',                  // 'light' | 'dark' | 'colored'
+  transition: 'bounce',           // 'bounce' | 'flip' | 'zoom' | 'slide'
+  position: 'bottom-right',       // 'top-left' | 'top-center' | 'top-right'
+                                  // 'bottom-left' | 'bottom-center' | 'bottom-right'
+
+  // ─── Robot ─────────────────────────────────────────────
+  robotVariant: 'wave',           // built-in: 'wave' | 'base' | 'base2' | 'success' | 'error'
+                                  //   'angry' | 'angry2' | 'shock' | 'think' | 'search'
+                                  //   'loading' | 'sleep' | 'head-palm' | 'type'
+                                  //   'validation' | 'validation2'
+                                  // custom: '/path/to/image.png' (svg, png, jpg, jpeg, gif, webp)
+                                  // hide: 'none'
+  nearScreen: true,               // true = robot near screen edge, false = robot on inner side
+
+  // ─── Timing ────────────────────────────────────────────
+  autoClose: 5000,                // milliseconds, or false to disable auto-close
+  typeSpeed: 30,                  // ms per character (0 = instant, no typing effect)
+
+  // ─── Behaviour ─────────────────────────────────────────
+  hideProgressBar: false,         // true to hide the countdown bar
+  draggable: true,                // allow drag & drop with edge-snapping
+  pauseOnHover: true,             // pause countdown on mouse hover
+  pauseOnFocusLoss: true,         // pause countdown when tab loses focus
+  rtl: false,                     // right-to-left layout
+
+  // ─── Multi-toast ───────────────────────────────────────
+  limit: 0,                       // max visible toasts (0 = unlimited, excess is queued)
+  newestOnTop: false,             // stack new toasts above older ones
+
+  // ─── Custom Inline Styles ─────────────────────────────
+  style: {
+    background: 'linear-gradient(135deg, #667eea, #764ba2)',
+    color: '#fff',
+    borderRadius: '16px',
+    fontFamily: 'monospace',
+  },
+
+  // ─── Callbacks ─────────────────────────────────────────
+  onOpen:  () => console.log('Toast appeared!'),
+  onClose: () => console.log('Toast dismissed!'),
+});
+```
+
+### Type Shorthands
 
+```ts
+// These set the `type` automatically — you can also pass a full options object
+toast.success('Saved!');
+toast.error('Something went wrong');
+toast.info('Did you know…');
+toast.warning('Check your input');
+
+// With additional options
+toast.success({ message: 'Deployed!', theme: 'colored', position: 'top-center', robotVariant: 'success' });
+```
+
+---
 ## Options
 
 | Option | Type | Default | Description |
@@ -179,11 +264,9 @@ toast({ message: 'Slide!',  transition: 'slide' });
 ```tsx
 'use client';
 import { toast } from 'robot-toast';
-import { useEffect, useRef } from 'react';
+import { useEffect } from 'react';
 
 export default function App() {
-  const shown = useRef(false);
-
   useEffect(() => {
     toast({
       message: 'Welcome!',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "robot-toast",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0",
   "description": "A lightweight, framework-agnostic toast notification library with an animated robot character. Draggable, typed messages, customizable positions, and SVG robot variants.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -15,10 +15,7 @@
   },
   "sideEffects": [
     "*.css",
-    "dist/**/*.js",
-    "dist/**/*.mjs",
-    "./src/styles-injector.ts",
-    "./dist/styles-injector.js"
+    "./src/styles-injector.ts"
   ],
   "files": [
     "dist"
@@ -43,9 +40,7 @@
   "author": "",
   "license": "MIT",
   "devDependencies": {
-    "@types/fs-extra": "^11.0.4",
     "@types/node": "^25.3.0",
-    "fs-extra": "^11.3.3",
     "rimraf": "^6.1.3",
     "tsup": "^8.0.0",
     "typescript": "^5.0.0"
@@ -58,10 +53,10 @@
   },
   "repository": {
     "type": "git",
-    "url": ""
+    "url": "https://github.com/Pratham2703005/robot-toast-package"
   },
   "bugs": {
-    "url": ""
+    "url": "https://github.com/Pratham2703005/robot-toast-package/issues"
   },
-  "homepage": ""
+  "homepage": "https://robot-toast.vercel.app/"
 }