vaadin-text-field

The themable Web Component providing input controls. Part of the Vaadin components.

View larger

Close

<vaadin-text-field>

Live Demo ↗ | API documentation ↗

<vaadin-text-field> is a themable Web Component providing input controls in forms, part of the Vaadin components.

<vaadin-text-field label="Username"></vaadin-text-field>
<vaadin-password-field label="Password"></vaadin-password-field>
<vaadin-text-area label="Description"></vaadin-text-area>
<vaadin-email-field label="Email"></vaadin-email-field>
<vaadin-number-field label="Count" has-controls></vaadin-number-field>

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-text-field:

bower i vaadin/vaadin-text-field --save

Once installed, import the components you need in your application:

<link rel="import" href="bower_components/vaadin-text-field/vaadin-text-field.html">
<link rel="import" href="bower_components/vaadin-text-field/vaadin-text-area.html">
<link rel="import" href="bower_components/vaadin-text-field/vaadin-password-field.html">
<link rel="import" href="bower_components/vaadin-text-field/vaadin-email-field.html">
<link rel="import" href="bower_components/vaadin-text-field/vaadin-number-field.html">

Polymer 3 and ES Modules Compatible Version

Install vaadin-text-field:

npm i @vaadin/vaadin-text-field --save

Once installed, import the components you need in your application:

import '@vaadin/vaadin-text-field/vaadin-text-field.js';
import '@vaadin/vaadin-text-field/vaadin-text-area.js';
import '@vaadin/vaadin-text-field/vaadin-password-field.js';
import '@vaadin/vaadin-text-field/vaadin-email-field.js';
import '@vaadin/vaadin-text-field/vaadin-number-field.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-text-field.html theme/lumo/vaadin-text-area.html theme/lumo/vaadin-password-field.html theme/lumo/vaadin-email-field.html theme/lumo/vaadin-number-field.html

• The components with the Material theme:

  theme/material/vaadin-text-field.html theme/material/vaadin-text-area.html theme/material/vaadin-password-field.html theme/material/vaadin-email-field.html theme/material/vaadin-number-field.html

• Aliases for theme/lumo/vaadin-text-field.html theme/lumo/vaadin-text-area.html theme/lumo/vaadin-password-field.html theme/lumo/vaadin-email-field.html theme/lumo/vaadin-number-field.html:

  vaadin-text-field.html vaadin-text-area.html vaadin-password-field.html vaadin-email-field.html vaadin-number-field

Running demos and tests in a browser

1. Fork the vaadin-text-field repository and clone it locally.

2. Make sure you have npm and Bower installed.

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

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

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

• http://127.0.0.1:3000/components/vaadin-text-field/demo
• http://127.0.0.1:3000/components/vaadin-text-field/test

Running tests from the command line

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

Links

• Issue tracker
• View on NPM
• View on GitHub
• Online Demo
• GitHub Homepage

Compatibility