Easy-Circular-Progress 项目使用教程
1. 项目的目录结构及介绍
easy-circular-progress/
├── dist/
│ ├── easy-circular-progress.css
│ ├── easy-circular-progress.js
│ └── easy-circular-progress.min.js
├── examples/
│ ├── basic.html
│ ├── custom-color.html
│ ├── custom-size.html
│ └── index.html
├── src/
│ ├── components/
│ │ └── EasyCircularProgress.vue
│ ├── index.js
│ └── main.js
├── .all-contributorsrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── webpack.config.js
目录结构介绍
- dist/: 打包后的文件,包括CSS和JS文件。
- examples/: 示例文件,展示组件的不同用法。
- src/: 源代码文件夹,包含组件和入口文件。
- components/: 组件文件夹,包含
EasyCircularProgress.vue
组件。 - index.js: 入口文件,导出组件。
- main.js: 主文件,用于示例。
- components/: 组件文件夹,包含
- .all-contributorsrc: 贡献者配置文件。
- .gitignore: Git忽略文件配置。
- .npmignore: NPM忽略文件配置。
- .travis.yml: Travis CI 配置文件。
- LICENSE: 项目许可证。
- README.md: 项目说明文档。
- package.json: 项目依赖和脚本配置。
- webpack.config.js: Webpack 配置文件。
2. 项目的启动文件介绍
项目的启动文件主要是 src/main.js
和 src/index.js
。
src/main.js
import Vue from 'vue';
import App from './App.vue';
import EasyCircularProgress from './components/EasyCircularProgress.vue';
Vue.component('easy-circular-progress', EasyCircularProgress);
new Vue({
render: h => h(App),
}).$mount('#app');
src/index.js
import EasyCircularProgress from './components/EasyCircularProgress.vue';
export default EasyCircularProgress;
3. 项目的配置文件介绍
package.json
{
"name": "easy-circular-progress",
"version": "1.0.4",
"description": "easy circular progress component with counting effect",
"main": "dist/easy-circular-progress.js",
"scripts": {
"build": "webpack --config webpack.config.js",
"example": "webpack-dev-server --config webpack.config.js --content-base examples/"
},
"dependencies": {
"vue": "^2.6.10"
},
"devDependencies": {
"webpack": "^4.39.3",
"webpack-cli": "^3.3.8",
"webpack-dev-server": "^3.8.0"
},
"repository": {
"type": "git",
"url": "git+https://github.com/dreambo8563/easy-circular-progress.git"
},
"keywords": [
"vue",
"circular",
"progress",
"component"
],
"author": "dreambo8563",
"license": "MIT",
"bugs": {
"url": "https://github.com/dreambo8563/easy-circular-progress/issues"
},
"homepage": "https://github.com/dreambo8563/easy-circular-progress#readme"
}
webpack.config.js
const path = require('path');
module.exports = {
entry: './src/index.js',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'easy-circular-progress.js',
libraryTarget: 'umd',