@vaadin/vaadin-avatar

<vaadin-avatar>

<vaadin-avatar> is a Web Component providing avatar displaying functionality.

Live Demo ↗ | API documentation ↗

<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>

Installation

Install vaadin-avatar:

npm i @vaadin/vaadin-avatar --save

Once installed, import it in your application:

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

Running API docs and tests in a browser

1. Fork the vaadin-avatar repository and clone it locally.

2. Make sure you have node.js 12.x installed.

3. Make sure you have npm installed.

4. When in the vaadin-avatar directory, run npm install to install dependencies.

5. Run npm start, browser will automatically open the component API documentation.

6. You can also open visual tests, for example:

• http://127.0.0.1:3000/test/visual/default.html

Running tests from the command line

1. When in the vaadin-avatar directory, run npm test

Debugging tests in the browser

1. Run npm run debug, then choose manual mode (M) and open the link in browser.

Following the coding style

We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running npm run lint, which will automatically lint all .js files.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs.

Contributing

To contribute to the component, please read the guideline first.

License

Apache License 2.0

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.