Directory

cargowebcomponents - Vaadin Add-on Directory

Collection of Web Components based on Polymer 3 cargowebcomponents - Vaadin Add-on Directory
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/@cargowebserver/cargowebcomponents/elements) # Cargo Web Components A usefull collection of Web Components based on polymer 3. ## Installation To append compoments to your application all you need to do is... ```console npm install --save @cargowebserver/cargowebcomponents ``` ## Usage Webcomponents are a fast and easy way to create web application. Because each component are self contain, it's easy to make it work with each other. Just like any other HTML elements, components can be stylized at the application level, in order to give them a uniform look and feel. Cargo Web Component are based on Polymer 3 and try to follow the material design principles. ## Quick start ## Welcome to Cargo Web Components Here I will explain to you all the steps to made use of components. ### Dependencies I order to create a web application you will need: * NPM * Node.js ### Step by Step #### Create a new folder for your project ```console mkdir test cd test ``` #### Initilayse your package file ```console npm init ``` #### Append the components and other depencies in your file. ```console npm install --save @cargowebserver/cargowebcomponents ``` #### now append your element in the html file where you want to use it (index.html)... ##### The Growl... ```html I am growl! ``` ##### The application menu, more than a dropdown... ```html item 0 item 1 item 2 item 4 item 3 ``` ##### A sortable and filtrable table that can became quite large in number of elements without laging... ```html
Col 1
Col 2
Col 3
Col 4
Col 5
``` #### (for local use) intall the polymer client utilities ```console sudo npm install -g polymer-cli ``` #### finaly serve it ```console polymer server --npm ``` #### For include the result in IIS or [CargoWebServer](https://github.com/CargoWebServer/CargoWebServer), for exemple, you need to build your project, that will create a build directory that contain all neccessary file. ```console polymer build ``` ## History Cargo Web Components were part of Cargo Web Server project [can see list here](https://github.com/CargoWebServer/CargoWebServer/tree/master/WebApp/Cargo/Apps/Cargo/js/gui). here is the list of components that will be rewritten as webcomponent... * [growl](https://github.com/davecourtois/cargowebcomponents/tree/master/components/growl) (in process) * splitter * dialog * menu * table * wizard * object panel ## Credits Written by Dave Courtois. ## License Apache License 2.0 (Apache-2.0)