@avyn/initials-avatar-vue 1.0.0 → 1.0.1
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 +35 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# @avyn/initials-avatar-vue
|
|
2
|
+
|
|
3
|
+
Vue 3 wrapper around `@avyn/initials-avatar`. Fully typed component plus plugin.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
```bash
|
|
7
|
+
npm install @avyn/initials-avatar-vue
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
```ts
|
|
12
|
+
import { createApp } from 'vue';
|
|
13
|
+
import { InitialsAvatarPlugin, InitialsAvatar } from '@avyn/initials-avatar-vue';
|
|
14
|
+
|
|
15
|
+
const app = createApp(App);
|
|
16
|
+
app.use(InitialsAvatarPlugin);
|
|
17
|
+
app.component('InitialsAvatar', InitialsAvatar);
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
In template:
|
|
21
|
+
```html
|
|
22
|
+
<InitialsAvatar name="Grace Hopper" :size="80" background-color="#0f172a" font-color="#e2e8f0" />
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Props
|
|
26
|
+
All core avatar options plus:
|
|
27
|
+
- `name` (string, required)
|
|
28
|
+
- `as` (`'img' | 'svg'`, default `'img'`)
|
|
29
|
+
- `title`
|
|
30
|
+
|
|
31
|
+
## Core engine
|
|
32
|
+
Provided by peer dependency `@avyn/initials-avatar`.
|
|
33
|
+
|
|
34
|
+
## License
|
|
35
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@avyn/initials-avatar-vue",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Vue 3 component wrapper for @avyn/initials-avatar",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.cjs",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"vue": "^3.3.0"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@avyn/initials-avatar": "1.0.
|
|
27
|
+
"@avyn/initials-avatar": "1.0.1"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"tsup": "^8.2.4",
|