@avyn/initials-avatar-react 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# @avyn/initials-avatar-react
|
|
2
|
+
|
|
3
|
+
React wrapper around `@avyn/initials-avatar`. Fully typed, renders as `<img>` (data URI) or inline SVG.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
```bash
|
|
7
|
+
npm install @avyn/initials-avatar-react
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
```tsx
|
|
12
|
+
import { InitialsAvatar } from '@avyn/initials-avatar-react';
|
|
13
|
+
|
|
14
|
+
export function ProfileAvatar() {
|
|
15
|
+
return (
|
|
16
|
+
<InitialsAvatar
|
|
17
|
+
name="Ada Lovelace"
|
|
18
|
+
size={96}
|
|
19
|
+
backgroundColor="#111827"
|
|
20
|
+
fontColor="#f8fafc"
|
|
21
|
+
borderRadius={16}
|
|
22
|
+
bold
|
|
23
|
+
/>
|
|
24
|
+
);
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Props
|
|
29
|
+
All core avatar options plus:
|
|
30
|
+
- `name` (string, required)
|
|
31
|
+
- `as` (`'img' | 'svg'`, default `'img'`)
|
|
32
|
+
- `className`, `style`, `title`
|
|
33
|
+
- `imgProps`, `svgProps` (passed through)
|
|
34
|
+
|
|
35
|
+
## Core engine
|
|
36
|
+
Provided by peer dependency `@avyn/initials-avatar`.
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@avyn/initials-avatar-react",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "React component wrapper for @avyn/initials-avatar",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.cjs",
|
|
7
|
-
"module": "dist/index.
|
|
7
|
+
"module": "dist/index.js",
|
|
8
8
|
"types": "dist/index.d.ts",
|
|
9
9
|
"exports": {
|
|
10
10
|
".": {
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"react": "^18.0.0 || ^19.0.0"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@avyn/initials-avatar": "1.0.
|
|
27
|
+
"@avyn/initials-avatar": "1.0.2"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"tsup": "^8.2.4",
|