https://github.com/vaadin-component-factory/vcf-avatar
https://github.com/vaadin-component-factory/vcf-avatar
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vaadin-component-factory/vcf-avatar
- Owner: vaadin-component-factory
- License: other
- Created: 2019-04-25T10:37:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-25T13:19:43.000Z (over 6 years ago)
- Last Synced: 2025-01-10T00:36:33.037Z (12 months ago)
- Language: HTML
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/vaadin/vcf-avatar)
[](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
# <vcf-avatar>
[Live Demo ↗](https://incubator.app.fi/vcf-avatar-demo/index.html)
[<vcf-avatar>](https://vaadin.com/directory/component/vcf-avatar) is a Web Component displaying user's avatar, his name or a placeholder icon.
```html
```
[
](https://vaadin.com/directory/component/vcf-avatar)
## Installation
The Vaadin component factory components are distributed as Bower packages.
### Polymer 2 and HTML Imports compatible version
Install `vcf-avatar`:
```sh
bower i vaadin/vcf-avatar --save
```
Once installed, import it in your application:
```html
```
## Getting Started
Vaadin components use the Lumo theme by default.
## The file structure for Vaadin components
- `src/vcf-avatar.html`
Unstyled component.
- `theme/lumo/vcf-avatar.html`
Component with Lumo theme.
- `vcf-avatar.html`
Alias for theme/lumo/vcf-avatar.html
## Running demos and tests in browser
1. Fork the `vcf-avatar` repository and clone it locally.
1. Make sure you have [npm](https://www.npmjs.com/) installed.
1. When in the `vcf-avatar` directory, run `npm install` and then `bower install` to install dependencies.
1. Run `polymer serve --open`, browser will automatically open the component API documentation.
1. 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/vcf-avatar/demo
- http://127.0.0.1:8080/components/vcf-avatar/test
## Running tests from the command line
1. When in the `vcf-avatar` directory, run `polymer test`
## Following the coding style
We are using [ESLint](http://eslint.org/) 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](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) 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.