|
7 | 7 | [API documentation ↗](https://vaadin.com/components/vaadin-avatar/html-api) |
8 | 8 |
|
9 | 9 | [](https://www.npmjs.com/package/@vaadin/vaadin-avatar) |
10 | | -[](https://www.webcomponents.org/element/vaadin/vaadin-avatar) |
11 | | -[](https://travis-ci.org/vaadin/vaadin-avatar) |
12 | 10 | [](https://vaadin.com/directory/component/vaadinvaadin-avatar) |
13 | | -[](https://vaadin.com/directory/component/vaadinvaadin-avatar) |
14 | 11 | [](https://discord.gg/PHmkCKC) |
15 | 12 |
|
16 | 13 | ```html |
|
20 | 17 | <vaadin-avatar-group max="2"></vaadin-avatar-group> |
21 | 18 | <script> |
22 | 19 | document.querySelector('vaadin-avatar-group').items = [ |
23 | | - {name: 'Foo Bar', colorIndex: 1}, |
24 | | - {colorIndex: 2}, |
25 | | - {name: 'Foo Bar', colorIndex: 3} |
| 20 | + { name: 'Foo Bar', colorIndex: 1 }, |
| 21 | + { colorIndex: 2 }, |
| 22 | + { name: 'Foo Bar', colorIndex: 3 } |
26 | 23 | ]; |
27 | 24 | </script> |
28 | 25 | ``` |
29 | 26 |
|
30 | 27 | [<img src="https://raw.githubusercontent.com/vaadin/vaadin-avatar/master/screenshot.png" width="200" alt="Screenshot of vaadin-avatar">](https://vaadin.com/components/vaadin-avatar) |
31 | 28 |
|
32 | | - |
33 | 29 | ## Installation |
34 | 30 |
|
35 | 31 | Install `vaadin-avatar`: |
@@ -68,46 +64,9 @@ To use the Material theme, import the correspondent file from the `theme/materia |
68 | 64 | `vaadin-avatar.js` |
69 | 65 | `vaadin-avatar-group.js` |
70 | 66 |
|
71 | | - |
72 | | -## Running API docs and tests in a browser |
73 | | - |
74 | | -1. Fork the `vaadin-avatar` repository and clone it locally. |
75 | | - |
76 | | -1. Make sure you have [node.js](https://nodejs.org/) 12.x installed. |
77 | | - |
78 | | -1. Make sure you have [npm](https://www.npmjs.com/) installed. |
79 | | - |
80 | | -1. When in the `vaadin-avatar` directory, run `npm install` to install dependencies. |
81 | | - |
82 | | -1. Run `npm start`, browser will automatically open the component API documentation. |
83 | | - |
84 | | -1. You can also open visual tests, for example: |
85 | | - |
86 | | - - http://127.0.0.1:3000/test/visual/default.html |
87 | | - |
88 | | - |
89 | | -## Running tests from the command line |
90 | | - |
91 | | -1. When in the `vaadin-avatar` directory, run `npm test` |
92 | | - |
93 | | -## Debugging tests in the browser |
94 | | - |
95 | | -1. Run `npm run debug`, then choose manual mode (M) and open the link in browser. |
96 | | - |
97 | | -## Following the coding style |
98 | | - |
99 | | -We are using [ESLint](http://eslint.org/) 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. |
100 | | - |
101 | | - |
102 | | -## Big Thanks |
103 | | - |
104 | | -Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com). |
105 | | - |
106 | | - |
107 | 67 | ## Contributing |
108 | 68 |
|
109 | | -To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first. |
110 | | - |
| 69 | +Read the [contributing guide](https://vaadin.com/docs/latest/guide/contributing/overview) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components. |
111 | 70 |
|
112 | 71 | ## License |
113 | 72 |
|
|
0 commit comments