{"analyzedAt":"2022-06-25T21:23:57.415Z","collected":{"metadata":{"name":"vue-avatar-upload","scope":"unscoped","version":"1.1.0","description":"A vue3 ts base component for avatar upload and crop","keywords":["vue","vue3","avatar","upload","edit-avatar","ts","头像上传","编辑头像"],"date":"2022-04-16T12:57:36.923Z","author":{"name":"derlan"},"publisher":{"username":"derlan","email":"1372545550@qq.com"},"maintainers":[{"username":"derlan","email":"1372545550@qq.com"}],"repository":{"type":"git","url":"git+https://github.com/derlans/vue-avatar-upload.git"},"links":{"npm":"https://www.npmjs.com/package/vue-avatar-upload","homepage":"https://github.com/derlans/vue-avatar-upload#readme","repository":"https://github.com/derlans/vue-avatar-upload","bugs":"https://github.com/derlans/vue-avatar-upload/issues"},"license":"MIT","devDependencies":{"@antfu/eslint-config":"^0.19.4","@types/node":"^17.0.23","@vitejs/plugin-vue":"^2.3.0","eslint":"^8.12.0","naive-ui":"^2.28.0","sass":"^1.50.0","typescript":"^4.5.4","vite":"^2.9.0","vite-plugin-dts":"^1.0.5","vue":"^3.2.25","vue-tsc":"^0.29.8"},"releases":[{"from":"2022-05-26T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":0},{"from":"2022-03-27T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":13},{"from":"2021-12-27T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":13},{"from":"2021-06-25T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":13},{"from":"2020-06-25T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":13}],"hasSelectiveFiles":true,"readme":"# A vue3 ts base component for avatar upload and crop\n![image](https://github.com/derlans/vue-avatar-upload/blob/master/imgs/preview.gif)\n## how to use\n##[demo](http://avatar-upload.derlan.top/)\n### import\n```\n  import VueAvatarUpload from 'vue-avatar-upload';\n  import 'vue-avatar-upload/lib/style.css';\n```\n```\n  <VueAvatarUpload\n    :url=\"UPLOAD_AVATAR_URL\"\n    :headers=\"headers\"\n    :avatar=\"userStore.avatar\"\n    @error=\"handleError\"\n    v-show=\"show\"\n    @close=\"show = false\"\n    @success=\"handleSuccess\"\n  />\n```\n## Props\n```\ninterface AvatarUploadProps {\n  /**\n   * @description 初始图像src init img src\n   */\n  avatar?: string\n  /**\n   * @description 图片上传地址 upload url\n   */\n  url?: string\n  /**\n   * @description 图片上传字段名 upload field name\n   */\n  field?: string\n  /**\n   * @description 图片上传格式 upload file type\n   */\n  format?: string\n  /**\n   * @description 上传携带请求头 http request headers\n   */\n  headers?: Record<string, string>\n  /**\n   * @description 上传携带其他数据 http request data\n   */\n  data?: Record<string, string>\n  /**\n   * @description 图片框宽度  img box width\n   */\n  width?: number\n  /**\n   * @description 图片框长度  img box height\n   */\n  height?: number\n  /**\n   * @description  选择框初始大小 init select box size\n   */\n  selectSize?: number\n  /**\n   * @description 是否跨域携带携带cookie cross domain with cookie\n   */\n  withCredentials?: boolean\n  /**\n   * @description 上传方法 upload method\n   */\n  method?: 'POST' | 'GET'\n  /**\n   * @description 接受的文件类型 accept file type\n   */\n  accept?: string\n  /**\n   * @description 是否可以旋转 can rotate\n   */\n  rotate?: boolean\n  /**\n   * @description 是否fixed  is fixed\n   */\n  fixed?: boolean\n  /**\n   * @description 是否展示预览 is show preview\n   */\n  showPreview?: boolean\n  /**\n   * @description 预览框大小 preview box size\n   */\n  previewSize?: number\n  /**\n   * @description 自定义文字 i18n\n   */\n  i18?: I18\n  /**\n   * @description 语言 language\n   */\n  lang?: 'zh-CN' | 'zh-TW' | 'en'\n  /**\n   * @description 自定义上传  custom upload\n   */\n  onCustomRequest?: (file: File) => void\n  /**\n   * @description 上传前钩子 返回false可以阻止上传 upload before callback if return false can prevent upload\n   */\n  onBefoureUpload?: (file: File) => boolean | Promise<boolean>\n  /**\n   * @description 上传成功钩子 upload success callback\n   */\n  onSuccess?: (respose: any, file: File) => void\n  /**\n   * @description 上传失败钩子 upload fail callback\n   */\n  onError?: (err: Error, file: File) => void\n  /**\n   * @description 点击关闭按钮 click close button\n   */\n  onClose?: () => void\n}\n```\n### default value\n```\n  url: '',\n  field: 'avatar',\n  width: 300,\n  height: 300,\n  withCredentials: false,\n  selectSize: 300,\n  accept: 'image/*',\n  method: 'POST',\n  fixed: true,\n  rotate: true,\n  format: 'png',\n  lang: 'zh-CN',\n  showPreview: true,\n  previewSize: 100,\n```\n\n## language\nbuilt-in  ``zh-CN``  |  ``zh-TW `` |  ``en``\nyou can use ``lang`` change the language\nor use ``i18`` custom text\n```\ninterface I18 {\n  title: string\n  changeAvatar: string\n  rotate: string\n  preview: string\n  cancel: string\n  confirm: string\n}\n```\n\n## slots\n![image](https://github.com/derlans/vue-avatar-upload/blob/master/imgs/slots.png)"},"npm":{"downloads":[{"from":"2022-06-24T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":0},{"from":"2022-06-18T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":6},{"from":"2022-05-26T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":34},{"from":"2022-03-27T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":586},{"from":"2021-12-27T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":586},{"from":"2021-06-25T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":586}],"starsCount":0},"github":{"starsCount":1,"forksCount":0,"subscribersCount":1,"issues":{"count":0,"openCount":0,"distribution":{"3600":0,"10800":0,"32400":0,"97200":0,"291600":0,"874800":0,"2624400":0,"7873200":0,"23619600":0,"70858800":0,"212576400":0},"isDisabled":false},"contributors":[{"username":"derlans","commitsCount":44}],"commits":[{"from":"2022-06-18T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":0},{"from":"2022-05-26T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":0},{"from":"2022-03-27T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":44},{"from":"2021-12-27T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":44},{"from":"2021-06-25T00:00:00.000Z","to":"2022-06-25T00:00:00.000Z","count":44}]},"source":{"files":{"readmeSize":3367,"testsSize":0},"linters":["eslint"]}},"evaluation":{"quality":{"carefulness":0.9199999999999999,"tests":0,"health":1,"branding":0},"popularity":{"communityInterest":3,"downloadsCount":195.33333333333334,"downloadsAcceleration":0.2944824961948248,"dependentsCount":0},"maintenance":{"releasesFrequency":1,"commitsFrequency":0.8511643835616438,"openIssues":0.7,"issuesDistribution":0.7}},"score":{"final":0.5225716955444999,"detail":{"quality":0.5400461886258112,"popularity":0.03262744292292365,"maintenance":0.9975378112392379}}}