@dt-dds/react-toast

中文文档
1.0.0-beta.138发布于 2026/11/13MITTypeScriptESM + CJS近 30 天下载 2453

Toast是一个弹出消息,用来向我们的用户显示相关信息.

中文使用文档
文档目录13 节
  1. 图片参考
  2. 使用量
  3. 可自定义
  4. API 密码
  5. 烤面包机
  6. 发出祝词
  7. 辞退
  8. 土司
  9. 堆栈
  10. 图标
  11. 汇编
  12. 版本
  13. 许可证

土司

Toast是一个弹出消息,用来向我们的用户显示相关信息.

图片参考

图片

使用量

import { Toaster, ToastType, emitToast } from '@dt-dds/react';

const notify = () =>
  emitToast({
    title: 'success',
    message: 'myMEssage' + count,
    type: ToastType.Success,
    children: (
      <Tooltip>
        <Button onClick={() => console.log('clicked')}>Action 2</Button>
        <Tooltip.Content>Some tooltip</Tooltip.Content>
      </Tooltip>
    ),
  });

const App = () => {
  return (
    <div>
      <button onClick={notify}>Click me</button>
      <Toaster />
    </div>
  );
};

可自定义

这是一个非常定制的组件. 我们用的是 反应- 热- 托斯克 为了控制我们的供应商 你可以检查 react-hot-toast 记录更多这方面的知识。 不过,如果您愿意,您可以创建供货商。 比如说你想创造一个新的道具 autoHide如果这个道具不真实, 你想让吐司无限期地在屏幕上.

interface CallToastArgs {
  title: string;
  message: string;
  type: ToastType;
  autoHide: boolean;
}

export const ToasterContext = createContext({
  callToast: (args: CallToastArgs) => null,
});

const Toaster = ({ children }: { children: React.ReactNode }) => {
  const [toast, setToast] = useState<
    Partial<ToastProps> & { autoHide: boolean }
  >(null);

  const callToast = ({ title, message, type, autoHide }: CallToastArgs) =>
    setToast({
      id: Date.now().toString(),
      title,
      message,
      type,
      autoHide,
    });

  const close = () =>
    setToast((prevState) => ({ ...prevState, isVisible: false }));

  useEffect(() => {
    if (toast && toast.autoHide) {
      const timer = setTimeout(() => close(), 1000);
      return () => clearTimeout(timer);
    }
  }, [toast]);

  return (
    <ToasterContext.Provider value={{ callToast }}>
      {children}
      <div style={{ position: 'fixed', bottom: 10, left: 10 }}>
        {toast && (
          <Toast
            key={toast.id}
            id={toast.id}
            type={toast.type}
            title={toast.title}
            message={toast.message}
            isVisible={toast.isVisible}
            onClose={close}
          />
        )}
      </div>
    </ToasterContext.Provider>
  );
};

const App = () => {
  return (
    <Toaster>
      <MyComponent />
    </Toaster>
  );
};

const MyComponent = () => {
  const { callToast } = useContext(ToasterContext);

  return (
    <Button
      onClick={() =>
        callToast({
          message: 'myMEssage' + count,
          type: ToastType.Success,
          title: 'success',
          autoHide: false,
        })
      }
    >
      Clicked Me
    </Button>
  );
};

API 密码

烤面包机

财产类型默认说明
toastOptionsDefaultToastOptions- 说吧这些将成为所有土司的默认选项. 见文件 这里。 。 。 .
reverseOrderboolean- 说吧土司在顶端产卵 默认。 如果你想在最后再敬酒,就说对了.
gutternumber第8条改变每个土司之间的差距.
containerStyleReact.CSSProperties- 说吧定制烤面包机 div 的样式 。 这可以用来改变所有土司的偏移
containerClassNamestring未定义添加自定义的 CSS 类名到 toaster div .
children(toast: Toast) => JSX.Element- 说吧你可以定制每个土司的展示方式 将自己的制作功能 传给土司作为孩子。 每一个土司都使用这个功能, 注意:如果渲染的组件是一个按钮,其样式将被默认样式所压倒.

发出祝词

财产类型默认说明
typeenum<ToastType>- 说吧设置变体土司 ("成功",".","N")
titlestring- 说吧要显示的标题
messagestring- 说吧要显示的消息
dismissableboolean真实设置关闭按钮的能见度, 该按钮将点出关闭回调
childrenReactNode- 说吧内容部分结尾处将提供的孩子

出自Toast可选词. 它们将覆盖从 <Toaster />。例如:

财产类型默认说明
durationnumber成功: 4000, 错误: 无穷连续展示祝酒词
styleCSSProperties- 说吧直接在土司上添加cs.

您可以检查所有 Toast 选项 这里。 。 。 . 土司的位置是固定的,在小屏幕上,它会位于下方中心并会位于大屏幕上,右下方. 任何一种土司的默认持续时间为4000ms. 对于错误类型,持续时间是无限的.

辞退

财产类型默认说明
toastIdstring- 说吧祝酒词要撤销

土司

财产类型默认说明
idstring- 说吧敬酒标识符
dataTeststring- 说吧定义数据测试的值
titlestring- 说吧要显示的标题
messagestring- 说吧要显示的消息
onClosestring- 说吧关闭按钮被发射时的回叫.
typeenum<ToastType>- 说吧设置变体土司 ("成功",".","N")
isVisibleboolean真实设定吐司的能见度并触发淡出效果
dismissableboolean真实设置关闭按钮的能见度, 该按钮将点出关闭回调
childrenReactNode- 说吧内容部分结尾处要渲染的子组件, 这可以用来接收动作按钮

堆栈

图标

  • yarn build - 制作软件包
  • yarn dev - 在当地运行软件包
  • yarn lint - 将所有文件输入此软件包
  • yarn test - 测试所有单位
  • yarn test:report - 打开测试覆盖报告
  • yarn test:update:snapshot - 进行所有单元测试并更新快照

汇编

运行 yarn build 从软件包的根部 齐声 将原始的 TypeScript 和 React 代码编译为普通 JavaScript .

这个 /dist 文件夹包含编译输出.

toast
└── dist
    ├── index.d.ts  <-- Types
    ├── index.js    <-- CommonJS version
    └── index.mjs   <-- ES Modules version
    ...

版本

跟着 语义版本

许可证

许可证根据 MIT 许可证

版本与发布记录

@dt-dds/react-toast 共发布 80 个版本,首次发布于 2025/08/07;过去 12 个月发布了 47 个版本。

版本发布日期距今
1.0.0-beta.138latest2026/11/13今天
1.0.0-beta.1372026/11/049 天前
1.0.0-beta.1362026/10/2816 天前
1.0.0-beta.1352026/10/2321 天前
1.0.0-beta.1342026/10/1925 天前
1.0.0-beta.1332026/10/1628 天前

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

@dt-dds/react-toast 是什么?

Toast是一个弹出消息,用来向我们的用户显示相关信息.

如何安装 @dt-dds/react-toast?

在项目目录运行 npm install @dt-dds/react-toast,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=17.0.2)、react-dom(>=17.0.2)、@emotion/css(^11.7.1)、@emotion/react(^11.8.2)、@emotion/styled(^11.8.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@dt-dds/react-toast 支持 TypeScript 吗?

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

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

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

@dt-dds/react-toast 可以商用吗?

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

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

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

@dt-dds/react-toast 还在维护吗?

最新版本 1.0.0-beta.138 发布于 2026/11/13(今天);至今共发布 80 个版本,其中过去 12 个月发布了 47 个;首次发布于 2025/08/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。