Skip to content

Commit 1aae5b6

Browse files
Integrated latest changes at 07-24-2024 11:14:16 PM
1 parent 3a59146 commit 1aae5b6

File tree

32 files changed

+149
-152
lines changed

32 files changed

+149
-152
lines changed

ej2-angular/appearance/figma.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,30 @@ documentation: ug
88
domainurl: ##DomainURL##
99
---
1010

11-
# Figma UI Kits for Syncfusion Components
11+
# Figma UI Kits for Syncfusion Angular Components
1212

13-
Syncfusion offers [Figma UI kits](https://www.figma.com/@syncfusion) to facilitate effective collaboration between designers and developers. The Figma UI kits are available in four themes: [Material 3](https://www.figma.com/community/file/1385969023252455137/syncfusion-ui-kit-material-3-theme), [Fluent](https://www.figma.com/community/file/1385969120047188707/syncfusion-ui-kit-fluent-theme), [Tailwind](https://www.figma.com/community/file/1385969065626384098/syncfusion-ui-kit-tailwind-theme), and [Bootstrap 5](https://www.figma.com/community/file/1385968977953858272/syncfusion-ui-kit-bootstrap-5-theme). These kits match the themes used in Syncfusion components.
13+
Syncfusion offers [Figma UI kits](https://www.figma.com/@syncfusion) to facilitate effective collaboration between designers and developers. The Figma UI kits are available in four themes: [Material 3](https://www.figma.com/community/file/1385969023252455137), [Fluent](https://www.figma.com/community/file/1385969120047188707), [Tailwind](https://www.figma.com/community/file/1385969065626384098), and [Bootstrap 5](https://www.figma.com/community/file/1385968977953858272). These kits match the themes used in Syncfusion Angular components.
1414

15-
The kits contain reusable design components with various possible states and variants, along with detailed figures, measurements, and icons, representing the Syncfusion components.
15+
The kits contain reusable design components with various possible states and variants, along with detailed figures, measurements, and icons, representing the Syncfusion Angular components.
1616

1717
![Material 3](./images/material3.png)
1818

1919
## Advantages of UI kits
2020

2121
The Syncfusion Figma UI kit offers the following key advantages:
22-
- The UI kit includes detailed information about Syncfusion components, such as available control lists, their states, and variants. This facilitates a quick understanding of Syncfusion components.
22+
- The UI kit includes detailed information about Syncfusion Angular components, such as available control lists, their states, and variants. This facilitates a quick understanding of Syncfusion Angular components.
2323
- Design components are developed using the [atomic design methodology](https://atomicdesign.bradfrost.com/chapter-2/), making customization straightforward and efficient.
24-
- Developers can seamlessly match Syncfusion components with your design requirements, ensuring alignment and accuracy.
24+
- Developers can seamlessly match Syncfusion Angular components with your design requirements, ensuring alignment and accuracy.
2525
- By using standardized components and themes, the UI kit ensures consistency in your designs, maintaining a uniform look and feel across projects.
2626

2727
## Downloading the UI kits
2828

2929
Syncfusion Figma UI kits are available in the [Figma community](https://www.figma.com/@syncfusion). You can download the Syncfusion theme-specific Figma UI kits from the following links:
3030

31-
- [Material 3](https://www.figma.com/community/file/1385969023252455137/syncfusion-ui-kit-material-3-theme)
32-
- [Fluent](https://www.figma.com/community/file/1385969120047188707/syncfusion-ui-kit-fluent-theme)
33-
- [Tailwind](https://www.figma.com/community/file/1385969065626384098/syncfusion-ui-kit-tailwind-theme)
34-
- [Bootstrap 5](https://www.figma.com/community/file/1385968977953858272/syncfusion-ui-kit-bootstrap-5-theme)
31+
- [Material 3](https://www.figma.com/community/file/1385969023252455137)
32+
- [Fluent](https://www.figma.com/community/file/1385969120047188707)
33+
- [Tailwind](https://www.figma.com/community/file/1385969065626384098)
34+
- [Bootstrap 5](https://www.figma.com/community/file/1385968977953858272)
3535

3636
## Structure of the UI kits
3737

ej2-angular/code-snippet/dialog/getting-started-cs2/src/app.component.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ standalone: true,
2222
<button class="e-control e-btn" id="targetButton" (click)="onOpenDialog($event)">Open Dialog</button>
2323
<ejs-dialog id='dialog' #ejDialog target="#dialog-container" [showCloseIcon]='true' content='This is a Dialog content'
2424
width='350px'>
25-
</ejs-dialog>
25+
</ejs-dialog>
2626
</div>`
2727
})
2828

@@ -32,6 +32,6 @@ export class AppComponent implements OnInit {
3232

3333
// Show the Dialog when click the button
3434
public onOpenDialog = (event: any): void => {
35-
this.ejDialog.show();
35+
this.ejDialog.show();
3636
};
3737
}

ej2-angular/code-snippet/dialog/getting-started-cs3/src/app.component.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ export class AppComponent implements OnInit {
3333

3434
// Show the Dialog when click the button
3535
public onOpenDialog = (event: any): void => {
36-
this.ejDialog.show();
36+
this.ejDialog.show();
3737
};
3838

3939
// Hide the Dialog when click the Dialog overlay
4040
public onOverlayClick() {
41-
this.ejDialog.hide();
41+
this.ejDialog.hide();
4242
}
4343
}

ej2-angular/code-snippet/dialog/getting-started-cs4/src/app.component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ standalone: true,
2828

2929
export class AppComponent implements OnInit {
3030
// Reference the Dialog element
31-
@ViewChild('ejDialog') ejDialog: DialogComponent | any;
31+
@ViewChild('ejDialog') ejDialog: DialogComponent |any;
3232

3333
// Show the Dialog when click the button
3434
public onOpenDialog = (event: any): void => {

ej2-angular/code-snippet/dialog/getting-started-cs5/src/app.component.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ standalone: true,
2323
<button class="e-control e-btn" id="targetButton" (click)="onOpenDialog($event)">Open Dialog</button>
2424
<ejs-dialog id='dialog' #ejDialog target="#dialog-container" header='Dialog' [showCloseIcon]='true' content='This is a Dialog with button and primary button'
2525
width='350px' [buttons]='buttons'>
26-
</ejs-dialog>
26+
</ejs-dialog>
2727
</div>`
2828
})
2929

3030
export class AppComponent implements OnInit {
3131
// Reference the Dialog element
32-
@ViewChild('ejDialog') ejDialog: DialogComponent | any;
32+
@ViewChild('ejDialog') ejDialog: DialogComponent | any;
3333

3434
// Show the Dialog when click the button
3535
public onOpenDialog = (event: any): void => {
@@ -41,7 +41,7 @@ export class AppComponent implements OnInit {
4141
{
4242
'click': this.hideDialog.bind(this),
4343
// Accessing button component properties by buttonModel property
44-
buttonModel: {
44+
buttonModel:{
4545
content: 'OK',
4646
// Enables the primary button
4747
isPrimary: true
@@ -54,9 +54,9 @@ export class AppComponent implements OnInit {
5454
}
5555
}
5656
];
57-
57+
5858
// Hide the Dialog when click the footer button.
5959
public hideDialog() {
6060
this.ejDialog.hide();
61-
}
61+
}
6262
}

ej2-angular/code-snippet/dialog/position-cs1/src/app.component.ts

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23,51 +23,51 @@ standalone: true,
2323
<button class="e-control e-btn" id="targetButton" (click)="onOpenDialog($event)">Open Dialog</button>
2424
<ejs-dialog id='dialog' #ejDialog target="#dialog-container" [position]='position' header='Dialog' [showCloseIcon]='true'
2525
content='This is a Dialog with drag enabled' width='350px'>
26-
<ng-template #header>
26+
<ng-template #header>
2727
<span>Choose a Dialog Position</span>
28-
</ng-template>
29-
<ng-template #content>
30-
<table style="width:320px;padding:18px; padding-top:0px;">
31-
<tr>
28+
</ng-template>
29+
<ng-template #content>
30+
<table style="width:320px;padding:18px; padding-top:0px;">
31+
<tr>
3232
<td><input type="radio" name="xy" (click)="changePosition($event)" value="left top" checked="true">left top
3333
</td>
3434
<td><input type="radio" name="xy" (click)="changePosition($event)" value="center top">center top</td>
3535
<td><input type="radio" name="xy" (click)="changePosition($event)" value="right top">right top</td>
3636
</tr>
3737
<tr>
38-
<td><input type="radio" name="xy" (click)="changePosition($event)" value="left center">left center</td>
39-
<td><input type="radio" name="xy" (click)="changePosition($event)" value="center center">center center</td>
38+
<td><input type="radio" name="xy" (click)="changePosition($event)" value="left center">left center</td>
39+
<td><input type="radio" name="xy" (click)="changePosition($event)" value="center center">center center</td>
4040
<td><input type="radio" name="xy" (click)="changePosition($event)" value="right center">right center</td>
4141
</tr>
4242
<tr>
43-
<td><input type="radio" name="xy" (click)="changePosition($event)" value="left bottom">left bottom</td>
44-
<td><input type="radio" name="xy" (click)="changePosition($event)" value="center bottom">center bottom</td>
45-
<td><input type="radio" name="xy" (click)="changePosition($event)" value="right bottom">right bottom</td>
43+
<td><input type="radio" name="xy" (click)="changePosition($event)" value="left bottom">left bottom</td>
44+
<td><input type="radio" name="xy" (click)="changePosition($event)" value="center bottom">center bottom</td>
45+
<td><input type="radio" name="xy" (click)="changePosition($event)" value="right bottom">right bottom</td>
4646
</tr>
47-
</table>
48-
</ng-template>
49-
<ng-template #footerTemplate>
47+
</table>
48+
</ng-template>
49+
<ng-template #footerTemplate>
5050
<span id="posvalue" style="float:left; padding-left:10px;">Position: "Left", "Top"</span>
51-
</ng-template>
52-
</ejs-dialog>
51+
</ng-template>
52+
</ejs-dialog>
5353
</div>
5454
`
5555
})
5656

5757
export class AppComponent implements OnInit {
5858
// Reference the Dialog element
59-
@ViewChild('ejDialog') ejDialog: DialogComponent | any;
59+
@ViewChild('ejDialog') ejDialog: DialogComponent |any;
6060

61-
// Set Dialog position
62-
public position: object = { X: 'left', Y: 'top' };
61+
// Set Dialog position
62+
public position: object={ X: 'left', Y: 'top' };
6363

6464
// Show the Dialog when click the button
65-
public onOpenDialog = (event: any): void => {
66-
this.ejDialog.show();
65+
public onOpenDialog = (event: any): void => {
66+
this.ejDialog.show();
6767
};
6868

69-
public changePosition = (event: any): void => {
70-
this.ejDialog.position = { X: event.currentTarget.value.split(" ")[0], Y: event.currentTarget.value.split(" ")[1] };
71-
document.getElementById("posvalue")!.innerHTML = 'Position: {X: "' + event.currentTarget.value.split(" ")[0] + '", Y: "' + event.currentTarget.value.split(" ")[1] + '"}';
72-
}
69+
public changePosition = (event: any): void =>{
70+
this.ejDialog.position = { X: event.currentTarget.value.split(" ")[0], Y: event.currentTarget.value.split(" ")[1] };
71+
document.getElementById("posvalue")!.innerHTML = 'Position: {X: "' + event.currentTarget.value.split(" ")[0] + '", Y: "' + event.currentTarget.value.split(" ")[1] + '"}';
72+
}
7373
}

ej2-angular/document-editor/comments.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,28 @@ Document Editor allows you to add comments to documents. You can add, navigate a
1717
Comments can be inserted to the selected text.
1818

1919
```typescript
20-
this.documentEditor.editor.insertComment("Test comment");
20+
this.documentEditor.editor.insertComment('Test comment');
21+
```
22+
23+
## Add a New Comment with Date, Author, and Status
24+
25+
Comments can be inserted into the selected text with a specified date, author, and status.
26+
27+
```typescript
28+
// In this example, a comment with the text "Nancy Davolio" is added by the author Rachel Green on July 23, 2024, at 2:30 PM. The isResolved status is set to false.
29+
30+
// Create a specific date: July 23, 2024, at 2:30:00 PM.
31+
let specificDate = new Date(2024, 6, 23, 14, 30, 0); // Note: July is represented by 6 (0-based index).
32+
33+
// Define the properties of the comment including author, date, and resolution status.
34+
let commentProperties: CommentProperties = {
35+
author: 'Nancy Davolio', // The author of the comment.
36+
dateTime: specificDate, // The date and time when the comment is created.
37+
isResolved: false // The status of the comment; false indicates it is unresolved.
38+
};
39+
40+
// Insert the comment with the specified properties into the document editor.
41+
this.documentEditor.editor.insertComment('Hello world', commentProperties);
2142
```
2243

2344
## Comment navigation
@@ -108,29 +129,9 @@ import { ToolbarService , DocumentEditorSettingsModel } from '@syncfusion/ej2-an
108129
})
109130
export class AppComponent implements OnInit {
110131
public mentionData: any = [
111-
{ "Name": "Selma Rose", "Eimg": "3", "EmailId": "selma@mycompany.com" },
112-
{ "Name": "Russo Kay", "Eimg": "8", "EmailId": "russo@mycompany.com" },
113-
{ "Name": "Camden Kate", "Eimg": "9", "EmailId": "camden@mycompany.com" },
114-
{ "Name": "Mary Kate", "Eimg": "4", "EmailId": "marry@mycompany.com" },
115-
{ "Name": "Ursula Ann", "Eimg": "2", "EmailId": "ursula@mycompany.com" },
116-
{ "Name": "Margaret", "Eimg": "5", "EmailId": "margaret@mycompany.com" },
117-
{ "Name": "Laura Grace", "Eimg": "6", "EmailId": "laura@mycompany.com" },
118-
{ "Name": "Robert", "Eimg": "8", "EmailId": "robert@mycompany.com" },
119-
{ "Name": "Albert", "Eimg": "9", "EmailId": "albert@mycompany.com" },
120-
{ "Name": "Michale", "Eimg": "10", "EmailId": "michale@mycompany.com" },
121-
{ "Name": "Andrew James", "Eimg": "7", "EmailId": "james@mycompany.com" },
122-
{ "Name": "Rosalie", "Eimg": "4", "EmailId": "rosalie@mycompany.com" },
123-
{ "Name": "Stella Ruth", "Eimg": "2", "EmailId": "stella@mycompany.com" },
124-
{ "Name": "Richard Rose", "Eimg": "10", "EmailId": "richard@mycompany.com" },
125-
{ "Name": "Gabrielle", "Eimg": "3", "EmailId": "gabrielle@mycompany.com" },
126-
{ "Name": "Thomas", "Eimg": "7", "EmailId": "thomas@mycompany.com" },
127-
{ "Name": "Charles Danny", "Eimg": "8", "EmailId": "charles@mycompany.com" },
128-
{ "Name": "Daniel", "Eimg": "10", "EmailId": "daniel@mycompany.com" },
129-
{ "Name": "Matthew", "Eimg": "7", "EmailId": "matthew@mycompany.com" },
130-
{ "Name": "Donald Krish", "Eimg": "9", "EmailId": "donald@mycompany.com" },
131-
{ "Name": "Yohana", "Eimg": "1", "EmailId": "yohana@mycompany.com" },
132-
{ "Name": "Kevin Paul", "Eimg": "10", "EmailId": "kevin@mycompany.com" },
133-
{ "Name": "Andrew Fuller", "Eimg": "3", "EmailId": "andrew@mycompany.com"}
132+
{ "Name": "Mary Kate", "EmailId": "marry@company.com" },
133+
{ "Name": "Andrew James", "EmailId": "james@company.com" },
134+
{ "Name": "Andrew Fuller", "EmailId": "andrew@company.com"}
134135
];
135136
public settings: DocumentEditorSettingsModel = { mentionSettings : { dataSource: this.mentionData, fields: { text: 'Name' }} };
136137
ngOnInit(): void {

ej2-angular/gantt/getting-started.md

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -42,26 +42,6 @@ ng add @syncfusion/ej2-angular-gantt --save
4242

4343
> The **--save** will instruct NPM to include the gantt package inside of the `dependencies` section of the `package.json`.
4444
45-
## Registering Gantt Module
46-
47-
Import Gantt module into Angular application(app.module.ts) from the package `@syncfusion/ej2-angular-gantt` [src/app/app.module.ts].
48-
49-
```typescript
50-
import { NgModule } from '@angular/core';
51-
import { BrowserModule } from '@angular/platform-browser';
52-
// import the GanttModule for the Gantt component
53-
import { GanttModule } from '@syncfusion/ej2-angular-gantt';
54-
import { AppComponent } from './app.component';
55-
56-
@NgModule({
57-
//declaration of ej2-angular-gantt module into NgModule
58-
imports: [ BrowserModule, GanttModule ],
59-
declarations: [ AppComponent ],
60-
bootstrap: [ AppComponent ]
61-
})
62-
export class AppModule { }
63-
```
64-
6545
## Adding CSS reference
6646

6747
The following CSS files are available in `../node_modules/@syncfusion` package folder.
@@ -90,11 +70,16 @@ Add the Angular Gantt by using `<ejs-gantt>` selector in `template` section of t
9070

9171
```typescript
9272
import { Component, OnInit } from '@angular/core';
73+
import { GanttModule } from '@syncfusion/ej2-angular-gantt'
9374

9475
@Component({
95-
selector: 'app-root',
96-
// specifies the template string for the Gantt component
97-
template: `<ejs-gantt> </ejs-gantt>`
76+
imports: [
77+
GanttModule
78+
],
79+
standalone: true,
80+
selector: 'app-root',
81+
// specifies the template string for the Gantt component
82+
template: `<ejs-gantt> </ejs-gantt>`
9883
})
9984
export class AppComponent implements OnInit {
10085

@@ -110,17 +95,26 @@ Bind data for the Gantt component by using [`dataSource`](https://ej2.syncfusion
11095
It accepts either array of JavaScript object or `DataManager` instance.
11196

11297
```typescript
113-
import { Component, OnInit } from '@angular/core';
98+
import { GanttModule } from '@syncfusion/ej2-angular-gantt'
99+
import { Component, ViewEncapsulation } from '@angular/core';
114100

115101
@Component({
102+
imports: [
103+
GanttModule
104+
],
105+
106+
standalone: true,
116107
selector: 'app-root',
117-
template: `<ejs-gantt [dataSource]='data'> </ejs-gantt>`
108+
template:
109+
`<ejs-gantt id="ganttDefault" height="430px" [dataSource]="data" [taskFields]="taskSettings" ></ejs-gantt>`,
110+
encapsulation: ViewEncapsulation.None
118111
})
119-
export class AppComponent implements OnInit {
120-
121-
public data: Object[];
112+
export class AppComponent{
113+
// Data for Gantt
114+
public data?: object[];
115+
public taskSettings?: object;
122116

123-
ngOnInit(): void {
117+
public ngOnInit(): void {
124118
this.data = [
125119
{
126120
TaskID: 1,
@@ -145,14 +139,24 @@ export class AppComponent implements OnInit {
145139
]
146140
},
147141
];
142+
this.taskSettings = {
143+
id: 'TaskID',
144+
name: 'TaskName',
145+
startDate: 'StartDate',
146+
endDate: 'EndDate',
147+
duration: 'Duration',
148+
progress: 'Progress',
149+
dependency: 'Predecessor',
150+
child: 'subtasks'
151+
};
148152
}
149153
}
150154

151155
```
152156

153157
## Module injection
154158

155-
The Gantt component was segregated into individual feature-wise modules. To use its feature, you need to inject its feature service in the AppModule.
159+
The Gantt component was segregated into individual feature-wise modules. To use its feature, you need to inject its feature service in the `app.component.ts`.
156160
Find the relevant feature modules and descriptions as follows:
157161

158162
* [`Edit`](https://ej2.syncfusion.com/angular/documentation/api/gantt/#editmodule) : Inject this module to use the editing feature.
@@ -162,21 +166,19 @@ Find the relevant feature modules and descriptions as follows:
162166
* [`Toolbar`](https://ej2.syncfusion.com/angular/documentation/api/gantt/#toolbar) : Inject this module to use the toolbar items.
163167
* [`DayMarkers`](https://ej2.syncfusion.com/angular/documentation/api/gantt/#daymarkersmodule) : Inject this module to highlight the days.
164168

165-
Now, import the above-mentioned modules from the Gantt package and inject them into `provider` section of `AppModule` like following code:
169+
Now, import the above-mentioned modules from the Gantt package and inject them into `provider` section of `app.component.ts` like following code:
166170

167171
```javascript
168-
import { NgModule } from '@angular/core';
169-
import { BrowserModule } from '@angular/platform-browser';
170-
import { AppComponent } from './app.component';
171-
import { GanttComponent, EditService , FilterService, SortService, SelectionService, ToolbarService,DayMarkersService } from '@syncfusion/ej2-angular-gantt';
172+
import { GanttModule } from '@syncfusion/ej2-angular-gantt';
173+
import { Component } from '@angular/core';
174+
import { EditService , FilterService, SortService, SelectionService, ToolbarService, DayMarkersService } from '@syncfusion/ej2-angular-gantt';
172175

173-
@NgModule({
176+
@Component({
174177
imports: [
175-
BrowserModule,
178+
GanttModule
176179
],
177-
declarations: [AppComponent, GanttComponent],
178-
bootstrap: [AppComponent],
179-
providers: [ EditService , FilterService, SortService, SelectionService,ToolbarService,DayMarkersService ]
180+
standalone: true,
181+
providers: [ EditService , FilterService, SortService, SelectionService, ToolbarService, DayMarkersService ]
180182
})
181183

182184
```
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)