Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@vaadin/vaadin-avatar

Package Overview
Dependencies
Maintainers
18
Versions
246
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@vaadin/vaadin-avatar

vaadin-avatar

  • 20.0.0-alpha1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
7.7K
increased by0.74%
Maintainers
18
Weekly downloads
 
Created
Source

<vaadin-avatar>

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

Live Demo ↗ | API documentation ↗

npm version Published on webcomponents.org Build Status Published on Vaadin Directory Stars on vaadin.com/directory Discord

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

Screenshot of vaadin-avatar

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:

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.

Keywords

FAQs

Package last updated on 12 Mar 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc