JSPM

@vaadin/vaadin-custom-field

21.0.0-alpha1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 9131
  • Score
    100M100P100Q146103F
  • License Apache-2.0

vaadin-custom-field

Package Exports

  • @vaadin/vaadin-custom-field
  • @vaadin/vaadin-custom-field/src/vaadin-custom-field.js
  • @vaadin/vaadin-custom-field/theme/lumo/vaadin-custom-field.js
  • @vaadin/vaadin-custom-field/theme/material/vaadin-custom-field.js
  • @vaadin/vaadin-custom-field/vaadin-custom-field
  • @vaadin/vaadin-custom-field/vaadin-custom-field.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vaadin/vaadin-custom-field) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

<vaadin-custom-field>

<vaadin-custom-field> is a Web Component providing field wrapper functionality, part of the Vaadin components.

Live Demo ↗ | API documentation ↗

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

<vaadin-custom-field label="Appointment time">
  <vaadin-date-picker></vaadin-date-picker>
  <vaadin-time-picker></vaadin-time-picker>
</vaadin-custom-field>

Screenshot of vaadin-custom-field

Installation

Install vaadin-custom-field:

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

Once installed, import it in your application:

import '@vaadin/vaadin-custom-field/vaadin-custom-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 component with the Lumo theme:

    theme/lumo/vaadin-custom-field.js

  • The component with the Material theme:

    theme/material/vaadin-custom-field.js

  • Alias for theme/lumo/vaadin-custom-field.js:

    vaadin-custom-field.js

Running API docs and tests in a browser

  1. Fork the vaadin-custom-field 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-custom-field directory, run npm install to install dependencies.

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

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

  7. You can also open visual tests, for example:

Running tests from the command line

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

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.