Skip to content

Commit

Permalink
update: added info for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
yashrajbharti committed Aug 7, 2024
1 parent 2905702 commit 68a65b1
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Creating stylish randomly colored pearl using the power of html web components

## Install from npm

```
```console
npm i random-color-pearl
```

Expand Down Expand Up @@ -44,20 +44,20 @@ Then simply use the web component as:

> Supports three optional attributes, height and width for sizing the svg, and a username attribute to get a hashed color (optional). Also, it has getter and setter methods for color. Colors attribute is a string of 15 hex color codes.
| Attribute | Description | Default |
| ---------- | --------------------------------------------------- | --------- |
| `width` | Sets the width of the SVG element | `92px` |
| `height` | Sets the height of the SVG element | `92px` |
| `username` | If provided, hashes the username to generate colors | Undefined |
| `colors` | If provided, fills the svg with the given colors | Undefined |
| Attribute | Description | Default |
| ---------- | --------------------------------------------------- | ----------- |
| `width` | Sets the width of the SVG element | `92px` |
| `height` | Sets the height of the SVG element | `92px` |
| `username` | If provided, hashes the username to generate colors | `undefined` |
| `colors` | If provided, fills the svg with the given colors | `undefined` |

## Set the Color Values

```html
<random-color-svg colors="#000000,#1c1c1c,#333333,#4d4d4d,#666666,#808080,#999999,#b3b3b3,#cccccc,#e6e6e6,#f2f2f2,#f5f5f5,#fafafa,#dcdcdc,#c0c0c0"></random-color-svg>
```

> ⚠️ Note: this will not set the color values if `username` is provided already. As basic purpose of profile pic/ avatar is to set using `username` attribute, it has preference over the `colors` string.
> ⚠️ Note: this will not set the color values if `username` is provided already. As basic purpose of profile pic/ avatar is to set unique pearls using `username` attribute, it has preference over the `colors` string.
## Get the Color values

Expand Down

0 comments on commit 68a65b1

Please sign in to comment.