Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.4 KB

README.md

File metadata and controls

66 lines (43 loc) · 2.4 KB
Raw

<vcf-enhanced-dialog>

Gitter npm version Published on Vaadin Directory

<vcf-enhanced-dialog> is a Web Component for creating customized modal dialogs.

This is an extension of <vaadin-dialog> that adds the following features:

  • Header and footer sections.
  • Scrollable content area.
  • Size themes.

Screenshot for Vaadin Component Factory enhanced dialog

Live demo ↗ | API documentation ↗

Installation

Install vcf-enhanced-dialog:

npm i @vaadin-component-factory/vcf-enhanced-dialog --save

Usage

Once installed, import it in your application:

import '@vaadin-component-factory/vcf-enhanced-dialog';

Add <vcf-enhanced-dialog> element to the page. Use a <template> or renderer function to add content to the dialog.

<vcf-enhanced-dialog>
  <template>
    <h2 slot="header">Header</h2>
    <p>...</p>
    <vaadin-button slot="footer" onclick="cancel()">Cancel</vaadin-button>
  </template>
</vcf-enhanced-dialog>

Running demo

  1. Fork the vcf-enhanced-dialog repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vcf-enhanced-dialog directory, run npm install to install dependencies.

  4. Run npm start to open the demo.

Server-side API

This is the client-side (Polymer 3) web component. If you are looking for the server-side (Java) API for the Vaadin Platform, it can be found here: Enhanced Dialog

License

Apache License 2.0