Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@dicebear/avatars-bottts-sprites
Advanced tools
@dicebear/avatars-bottts-sprites - npm Package Compare versions
Comparing version 4.4.1 to 4.5.0
| { | ||
| "name": "@dicebear/avatars-bottts-sprites", | ||
| "version": "4.4.1", | ||
| "version": "4.5.0", | ||
| "description": "Bottts sprite collection for DiceBear Avatars", | ||
@@ -34,3 +34,3 @@ "main": "lib/index.js", | ||
| "devDependencies": { | ||
| "@dicebear/avatars": "^4.4.1" | ||
| "@dicebear/avatars": "^4.5.0" | ||
| }, | ||
@@ -44,3 +44,3 @@ "files": [ | ||
| }, | ||
| "gitHead": "4ab5c14eccea0dd919eb543feecf6ed9d3563740" | ||
| "gitHead": "707740b414e0407b660a35976d9ceaa9d3d09854" | ||
| } |
@@ -1,77 +0,24 @@ | ||
|  | ||
| <h1 align="center"><img src="https://avatars.dicebear.com/api/bottts/1.svg" width="124" /> <br />bottts</h1> | ||
| <p align="center"> | ||
| <strong>Avatar Style for <a href="https://avatars.dicebear.com/">DiceBear Avatars</a>.</strong><br /> | ||
| Designed by <a href="https://twitter.com/pablostanley">Pablo Stanley</a>. The Sketch library can be found on | ||
| <a href="https://bottts.com/">bottts.com</a>. | ||
| </p> | ||
|  | ||
| [](https://www.npmjs.com/package/@dicebear/avatars-bottts-sprites) | ||
| <p align="center"> | ||
| <a href="https://github.com/dicebear/avatars/blob/master/LICENSE" target="_blank"> | ||
| <img src="https://img.shields.io/github/license/dicebear/avatars.svg?style=flat-square" alt="License"> | ||
| </a> | ||
| <a href="https://www.npmjs.com/package/@dicebear/avatars-bottts-sprites" target="_blank-sprites"> | ||
| <img src="https://img.shields.io/npm/v/@dicebear/avatars-bottts-sprites.svg?style=flat-square" alt="Latest Version"> | ||
| </a> | ||
| <a href="https://github.com/dicebear/avatars/stargazers" target="_blank"> | ||
| <img src="https://img.shields.io/github/stars/dicebear/avatars?style=flat-square" alt="Stargazers"> | ||
| </a> | ||
| </p> | ||
| Designed by [Pablo Stanley](https://twitter.com/pablostanley), the Sketch library can be found on | ||
| [bottts.com](https://bottts.com/). | ||
| <p> | ||
| <img src="https://avatars.dicebear.com/api/bottts/1.svg" width="60" /> | ||
| <img src="https://avatars.dicebear.com/api/bottts/2.svg" width="60" /> | ||
| <img src="https://avatars.dicebear.com/api/bottts/3.svg" width="60" /> | ||
| <img src="https://avatars.dicebear.com/api/bottts/4.svg" width="60" /> | ||
| <img src="https://avatars.dicebear.com/api/bottts/5.svg" width="60" /> | ||
| <img src="https://avatars.dicebear.com/api/bottts/6.svg" width="60" /> | ||
| <img src="https://avatars.dicebear.com/api/bottts/7.svg" width="60" /> | ||
| <img src="https://avatars.dicebear.com/api/bottts/8.svg" width="60" /> | ||
| <img src="https://avatars.dicebear.com/api/bottts/9.svg" width="60" /> | ||
| <p align="center"> | ||
| <a href="https://avatars.dicebear.com/styles/bottts"> | ||
| Read Documentation | ||
| </a> | ||
| </p> | ||
| ## Usage | ||
| ### HTTP-API (recommended) | ||
| Our free HTTP-API is the easiest way to use this sprite collection. Just use the following URL as image source. | ||
| https://avatars.dicebear.com/api/bottts/:seed.svg | ||
| The value of `:seed` can be anything you like - but **don't** use any sensitive or personal data here! | ||
| #### Examples | ||
| | preview | url | | ||
| | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | ||
| | <img src="https://avatars.dicebear.com/api/bottts/example.svg" width="60" /> | https://avatars.dicebear.com/api/bottts/example.svg | | ||
| | <img src="https://avatars.dicebear.com/api/bottts/example.svg?options[colors][]=cyan" width="60" /> | https://avatars.dicebear.com/api/bottts/example.svg?options[colors][]=cyan | | ||
| | <img src="https://avatars.dicebear.com/api/bottts/example.svg?options[colors][]=cyan&options[primaryColorLevel]=200" width="60" /> | https://avatars.dicebear.com/api/bottts/example.svg?options[colors][]=cyan&options[primaryColorLevel]=200 | | ||
| ### NPM | ||
| Install the Avatars and this sprite collection with the following command. | ||
| npm install --save @dicebear/avatars @dicebear/avatars-bottts-sprites | ||
| Now you are ready to create your first Avatar. | ||
| ```js | ||
| import Avatars from '@dicebear/avatars'; | ||
| import sprites from '@dicebear/avatars-bottts-sprites'; | ||
| let avatars = new Avatars(sprites()); | ||
| let svg = avatars.create('custom-seed'); | ||
| ``` | ||
| ## Options | ||
| | name | alias | type | default | description | | ||
| | ------------------- | ----- | ---------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | radius | r | number | `0` | Avatar border radius | | ||
| | base64 | | bool | `false` | Return avatar as base64 data uri instead of XML <br> **Not supported by the HTTP API** | | ||
| | width | w | number | `null` | Fixed width | | ||
| | height | h | number | `null` | Fixed height | | ||
| | margin | m | number | `0` | Avatar margin in percent<br> **HTTP-API limitation** Max value `25` | | ||
| | background | b | string | `null` | Any valid color identifier<br> **HTTP-API limitation** Only hex _(3-digit, 6-digit and 8-digit)_ values are allowed. Use url encoded hash: `%23`. | | ||
| | userAgent | | string | `window.navigator.userAgent` | User-Agent for legacy browser fallback<br> **Automatically detected by the HTTP API** | | ||
| | colors | | array of strings | `null` | Possible values: `amber`, `blue`, `blueGrey`, `brown`, `cyan`, `deepOrange`, `deepPurple`, `green`, `grey`, `indigo`, `lightBlue`, `lightGreen`, `lime`, `orange`, `pink`, `purple`, `red`, `teal`, `yellow` | | ||
| | primaryColorLevel | | number | `600` | Possible values: `50`, `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900` | | ||
| | secondaryColorLevel | | number | `400` | Possible values: `50`, `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900` | | ||
| | colorful | | boolean | `false` | Assigns sides and top a random secondary color | | ||
| | mouthChance | | number | `100` | Probability in percent avatar will have a mouth | | ||
| | sidesChance | | number | `100` | Probability in percent avatar will have side elements | | ||
| | textureChance | | number | `50` | Probability in percent avatar will have texture | | ||
| | topChance | | number | `100` | Probability in percent avatar will have a top element | | ||
| ## Further information | ||
| You can find the DiceBear Avatars documentation at [avatars.dicebear.com](https://avatars.dicebear.com) |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-3.78%
179249
- Number of lines in readme file
- decreased by-67.95%
25
No dependency changes