documentation/getting-started/getting-started-libraries.asciidoc


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

---
title: Vaadin Libraries
order: 20
layout: page
---

[[getting-started.libraries]]
= Vaadin Libraries

Vaadin Framework comes as a set of library JARs, of which some are optional or alternative
ones, depending on whether you are developing server-side or client-side
applications, whether you use add-on components, or use CSS or Sass themes.

[filename]#vaadin-server-8.x.x.jar#::
The main library for developing server-side Vaadin applications, as described in
<<dummy/../../../framework/application/application-overview.asciidoc#application.overview,"Writing a Server-Side Web Application">>.
It requires the [filename]#vaadin-shared# and the [filename]#vaadin-themes# libraries.
You can use the pre-built [filename]#vaadin-client-compiled# for server-side development, unless you need add-on components or custom widgets.

[filename]#vaadin-themes-8.x.x.jar#::
Vaadin Framework built-in themes both as SCSS source files and precompiled CSS files.
The library is required both for basic use with CSS themes and for compiling custom Sass themes.

[filename]#vaadin-push-8.x.x.jar#::
The implementation of server push for Vaadin Framework.
This is needed for web applications which use server push (e.g. using the @Push annotation in a Servlet class).

[filename]#vaadin-shared-8.x.x.jar#::
A shared library for server-side and client-side development.
It is always needed.

[filename]#vaadin-client-compiled-8.x.x.jar#::
A pre-compiled Vaadin Client-Side Engine (widget set) that includes all the basic built-in widgets in Vaadin.
This library is not needed if you compile the application widget set with the Vaadin Client Compiler.

[filename]#vaadin-client-8.x.x.jar#::
The client-side Vaadin Framework, including the basic GWT API and Vaadin-specific widgets and other additions.
It is required when using the [filename]#vaadin-client-compiler# to compile client-side modules.
It is not needed if you just use the server-side framework with the pre-compiled Client-Side Engine.
You should not deploy it with a web application.

[filename]#vaadin-client-compiler-8.x.x.jar#::
The Vaadin Client Compiler is a Java-to-JavaScript compiler that allows building client-side modules, such as the Client-Side Engine (widget set) required for server-side applications.
The compiler is needed, for example, for compiling add-on components to the application widget set, as described in <<dummy/../../../framework/addons/addons-overview.asciidoc#addons.overview,"Using Vaadin Add-ons">>.
+
For detailed information regarding the compiler, see
<<dummy/../../../framework/clientside/clientside-compiling#clientside.compiling,"Compiling a Client-Side Module">>.
Note that you should not deploy this library with a web application.

[filename]#vaadin-compatibility-*-8.x.x.jar#::
The Vaadin Framework 7 compatibility packages contain the components and themes that are present in framework version 7, but not in version 8. These packages exist for making it easier to migrate from version 7 to 8. There is a compatibility package for everything except [filename]#vaadin-client-compiler#.

Some of the libraries depend on each other, for instance [filename]#vaadin-shared# is included as a dependency of [filename]#vaadin-server#.

The different ways to install the libraries are described in the subsequent sections.

Note that the [filename]#vaadin-client-compiler# and [filename]#vaadin-client# JARs should not be deployed with the web application. The Maven scope [filename]#provided# can be used.
Some other libraries, such as [filename]#vaadin-sass-compiler#, are not needed in production deployment.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

/**
 * @copyright 2018 Julius Härtl <jus@bitgrid.net>
 *
 * @author 2018 Julius Härtl <jus@bitgrid.net>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

const helper = require('../helper.js');
const config = require('../config.js');

describe('install', function () {

	before(async () => await helper.init(this));
	after(async () => await helper.exit());

	config.resolutions.forEach(function (resolution) {
		it('show-page.' + resolution.title, async function () {
			// (test, route, prepare, action, options
			return helper.takeAndCompare(this, 'index.php', async (page) => {
				await helper.delay(100);
				await page.$eval('body', function (e) {
					$('#adminlogin').blur();
				});
				await helper.delay(100);
			}, { waitUntil: 'networkidle0', viewport: resolution});
		});

		it('show-advanced.' + resolution.title, async function () {
			// (test, route, prepare, action, options
			return helper.takeAndCompare(this, undefined, async (page) => {
				await page.click('#showAdvanced');
				await helper.delay(300);
			}, { waitUntil: 'networkidle0', viewport: resolution});
		});
		it('show-advanced-mysql.' + resolution.title, async function () {
			// (test, route, prepare, action, options
			return helper.takeAndCompare(this, undefined, async (page) => {
				await page.click('label.mysql');
				await helper.delay(300);
			}, { waitUntil: 'networkidle0', viewport: resolution});
		});
	});

	it('runs', async function () {
		this.timeout(5*60*1000);
		helper.pageBase.setDefaultNavigationTimeout(5*60*1000);
		helper.pageCompare.setDefaultNavigationTimeout(5*60*1000);
		// just run for one resolution since we can only install once
		return helper.takeAndCompare(this, 'index.php',  async function (page) {
			const login = await page.type('#adminlogin', 'admin');
			const password = await page.type('#adminpass', 'admin');
			const inputElement = await page.$('input[type=submit]');
			await inputElement.click();
			await page.waitForNavigation({waitUntil: 'networkidle2'});
			await page.waitForSelector('#header');
			helper.pageBase.setDefaultNavigationTimeout(60000);
			helper.pageCompare.setDefaultNavigationTimeout(60000);
		}, { waitUntil: 'networkidle0', viewport: {w: 1920, h: 1080}});
	});

});