lion/packages/input-email/README.md
Thomas Allmer 396deb2e3b feat: finalize validation and adopt it everywhere
Co-authored-by: Alex Ghiu <alex.ghiu@ing.com>
Co-authored-by: Gerjan van Geest <Gerjan.van.Geest@ing.com>
Co-authored-by: Thijs Louisse <Thijs.Louisse@ing.com>
Co-authored-by: Joren Broekema <joren.broekema@ing.com>
Co-authored-by: Erik Kroes <erik.kroes@ing.com>
2019-11-18 15:30:08 +01:00

32 lines
721 B
Markdown

# Input Email
[//]: # 'AUTO INSERT HEADER PREPUBLISH'
`lion-input-email` component is based on the generic text input field. Its purpose is to provide a way for users to fill in an email.
## Features
- based on [lion-input](../input)
- makes use of email [validators](../validate/docs/ValidationSystem.md) with corresponding error messages in different languages
- IsEmail (default)
## How to use
### Installation
```sh
npm i --save @lion/input-email
```
```js
import '@lion/input-email/lion-input-email.js';
// validator import example
import { Required } from '@lion/validate';
```
### Example
```html
<lion-input-email label="email" name="email" .validators="${['new Required()]}"></lion-input-email>
```