Deprecated

This repository has been deprecated. Please find the latest code here: https://github.com/vaadin-component-factory/avatar

<incubator-avatar>

Live Demo ↗

<incubator-avatar> is a Web Component displaying user's avatar, his name or a placeholder icon.

  <incubator-avatar abbr="BJ" name="Ben Jones" image="https://unsplash.it/500/500?random">
  </incubator-avatar>

Installation

The Vaadin Incubator components are distributed as Bower packages.

Polymer 2 and HTML Imports compatible version

Install incubator-avatar:

bower i vaadin/incubator-avatar --save

Once installed, import it in your application:

<link rel="import" href="bower_components/incubator-avatar/incubator-avatar.html">

Getting Started

Vaadin components use the Lumo theme by default.

The file structure for Vaadin components

• src/incubator-avatar.html

  Unstyled component.

• theme/lumo/incubator-avatar.html

  Component with Lumo theme.

• incubator-avatar.html

  Alias for theme/lumo/incubator-avatar.html

Running demos and tests in browser

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

2. Make sure you have npm installed.

3. When in the incubator-avatar directory, run npm install and then bower install to install dependencies.

4. Run polymer serve --open, browser will automatically open the component API documentation.

5. You can also open demo or in-browser tests by adding demo or test to the URL, for example:

• http://127.0.0.1:8080/components/incubator-avatar/demo
• http://127.0.0.1:8080/components/incubator-avatar/test

Running tests from the command line

1. When in the incubator-avatar directory, run polymer test

Following the coding style

We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running gulp lint, which will automatically lint all .js files as well as JavaScript snippets inside .html files.

Contributing

• Make sure your code is compliant with our code linters: gulp lint
• Check that tests are passing: polymer test
• Submit a pull request with detailed title and description
• Wait for response from one of Vaadin components team members

License

Commercial Vaadin Add-on License version 3 (CVALv3). For license terms, see LICENSE.

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