Toastify-JS 使用教程
1. 项目的目录结构及介绍
Toastify-JS 是一个纯 JavaScript 的 Toast 通知库。以下是其基本的目录结构:
toastify-js/
├── README.md
├── dist/
│ ├── toastify.css
│ ├── toastify.js
│ └── toastify.min.js
├── package.json
├── rollup.config.js
└── src/
├── toastify.js
└── toastify.scss
目录介绍
- README.md: 项目说明文档。
- dist/: 编译后的文件,包含 CSS 和 JavaScript 文件。
- toastify.css: Toastify 的样式文件。
- toastify.js: 未压缩的 JavaScript 文件。
- toastify.min.js: 压缩后的 JavaScript 文件。
- package.json: 项目的依赖和脚本配置文件。
- rollup.config.js: Rollup 打包配置文件。
- src/: 源代码目录。
- toastify.js: 主要的 JavaScript 源代码。
- toastify.scss: 样式源代码。
2. 项目的启动文件介绍
Toastify-JS 的启动文件是 dist/toastify.js
或 dist/toastify.min.js
。这两个文件是编译后的 JavaScript 文件,可以直接在网页中引用。
使用方法
在 HTML 文件中引入 CSS 和 JavaScript 文件:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Toastify Example</title>
<link rel="stylesheet" href="path/to/toastify.css">
</head>
<body>
<script src="path/to/toastify.js"></script>
<script>
Toastify({
text: "This is a toast",
duration: 3000
}).showToast();
</script>
</body>
</html>
3. 项目的配置文件介绍
Toastify-JS 的配置文件主要是 package.json
和 rollup.config.js
。
package.json
package.json
文件包含了项目的依赖、脚本和其他元数据。以下是一些关键部分:
{
"name": "toastify-js",
"version": "1.11.2",
"description": "Toastify is a lightweight, vanilla JavaScript library for displaying toast notifications.",
"main": "dist/toastify.js",
"scripts": {
"build": "rollup -c",
"watch": "rollup -c -w"
},
"dependencies": {},
"devDependencies": {
"rollup": "^2.3.4",
"rollup-plugin-scss": "^2.6.1",
"rollup-plugin-terser": "^7.0.2"
}
}
rollup.config.js
rollup.config.js
文件是 Rollup 的配置文件,用于打包和压缩源代码。以下是配置文件的主要内容:
import scss from 'rollup-plugin-scss';
import { terser } from 'rollup-plugin-terser';
export default {
input: 'src/toastify.js',
output: {
file: 'dist/toastify.js',
format: 'umd',
name: 'Toastify',
sourcemap: true
},
plugins: [
scss({
output: 'dist/toastify.css',
sourceMap: true
}),
terser()
]
};
通过这些配置文件,可以构建和打包 Toastify-JS 项目,生成最终的 dist
目录下的文件。