@vaadin-component-factory/vcf-spreadsheet-light

Web Component providing basic functionalities of a spreadsheet.


Keywords
Vaadin, vaadin-incubator-element, vaadin-component-factory, vcf-spreadsheet-light, web-components, web-component, polymer
License
MIT-feh
Install
npm install @vaadin-component-factory/vcf-spreadsheet-light@1.0.2

Documentation

<vcf-spreadsheet-light>

Live Demo ↗

<vcf-spreadsheet-light> is a Web Component providing basic functionalities of an spreadsheet.

  <vcf-spreadsheet-light col-count="5" height="700px">
  </vcf-spreadsheet-light>

Screenshot of vcf-spreadsheet-light

Installation

The Vaadin Component Factory components are distributed as Bower packages.

Polymer 2 and HTML Imports compatible version

Install vcf-spreadsheet-light:

bower i vaadin/vcf-spreadsheet-light --save

Once installed, import it in your application:

<link rel="import" href="bower_components/vcf-spreadsheet-light/vcf-spreadsheet-light.html">

Getting Started

Vaadin components use the Lumo theme by default.

The file structure for Vaadin components

  • src/vcf-spreadsheet-light.html

    Unstyled component.

  • theme/lumo/vcf-spreadsheet-light.html

    Component with Lumo theme.

  • vcf-spreadsheet-light.html

    Alias for theme/lumo/vcf-spreadsheet-light.html

Running demos and tests in browser

  1. Fork the vcf-spreadsheet-light repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vcf-spreadsheet-light directory, run npm install and then bower install to install dependencies.

  4. Run polymer serve --open, 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:

Running tests from the command line

  1. When in the vcf-spreadsheet-light 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 gulp lint, which will automatically lint all .js files as well as JavaScript snippets inside .html files.

Contributing

  • Make sure your code is compliant with our code linters: gulp lint
  • Check that tests are passing: polymer test
  • Submit a pull request with detailed title and description
  • Wait for response from one of Vaadin components team members

License

Apache License 2.0