@vaadin/vaadin-messages

vaadin-messages

Usage no npm install needed!

<script type="module">
  import vaadinVaadinMessages from 'https://cdn.skypack.dev/@vaadin/vaadin-messages';
</script>

README

<vaadin-message-list>

⚠️ Starting from Vaadin 20, the source code and issues for this component are migrated to the vaadin/web-components monorepository. This repository contains the source code and releases of <vaadin-message-list> for the Vaadin versions 10 to 19.

<vaadin-message-list> is a Web Component for showing a list of messages, part of the Vaadin components.

Live demo and examples ↗ | API documentation ↗

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

<vaadin-message></vaadin-message>
<vaadin-message foo="bar"></vaadin-message>

Screenshot of vaadin-message

Installation

Install vaadin-messages:

npm i @vaadin/vaadin-messages --save

Once installed, import it in your application:

import '@vaadin/vaadin-messages/vaadin-message.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 component with the Lumo theme:

    theme/lumo/vaadin-message.js

  • The component with the Material theme:

    theme/material/vaadin-message.js

  • Alias for theme/lumo/vaadin-message.js:

  • vaadin-message.js

Running API docs and tests in a browser

  1. Fork the vaadin-messages 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-messages 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:

  • http://localhost:8000/test/visual/default.html

Running tests from the command line

  1. When in the vaadin-messages 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.