@vaadin/vaadin-avatar
Advanced tools
Comparing version
{ | ||
"name": "@vaadin/vaadin-avatar", | ||
"version": "22.0.0-beta1", | ||
"version": "22.0.0-beta2", | ||
"publishConfig": { | ||
@@ -35,4 +35,4 @@ "access": "public" | ||
"dependencies": { | ||
"@vaadin/avatar": "22.0.0-beta1", | ||
"@vaadin/avatar-group": "22.0.0-beta1" | ||
"@vaadin/avatar": "22.0.0-beta2", | ||
"@vaadin/avatar-group": "22.0.0-beta2" | ||
}, | ||
@@ -44,3 +44,3 @@ "devDependencies": { | ||
}, | ||
"gitHead": "4cf8a9d0504994200c610e44b3676114fef49c1e" | ||
"gitHead": "f13833683e6667f6ca6678452db14aa6b7eac4a4" | ||
} |
@@ -1,67 +0,10 @@ | ||
# <vaadin-avatar> | ||
# @vaadin/vaadin-avatar | ||
[<vaadin-avatar>](https://vaadin.com/components/vaadin-avatar) is a Web Component providing avatar displaying functionality. | ||
> ⚠️ Starting from Vaadin 22, this package is deprecated. | ||
> Please use [`@vaadin/avatar`](https://www.npmjs.com/package/@vaadin/avatar) and [`@vaadin/avatar-group`](https://www.npmjs.com/package/@vaadin/avatar-group) instead. | ||
[Live Demo ↗](https://vaadin.com/components/vaadin-avatar/html-examples) | ||
| | ||
[API documentation ↗](https://vaadin.com/components/vaadin-avatar/html-api) | ||
A web component for graphical representation of an object or entity, for example a person or an organization. | ||
[](https://www.npmjs.com/package/@vaadin/vaadin-avatar) | ||
[](https://vaadin.com/directory/component/vaadinvaadin-avatar) | ||
[](https://discord.gg/PHmkCKC) | ||
[Documentation + Live Demo ↗](https://vaadin.com/docs/latest/ds/components/avatar) | ||
```html | ||
<vaadin-avatar></vaadin-avatar> | ||
<vaadin-avatar name="Jens Jansson"></vaadin-avatar> | ||
<vaadin-avatar abbr="SK"></vaadin-avatar> | ||
<vaadin-avatar-group max="2"></vaadin-avatar-group> | ||
<script> | ||
document.querySelector('vaadin-avatar-group').items = [ | ||
{ name: 'Foo Bar', colorIndex: 1 }, | ||
{ colorIndex: 2 }, | ||
{ name: 'Foo Bar', colorIndex: 3 } | ||
]; | ||
</script> | ||
``` | ||
[<img src="https://raw.githubusercontent.com/vaadin/vaadin-avatar/master/screenshot.png" width="200" alt="Screenshot of vaadin-avatar">](https://vaadin.com/components/vaadin-avatar) | ||
## Installation | ||
Install `vaadin-avatar`: | ||
```sh | ||
npm i @vaadin/vaadin-avatar --save | ||
``` | ||
Once installed, import it in your application: | ||
```js | ||
import '@vaadin/vaadin-avatar/vaadin-avatar.js'; | ||
import '@vaadin/vaadin-avatar/vaadin-avatar-group.js'; | ||
``` | ||
## Getting started | ||
Vaadin components use the Lumo theme by default. | ||
To use the Material theme, import the correspondent file from the `theme/material` folder. | ||
## Entry points | ||
- The components with the Lumo theme: | ||
`theme/lumo/vaadin-avatar.js` | ||
`theme/lumo/vaadin-avatar-group.js` | ||
- The components with the Material theme: | ||
`theme/material/vaadin-avatar.js` | ||
`theme/material/vaadin-avatar-group.js` | ||
- Alias for `theme/lumo/vaadin-avatar.js` `theme/lumo/vaadin-avatar-group.js`: | ||
`vaadin-avatar.js` | ||
`vaadin-avatar-group.js` | ||
## Contributing | ||
@@ -75,2 +18,3 @@ | ||
Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics. | ||
Vaadin collects usage statistics at development time to improve this product.. | ||
For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics. |
15053
-9.55%20
-73.68%+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
Updated