Skip to content

Commit fe97d0c

Browse files
994681: Updated Sample for Default Settings, Edit and Style Form Fields
1 parent 4cc4c18 commit fe97d0c

39 files changed

+1404
-0
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
dist/
2+
node_modules/
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Essential JS 2 QuickStart
2+
3+
This project is a skeleton application used to create [Essential JS 2](https://www.syncfusion.com/products/essential-js2) web application.
4+
5+
>This application uses the latest version of the [webpack-cli](https://webpack.js.org/api/cli/#commands). It requires node `v14.15.0` or higher.
6+
7+
## Getting Started
8+
9+
To get started you need to clone the `ej2-quickstart` repository and navigate to `ej2-quickstart` location.
10+
11+
```
12+
git clone https://github.com/syncfusion/ej2-quickstart.git quickstart
13+
cd quickstart
14+
```
15+
16+
## Installing
17+
18+
We can get all the Essential JS 2 components in a single npm package [`ej2`](https://www.npmjs.com/package/@syncfusion/ej2).
19+
20+
We already configure the required packages in the `package.json` file.
21+
22+
You can run the below command to install all dependent packages related to this seed project.
23+
24+
```
25+
npm install
26+
```
27+
28+
## Testing
29+
30+
This application is preconfigured with End-to-End testing and the test case is written in Jasmine.
31+
32+
We run the test scripts with [Protractor](http://www.protractortest.org/#/) end-to-end test runner. The test case file can be found in the `e2e` folder.
33+
34+
Protractor can interact with our web application and verify the test scripts.
35+
36+
We have to install WebDriver and also need to ensure it is updated. Open a separate terminal and run the below npm script.
37+
38+
```
39+
npm run update-webdriver
40+
```
41+
42+
Open another terminal and run the below npm script. It will start web server to serve our application.
43+
44+
```
45+
npm run serve
46+
```
47+
48+
Once the web server is up and running, we can run the end-to-end tests using the below npm script
49+
50+
```
51+
npm run test
52+
```
53+
54+
> **Note:** Since Protractor is using the Selenium Standalone Server, the Java Development Kit (JDK) need to be installed in your local machine.
55+
56+
If JDK is not installed in your local machine, you can download it from [here](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
57+
58+
## Running
59+
60+
The application is configured with [webpack-dev-server](https://webpack.js.org/configuration/dev-server/#devserver), so it will serve the web application in your default browser.
61+
62+
We have used [Webpack](https://github.com/webpack/webpack) for module loading.
63+
64+
You can use the below npm script to run the web application.
65+
66+
```
67+
npm run start
68+
```
69+
70+
## Resources
71+
72+
You can also refer the below resources to know more details about Essential JS 2 components.
73+
74+
* [Pure JS Demos](http://ej2.syncfusion.com/demos/)
75+
* [Pure JS Documentation](http://ej2.syncfusion.com/documentation/)

Form Designer/Configure Default Setting for Form Fields/e2e/index.spec.js

Whitespace-only changes.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
exports.config = {
2+
3+
allScriptsTimeout: 11000,
4+
5+
capabilities: {
6+
'browserName': 'chrome'
7+
},
8+
9+
framework: 'jasmine',
10+
11+
jasmineNodeOpts: {
12+
defaultTimeoutInterval: 10000
13+
},
14+
directConnect: true,
15+
16+
onPrepare: function() {
17+
browser.waitForAngularEnabled(false);
18+
},
19+
20+
specs: ['./*.spec.js']
21+
};
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
'use strict';
2+
3+
var gulp = require('gulp');
4+
5+
/**
6+
* Compile TypeScript to JS
7+
*/
8+
gulp.task('compile', function (done) {
9+
var webpack = require('webpack');
10+
var webpackStream = require('webpack-stream');
11+
gulp.src(['./src/app/app.ts']).pipe(webpackStream({
12+
config: require('./webpack.config.js')
13+
}, webpack))
14+
.pipe(gulp.dest('./dist'))
15+
.on('end', function () {
16+
done();
17+
});
18+
});
19+
20+
/**
21+
* Testing spec files
22+
*/
23+
var protractor = require('gulp-protractor').protractor;
24+
var webdriver_standalone = require('gulp-protractor').webdriver_standalone;
25+
var webdriver_update = require('gulp-protractor').webdriver_update_specific;
26+
27+
gulp.task('e2e-serve', webdriver_standalone);
28+
29+
gulp.task('e2e-webdriver-update', webdriver_update({
30+
webdriverManagerArgs: ['--ie', '--edge']
31+
}));
32+
33+
gulp.task('e2e-test', gulp.series('compile', function (done) {
34+
var browserSync = require('browser-sync');
35+
var bs = browserSync.create('Essential JS 2');
36+
var options = {
37+
server: {
38+
baseDir: [
39+
'./dist/',
40+
],
41+
directory: true
42+
},
43+
ui: false,
44+
open: false,
45+
notify: false
46+
};
47+
bs.init(options, function () {
48+
gulp.src(['./spec/**/*.spec.js'])
49+
.pipe(protractor({
50+
configFile: 'e2e/protractor.conf.js'
51+
}))
52+
.on('error', function (e) {
53+
console.error('Error: ' + e.message);
54+
done();
55+
process.exit(1);
56+
})
57+
.on('end', function () {
58+
done();
59+
process.exit(0);
60+
});
61+
});
62+
}));
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Essential JS 2 library is available under the Syncfusion Essential Studio program, and can be licensed either under the Syncfusion Community License Program or the Syncfusion commercial license.
2+
3+
To be qualified for the Syncfusion Community License Program you must have a gross revenue of less than one (1) million U.S. dollars ($1,000,000.00 USD) per year and have less than five (5) developers in your organization, and agree to be bound by Syncfusion’s terms and conditions.
4+
5+
Customers who do not qualify for the community license can contact sales@syncfusion.com for commercial licensing options.
6+
7+
Under no circumstances can you use this product without (1) either a Community License or a commercial license and (2) without agreeing and abiding by Syncfusion’s license containing all terms and conditions.
8+
9+
The Syncfusion license that contains the terms and conditions can be found at
10+
https://www.syncfusion.com/content/downloads/syncfusion_license.pdf
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"name": "ej2-quickstart",
3+
"version": "0.0.1",
4+
"description": "Essential JS 2 typescript quick start application",
5+
"author": "Syncfusion Inc.",
6+
"license": "SEE LICENSE IN license",
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/syncfusion/ej2-quickstart.git"
10+
},
11+
"scripts": {
12+
"start": "webpack-dev-server --mode development",
13+
"build": "webpack --mode production",
14+
"serve": "gulp e2e-serve",
15+
"test": "gulp e2e-test",
16+
"update-webdriver": "gulp e2e-webdriver-update"
17+
},
18+
"devDependencies": {
19+
"ajv": "^8.11.2",
20+
"browser-sync": "^2.18.12",
21+
"gulp": "*",
22+
"typescript": "*",
23+
"gulp-protractor": "*",
24+
"gulp-typescript": "*",
25+
"jasmine": "^2.6.0",
26+
"css-loader": "^6.7.2",
27+
"ts-loader": "^9.4.1",
28+
"mini-css-extract-plugin": "^2.7.0",
29+
"html-webpack-plugin": "^5.5.0",
30+
"webpack": "^5.75.0",
31+
"webpack-cli": "^5.0.0",
32+
"webpack-dev-server": "^5.2.1",
33+
"webpack-stream": "^7.0.0"
34+
},
35+
"dependencies": {
36+
"@syncfusion/ej2": "*"
37+
}
38+
}
Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
import {
2+
PdfViewer, Toolbar, Magnification, Navigation, Annotation, LinkAnnotation, ThumbnailView,
3+
BookmarkView, TextSelection, TextSearch, FormFields, FormDesigner,
4+
FontStyle, DisplayMode
5+
} from '@syncfusion/ej2-pdfviewer';
6+
7+
PdfViewer.Inject(
8+
Toolbar, Magnification, Navigation, Annotation, LinkAnnotation, ThumbnailView,
9+
BookmarkView, TextSelection, TextSearch, FormFields, FormDesigner
10+
);
11+
12+
// Initialize viewer
13+
const pdfviewer: PdfViewer = new PdfViewer();
14+
pdfviewer.documentPath = 'https://cdn.syncfusion.com/content/pdf/form-designer.pdf';
15+
pdfviewer.resourceUrl = 'https://cdn.syncfusion.com/ej2/31.1.23/dist/ej2-pdfviewer-lib';
16+
pdfviewer.appendTo('#PdfViewer');
17+
18+
// Common options used by list-like fields
19+
const listOptions = [
20+
{ itemName: 'item1', itemValue: 'item1' },
21+
{ itemName: 'item2', itemValue: 'item2' },
22+
{ itemName: 'item3', itemValue: 'item3' }
23+
];
24+
25+
/* Textbox defaults */
26+
pdfviewer.textFieldSettings = {
27+
name: 'Textbox',
28+
isReadOnly: false,
29+
visibility: 'visible',
30+
isRequired: false,
31+
isPrint: true,
32+
tooltip: 'Textbox',
33+
thickness: 4,
34+
value: 'Textbox',
35+
fontFamily: 'Courier',
36+
fontSize: 10,
37+
fontStyle: FontStyle.None,
38+
color: 'black',
39+
borderColor: 'black',
40+
backgroundColor: 'White',
41+
alignment: 'Left',
42+
maxLength: 0,
43+
isMultiline: false
44+
};
45+
46+
/* Password defaults */
47+
pdfviewer.passwordFieldSettings = {
48+
name: 'Password',
49+
isReadOnly: false,
50+
visibility: 'visible',
51+
isRequired: false,
52+
isPrint: true,
53+
tooltip: 'Password',
54+
thickness: 4,
55+
value: 'Password',
56+
fontFamily: 'Courier',
57+
fontSize: 10,
58+
fontStyle: FontStyle.None,
59+
color: 'black',
60+
borderColor: 'black',
61+
backgroundColor: 'white',
62+
alignment: 'Left',
63+
maxLength: 0
64+
};
65+
66+
/* CheckBox defaults */
67+
pdfviewer.checkBoxFieldSettings = {
68+
name: 'CheckBox',
69+
isReadOnly: false,
70+
visibility: 'visible',
71+
isRequired: false,
72+
isPrint: true,
73+
tooltip: 'CheckBox',
74+
thickness: 4,
75+
isChecked: true,
76+
backgroundColor: 'white',
77+
borderColor: 'black'
78+
};
79+
80+
/* RadioButton defaults */
81+
pdfviewer.radioButtonFieldSettings = {
82+
name: 'RadioButton',
83+
isReadOnly: false,
84+
visibility: 'visible',
85+
isRequired: false,
86+
isPrint: true,
87+
tooltip: 'RadioButton',
88+
thickness: 4,
89+
isSelected: true,
90+
backgroundColor: 'white',
91+
borderColor: 'black',
92+
value: 'RadioButton'
93+
};
94+
95+
/* ListBox defaults */
96+
pdfviewer.listBoxFieldSettings = {
97+
name: 'ListBox',
98+
isReadOnly: false,
99+
visibility: 'visible',
100+
isRequired: false,
101+
isPrint: true,
102+
tooltip: 'ListBox',
103+
thickness: 4,
104+
value: 'ListBox',
105+
fontFamily: 'Courier',
106+
fontSize: 10,
107+
fontStyle: FontStyle.None,
108+
color: 'black',
109+
borderColor: 'black',
110+
backgroundColor: 'White',
111+
alignment: 'Left',
112+
options: listOptions
113+
};
114+
115+
/* DropDown defaults
116+
Note: DropDown uses listBoxFieldSettings for defaults */
117+
pdfviewer.DropdownFieldSettings = {
118+
name: 'Dropdown',
119+
isReadOnly: false,
120+
visibility: 'visible',
121+
isRequired: false,
122+
isPrint: true,
123+
tooltip: 'ListBox',
124+
thickness: 4,
125+
value: 'ListBox',
126+
fontFamily: 'Courier',
127+
fontSize: 10,
128+
fontStyle: FontStyle.None,
129+
color: 'black',
130+
borderColor: 'black',
131+
backgroundColor: 'White',
132+
alignment: 'Left',
133+
options: listOptions
134+
};
135+
136+
/* Signature defaults */
137+
pdfviewer.signatureFieldSettings = {
138+
name: 'Signature',
139+
isReadOnly: false,
140+
visibility: 'visible',
141+
isRequired: false,
142+
isPrint: true,
143+
tooltip: 'Signature',
144+
thickness: 4,
145+
signatureDialogSettings: {
146+
displayMode: DisplayMode.Draw | DisplayMode.Upload | DisplayMode.Text,
147+
hideSaveSignature: false
148+
},
149+
signatureIndicatorSettings: {
150+
opacity: 1,
151+
backgroundColor: '#237ba2',
152+
height: 50,
153+
fontSize: 15,
154+
text: 'Signature Field',
155+
color: 'white'
156+
}
157+
};
158+
159+
/* Initial defaults */
160+
pdfviewer.initialFieldSettings = {
161+
name: 'Initial',
162+
isReadOnly: false,
163+
visibility: 'visible',
164+
isRequired: false,
165+
isPrint: true,
166+
tooltip: 'Initial',
167+
thickness: 4,
168+
initialIndicatorSettings: {
169+
opacity: 1,
170+
backgroundColor: '#237ba2',
171+
height: 50,
172+
fontSize: 15,
173+
text: 'Initial Field',
174+
color: 'white'
175+
},
176+
initialDialogSettings: {
177+
displayMode: DisplayMode.Draw | DisplayMode.Upload | DisplayMode.Text,
178+
hideSaveSignature: false
179+
}
180+
};

0 commit comments

Comments
 (0)