This repository has been deprecated. Please find the latest code here: https://github.com/vaadin-component-factory/avatar
<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>
The Vaadin Incubator components are distributed as Bower packages.
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">
Vaadin components use the Lumo theme by default.
-
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
-
Fork the
incubator-avatar
repository and clone it locally. -
Make sure you have npm installed.
-
When in the
incubator-avatar
directory, runnpm install
and thenbower install
to install dependencies. -
Run
polymer serve --open
, browser will automatically open the component API documentation. -
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
- When in the
incubator-avatar
directory, runpolymer test
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.
- 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
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.