@aminekun90/react-toast

中文文档
1.3.0发布于 2026/10/21MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 7.6万

轻而易举的高性能 基于钩子 用于React 18 & 19. 的土司通知库.

中文使用文档
文档目录16 节
  1. 软件
  2. 关键特性
  3. 安装
  4. 同伴依赖关系
  5. 配置
  6. 使用量
  7. 1. 增加全球集装箱
  8. 2. 触发通知
  9. 3. 全球缺省(可选)
  10. 4. 装入并许诺吐司
  11. API 参考
  12. 托斯特配置属性
  13. 他们
  14. 兼容性
  15. 保留此工程: coffee:
  16. 许可证

@aminekun90/反应吐槽:

轻而易举的高性能 基于钩子 用于React 18 & 19. 的土司通知库.

React Version Maintenance version number License node-current NPM

软件

查看 React Demo

与 Angular 库共享其核心引擎和样式表 @aminekun90/ngx-toast ——行为和主题相同.

关键特性

  • ⚛️ 反应 18 & 19 准备: 完全支持并联模式和最新反应特性.
  • ⚓ 基于 Hook 的 API: 简单而直观 useToast() 钩入触发通知.
  • 🎨 FontAsome 整合:专业相片被烤入.
  • ♿ 可访问数字 : role="alert", (中文(简体) ), aria-live,键盘解析(Enter/Space/Escape),焦点样式.
  • ⏸️ 暂停悬浮: 计时器和进度栏在徘徊/聚焦时暂停.
  • 🌙 主题和暗模式: 有5个内置主题,全CSS可变定制,自动暗模式.
  • 🧩 全局默认值: 配置位置、 持续时间、 最大堆栈、 通过 <ToastProvider config>。 。 。 .
  • 🔁 承诺加载土司( L)数字 : loading() 财务报告和审定财务报表 promise() 帮助交换位置.
  • 📦 小声:小捆绑,与Vite最优化,0外跑时道克.

安装

通过 雅伦数字 :

yarn add @aminekun90/react-toast

同伴依赖关系

确保您安装了下列依赖性( 图标和对等比需要):

yarn add @fortawesome/react-fontawesome @fortawesome/fontawesome-svg-core @fortawesome/free-solid-svg-icons

配置

用 ToastProvider。 。 。 .

import { ToastProvider } from '@aminekun90/react-toast';

export function App() {
  return (
    <ToastProvider> <!-- Mandatory -->
      <MyMainComponent />
    </ToastProvider>
  );
}

使用量

1. 增加全球集装箱

设置 ToastContainer 在应用程序的根( 通常在 App.tsx) (中文(简体) ). 它将管理所有有效通知的堆放.

import { ToastContainer } from '@aminekun90/react-toast';

export default function App() {
  return (
    <div className="app-root">
      <ToastContainer />
      <MyContent />
    </div>
  );
}

2. 触发通知

使用 useToast 钩子在你体内的任何地方 ToastProvider。 。 。 .

import { useToast } from '@aminekun90/react-toast';

export function MyComponent() {
  const { success, error, info, warning } = useToast();

  const handleAction = () => {
    success('Operation successful!', 'Success');
  };

  return <button onClick={handleAction}>Click me</button>;
}

3. 全球缺省(可选)

<ToastProvider config={{
  position: 'top-right',
  duration: 4000,
  pauseOnHover: true,
  maxToasts: 5,
  preventDuplicates: true,
  newestOnTop: true,
}}>
  <App />
</ToastProvider>

4. 装入并许诺吐司

const { loading, success, promise } = useToast();

const id = loading('Uploading…');
// later: success('Done!', undefined, { id });

await promise(saveUser(), {
  loading: 'Saving…',
  success: (user) => `Saved ${user.name}`,
  error: (err) => `Failed: ${err}`,
});

API 参考

方法回返说明
show(config)number显示祝酒词; 返回其ID 。 重用一个 id 随时更新.
success/error/warning/info(message, title?, config?)number已键入快捷键 .
loading(message, title?, config?)number不断加载吐司.
promise(promise, msgs, config?)Promise<T>装入 – 成功/ 错误, 互换到位 .
remove(id)void辞去一干一干.
clear(position?)void解散所有的土司, 选择的位置.
pause(id) 编号 : resume(id)void暂停/恢复自动解除计时器 .

托斯特配置属性

财产类型默认说明
type'success' | 'error' | 'warning' | 'info' | 'loading''info'视觉主题和图标.
titlestringundefined可选的大胆标题.
messagestring—— 说主要文本内容.
durationnumber5000时间( 毫秒)0 = 持续).
positionToastPosition'bottom-right'屏幕放置.
progressBarbooleanfalse显示倒计时栏.
progressAnimation'increasing' | 'decreasing''increasing'栏指向.
iconIconDefinition按类型自定义 FontAweome 图标 .
toastClassstring''额外CSS课.
pauseOnHoverbooleantrue暂停徘徊/聚焦.
themestringundefinedmaterial | glass | minimal | neon | solid 或习惯.

他们

5个内置主题,每个土司或全球适用;一切都是CSS可变的 为完全定制而驱动.

success('Saved!', undefined, { theme: 'glass' });
<body class="ngx-toast-theme-material">…</body>

* 全文参考: 文件/主题.md • 妇女 🏗️ 文献/档案

兼容性

软件包反应版本节点.js 版本
1.0.x (中文(简体) )^18.0.0 ^19.0^22.x ^24.x

保留此工程: coffee:

我花时间和精力维持这个图书馆。 如果有帮助,请考虑捐赠!

通过 PayPal 捐款

许可证

麻省理工学院执照,由Amine Bouzahar执导.

版本与发布记录

@aminekun90/react-toast 共发布 13 个版本,首次发布于 2026/03/05;过去 12 个月发布了 13 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.3.0latest2026/10/2116 天前
1.2.02026/06/214 个月前
1.1.12026/03/187 个月前
1.1.02026/03/127 个月前
1.0.112026/03/117 个月前
1.0.102026/03/117 个月前

关于 @aminekun90/react-toast 的常见问题

@aminekun90/react-toast 是什么?

轻而易举的高性能 基于钩子 用于React 18 & 19. 的土司通知库.

如何安装 @aminekun90/react-toast?

在项目目录运行 npm install @aminekun90/react-toast,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、react-dom(^18.0.0 || ^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@aminekun90/react-toast 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@aminekun90/react-toast 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@aminekun90/react-toast 可以商用吗?

@aminekun90/react-toast 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@aminekun90/react-toast 的下载量有多少?

根据 npm 官方下载统计,@aminekun90/react-toast 在 2026/10/06 – 2026/11/04 这 30 天内被下载 76,410 次,日均约 2,547 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@aminekun90/react-toast 还在维护吗?

最新版本 1.3.0 发布于 2026/10/21(16 天前);至今共发布 13 个版本,其中过去 12 个月发布了 13 个;首次发布于 2026/03/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。