{"analyzedAt":"2022-07-05T23:27:50.978Z","collected":{"metadata":{"name":"@singleway/avatars-generator","scope":"singleway","version":"0.0.8","description":"This is a port from  Sketch library [Avataaars](https://avataaars.com/) designed by [Pablo Stanley](https://twitter.com/pablostanley).","keywords":["vue avatar","avatar","avatars","editor","vue3","vue3js","vue3-js","component"],"date":"2021-11-15T06:22:48.570Z","author":{"name":"Tony Wang","email":"netspecters@gmail.com"},"publisher":{"username":"intellegence_inc","email":"paralegdev@gmail.com"},"maintainers":[{"username":"intellegence_inc","email":"paralegdev@gmail.com"}],"links":{"npm":"https://www.npmjs.com/package/%40singleway%2Favatars-generator"},"license":"MIT","dependencies":{"lodash":"^4.17.21","vue":"^3.2.16"},"devDependencies":{"@rollup/plugin-typescript":"^8.3.0","@types/lodash":"^4.14.176","@types/node":"^16.11.7","@vitejs/plugin-vue":"^1.9.3","tslib":"^2.3.1","typescript":"^4.4.3","vite":"^2.6.4","vue-tsc":"^0.3.0"},"bundledDependencies":false,"releases":[{"from":"2022-06-05T00:00:00.000Z","to":"2022-07-05T00:00:00.000Z","count":0},{"from":"2022-04-06T00:00:00.000Z","to":"2022-07-05T00:00:00.000Z","count":1},{"from":"2022-01-06T00:00:00.000Z","to":"2022-07-05T00:00:00.000Z","count":1},{"from":"2021-07-05T00:00:00.000Z","to":"2022-07-05T00:00:00.000Z","count":10},{"from":"2020-07-05T00:00:00.000Z","to":"2022-07-05T00:00:00.000Z","count":10}],"hasSelectiveFiles":true,"readme":"# Vue component for Avatars\nThis is a port from  Sketch library [Avataaars](https://avataaars.com/) designed by [Pablo Stanley](https://twitter.com/pablostanley). \n\n## Features\n - SVG based\n - Light weight\n - Scalable\n - Easy to use\n - Easy to integrate with custom editor\n - Comes from [Avataaars](https://avataaars.com/)\n\n#### How it works\n\nImport the Avataaars component. Pass it an object called \"avatarOptions\" with some parameters. Let the magic happen.\n\n## Installation\n```\nnpm install @singleway/avatars-generator --save\n```\n\n## Usage\n\n- Using the Avataaars component with an avatarOptions input :\n```html\n  <template>\n    <Avataaars \n    // You can set any size as it does not exceed the maxWidth and maxHeight properties (264px by 280px)\n    :width=200\n    :height=200\n    // Your avatar options\n    :avatarOptions=\"{\n      backgroundType: selectedBackgroundType,\n      backgroundColor: selectedBackgroundColor,\n      skinColor: selectedSkinColor,\n      clothesType: selectedClothesType,\n      clothesColor: selectedClothesColor,\n      clothesGraphicsType: selectedClothesGraphicType,\n      eyesType: selectedEyesType,\n      eyebrowType: selectedEyebrowType,\n      mouthType: selectedMouthType,\n      facialHairType: selectedFacialHairType,\n      facialHairColor: selectedFacialHairColor,\n      accessoriesType: selectedAccessoriesType,\n      topType: selectedTopType,\n      topColor: selectedTopColor,\n    }\" />\n  </template>\n\n  <script>\n  import Avataaars from 'vue-avataaars'\n\n  export default {\n    name: 'Your component',\n    components: {\n      Avataaars,\n    },\n  </script>\n```\n\n- Using the Avataaars for random avatar generation :\n```html\n  <template>\n    // No props, no problems\n    <Avataaars />\n  </template>\n  \n  <script>\n  import Avataaars from 'vue-avataaars'\n\n  export default {\n    name: 'Your component',\n    components: {\n      Avataaars,\n    },\n  </script>\n```\n\n## Props for the Avataaars component\n```html\n    iconName: {\n      type: String,\n      default: 'avatar',\n      required: false,\n    },\n    width: {\n      type: Number,\n      default: 264,\n      required: false,\n    },\n    height: {\n      type: Number,\n      default: 280,\n      required: false,\n    },\n    avatarOptions: {\n      type: Object, required: false\n    },\n```\n\n## Props of avatarOptions\nA complete list of every options can be found here in the \"./scr/avataaarsOptions.json\""},"npm":{"downloads":[{"from":"2022-07-04T00:00:00.000Z","to":"2022-07-05T00:00:00.000Z","count":7},{"from":"2022-06-28T00:00:00.000Z","to":"2022-07-05T00:00:00.000Z","count":10},{"from":"2022-06-05T00:00:00.000Z","to":"2022-07-05T00:00:00.000Z","count":13},{"from":"2022-04-06T00:00:00.000Z","to":"2022-07-05T00:00:00.000Z","count":84},{"from":"2022-01-06T00:00:00.000Z","to":"2022-07-05T00:00:00.000Z","count":159},{"from":"2021-07-05T00:00:00.000Z","to":"2022-07-05T00:00:00.000Z","count":497}],"starsCount":0},"source":{"files":{"readmeSize":2377,"testsSize":0}}},"evaluation":{"quality":{"carefulness":0.39499999999999996,"tests":0,"health":1,"branding":0},"popularity":{"communityInterest":0,"downloadsCount":28,"downloadsAcceleration":-0.35165525114155255,"dependentsCount":0},"maintenance":{"releasesFrequency":0.6707191780821918,"commitsFrequency":0,"openIssues":0,"issuesDistribution":0}},"score":{"final":0.24838095623323175,"detail":{"quality":0.43159186142029565,"popularity":0.006390660401361198,"maintenance":0.3333333333333333}}}