Skip to content

Latest commit

 

History

History
133 lines (76 loc) · 4.47 KB

README.md

File metadata and controls

133 lines (76 loc) · 4.47 KB
Raw

<vaadin-login>

⚠️ 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-login> for the Vaadin versions 10 to 19.

Live Demo ↗ | API documentation ↗

npm version Published on Vaadin Directory Discord

Vaadin Login consists of two components:

<vaadin-login-overlay> is a Web Component providing a painless login experience, part of the Vaadin components. Component shows the <vaadin-login-form> inside of an overlay.

<vaadin-login-overlay opened></vaadin-login-overlay>

Screenshot of vaadin-login-overlay

<vaadin-login-form> is a Web Component providing a form to require users to log in into an application.

<vaadin-login-form></vaadin-login-form>

Installation

The Vaadin components are distributed as Bower and npm packages. Please note that the version range is the same, as the API has not changed. You should not mix Bower and npm versions in the same application, though.

Unlike the official Polymer Elements, the converted Polymer 3 compatible Vaadin components are only published on npm, not pushed to GitHub repositories.

Polymer 2 and HTML Imports compatible version

Install vaadin-login:

bower i vaadin/vaadin-login --save

Once installed, import it in your application:

<link rel="import" href="bower_components/vaadin-login/vaadin-login-overlay.html">

Polymer 3 and ES Modules compatible version

Install vaadin-login:

npm i @vaadin/vaadin-login --save

Once installed, import it in your application:

import '@vaadin/vaadin-login/vaadin-login-overlay.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-login-overlay.html theme/lumo/vaadin-login-form.html

  • The component with the Material theme:

    theme/material/vaadin-login-overlay.html theme/material/vaadin-login-form.html

  • Aliases for lumo themed components:

    vaadin-login-overlay.html vaadin-login-form.html

Running demos and tests in browser

  1. Fork the vaadin-login repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vaadin-login directory, run npm install and then bower install to install dependencies.

  4. Make sure you have polymer-cli installed globally: npm i -g polymer-cli.

  5. Run npm start, browser will automatically open the component API documentation.

  6. You can also open demo or in-browser tests by adding demo or test to the URL, for example:

Running tests from the command line

  1. When in the vaadin-login directory, run polymer test

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 as well as JavaScript snippets inside .html 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.