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="Price"></vaadin-number-field>
<vaadin-integer-field label="Count" has-controls></vaadin-integer-field>
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';
import '@vaadin/vaadin-text-field/vaadin-integer-field.js';
Vaadin components use the Lumo theme by default.
To use the Material theme, import the correspondent file from the theme/material
folder.
-
The components with the Lumo theme:
theme/lumo/vaadin-text-field.js
theme/lumo/vaadin-text-area.js
theme/lumo/vaadin-password-field.js
theme/lumo/vaadin-email-field.js
theme/lumo/vaadin-number-field.js
theme/lumo/vaadin-integer-field.js
-
The components with the Material theme:
theme/material/vaadin-text-field.js
theme/material/vaadin-text-area.js
theme/material/vaadin-password-field.js
theme/material/vaadin-email-field.js
theme/material/vaadin-number-field.js
theme/material/vaadin-integer-field.js
-
Aliases for
theme/lumo/vaadin-text-field.js
theme/lumo/vaadin-text-area.js
theme/lumo/vaadin-password-field.js
theme/lumo/vaadin-email-field.js
theme/lumo/vaadin-number-field.js
theme/lumo/vaadin-integer-field.js
:vaadin-text-field.js
vaadin-text-area.js
vaadin-password-field.js
vaadin-email-field.js
vaadin-number-field.js
vaadin-integer-field.js
-
Fork the
vaadin-text-field
repository and clone it locally. -
Make sure you have node.js 12.x installed.
-
Make sure you have npm installed.
-
When in the
vaadin-text-field
directory, runnpm install
to install dependencies. -
Run
npm start
, browser will automatically open the component API documentation. -
You can also open visual tests, for example:
- When in the
vaadin-text-field
directory, runnpm test
- Run
npm run debug
, then choose manual mode (M) and open the link in browser.
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.
Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs.
To contribute to the component, please read the guideline first.
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.