Skip to content

Commit 546e9ea

Browse files
ajithrajithr
authored
Update ReadMe.md
1 parent 57c4bc7 commit 546e9ea

File tree

1 file changed

+322
-9
lines changed

1 file changed

+322
-9
lines changed

‎ReadMe.md‎

Lines changed: 322 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,346 @@
1+
# Syncfusion JavaScript UI Controls samples
12

3+
This repository contains the demos of [Syncfusion JavaScript UI Controls](https://www.syncfusion.com/javascript-ui-controls?utm_medium=listing&utm_source=github&utm_campaign=ej2-samples). This is the best place to check our controls to get more insight about the usage of APIs. You can also check our controls by installing out click once samples, in which you can browse the demo for all the controls.
24

3-
## Installing
5+
This section guides you to use the Syncfusion JavaScript UI Controls samples in your applications.
6+
7+
* [Requirements to run the demo](#requirements-to-run-the-demo)
8+
* [Documentation](#documentation)
9+
* [License](#license)
10+
* [Using the samples](#using-the-samples)
11+
* [Controls Catalog](#controls-catalog)
12+
* [Support and Feedback](#support-and-feedback)
13+
14+
## Requirements to run the demo
15+
16+
The samples requires the below requirements to run.
17+
18+
* [Node.js](https://nodejs.org/en/)
19+
20+
## Documentation
21+
22+
All controls documentation for the Syncfusion UI controls can be found on [Syncfusion Help](https://ej2.syncfusion.com/documentation/?utm_source=github&utm_medium=listing&utm_campaign=ej2-samples). All API documentation can be found at the [API Reference](https://ej2.syncfusion.com/documentation/api?utm_source=github&utm_medium=listing&utm_campaign=ej2-samples).
23+
24+
## License
25+
26+
Syncfusion JavaScript UI (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.
27+
28+
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.
29+
30+
Customers who do not qualify for the community license can contact [email protected] for commercial licensing options.
31+
32+
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.
33+
34+
The Syncfusion license that contains the terms and conditions can be found at
35+
[https://www.syncfusion.com/content/downloads/syncfusion_license.pdf](https://www.syncfusion.com/content/downloads/syncfusion_license.pdf)
36+
37+
## Using the samples
38+
39+
### Installing
440

541
To install all dependent packages, use the below command
642

7-
```
43+
```bash
844
npm install
945
```
1046

11-
## Building
47+
### Building
1248

1349
To compile the source files, use the below command
1450

15-
```
51+
```bash
1652
npm run build
1753
```
1854

19-
## Testing
55+
### Testing
2056

2157
To test the source files, use the below command
2258

23-
```
59+
```bash
2460
npm run test
2561
```
2662

27-
## Running
63+
### Running
2864

2965
To run the samples, use the below command
3066

31-
```
67+
```bash
3268
npm run serve
33-
```
69+
```
70+
71+
## Controls Catalog
72+
73+
<table>
74+
<tr>
75+
<td colspan="3" rowspan="1">
76+
<b>GRIDS<b>
77+
</td>
78+
</tr>
79+
<tr>
80+
<td>
81+
<a href="src/grid">DataGrid</a>
82+
</td>
83+
<td>
84+
<a href="src/pivot-view">Pivot Table (Preview)</a>
85+
</td>
86+
<td></td>
87+
</tr>
88+
<tr>
89+
<td colspan="3" rowspan="1">
90+
<b>DATA VISUALIZATION<b>
91+
</td>
92+
</tr>
93+
<tr>
94+
<td>
95+
<a href="src/chart">Charts</a>
96+
</td>
97+
<td>
98+
<a href="src/circular-gauge">Circular Gauge</a>
99+
</td>
100+
<td>
101+
<a href="src/linear-gauge">Linear Gauge</a>
102+
</td>
103+
</tr>
104+
<tr>
105+
<td>
106+
<a href="src/diagram">Diagram (Preview)</a>
107+
</td>
108+
<td>
109+
<a href="src/heatmap">Heatmap chart</a>
110+
</td>
111+
<td>
112+
<a href="src/maps">Maps</a>
113+
</td>
114+
</tr>
115+
<tr>
116+
<td>
117+
<a href="src/range-navigator">Range Selector</a>
118+
</td>
119+
<td>
120+
<a href="src/smith-chart">Smith Chart</a>
121+
</td>
122+
<td>
123+
<a href="src/sparkline">Sparkline Charts</a>
124+
</td>
125+
</tr>
126+
<tr>
127+
<td>
128+
<a href="src/treemap">TreeMap</a>
129+
</td>
130+
<td></td>
131+
<td></td>
132+
</tr>
133+
<tr>
134+
<td colspan="3" rowspan="1">
135+
<b>EDITORS<b>
136+
</td>
137+
</tr>
138+
<tr>
139+
<td>
140+
<a href="src/rich-text-editor">Rich Text Editor (Preview)</a>
141+
</td>
142+
<td>
143+
<a href="src/document-editor">Word Processor (Preview)</a>
144+
</td>
145+
<td></td>
146+
</tr>
147+
<tr>
148+
<td colspan="3" rowspan="1">
149+
<b>CALENDARS<b>
150+
</td>
151+
</tr>
152+
<tr>
153+
<td>
154+
<a href="src/schedule">Scheduler</a>
155+
</td>
156+
<td>
157+
<a href="src/calendar">Calendar</a>
158+
</td>
159+
<td>
160+
<a href="src/datepicker">DatePicker</a>
161+
</td>
162+
</tr>
163+
<tr>
164+
<td>
165+
<a href="src/daterangepicker">Date Range Picker</a>
166+
</td>
167+
<td>
168+
<a href="src/datetimepicker">DateTime Picker</a>
169+
</td>
170+
<td>
171+
<a href="src/timepicker">Time Picker</a>
172+
</td>
173+
</tr>
174+
<tr>
175+
<td colspan="3" rowspan="1">
176+
<b>BUTTONS<b>
177+
</td>
178+
</tr>
179+
<tr>
180+
<td>
181+
<a href="src/button">Button</a>
182+
</td>
183+
<td>
184+
<a href="src/button/button-group.ts">Button Group</a>
185+
</td>
186+
<td>
187+
<a href="src/button/drop-down-button.ts">Dropdown Menu</a>
188+
</td>
189+
</tr>
190+
<tr>
191+
<td>
192+
<a href="src/button/progress-button.ts">Progress Button (Preview)</a>
193+
</td>
194+
<td>
195+
<a href="src/button/split-button.ts">Split Button</a>
196+
</td>
197+
<td></td>
198+
</tr>
199+
<tr>
200+
<td colspan="3" rowspan="1">
201+
<b>DROPDOWNS<b>
202+
</td>
203+
</tr>
204+
<tr>
205+
<td>
206+
<a href="src/auto-complete">AutoComplete</a>
207+
</td>
208+
<td>
209+
<a href="src/combo-box">ComboBox</a>
210+
</td>
211+
<td>
212+
<a href="src/drop-down-list">Dropdown List</a>
213+
</td>
214+
</tr>
215+
<tr>
216+
<td>
217+
<a href="src/multi-select">MultiSelect Dropdown</a>
218+
</td>
219+
<td></td>
220+
<td></td>
221+
</tr>
222+
<tr>
223+
<td colspan="3" rowspan="1">
224+
<b>NAVIGATION<b>
225+
</td>
226+
</tr>
227+
<tr>
228+
<td>
229+
<a href="src/accordion">Accordion</a>
230+
</td>
231+
<td>
232+
<a href="src/context-menu">Context Menu</a>
233+
</td>
234+
<td>
235+
<a href="src/menu">Menu Bar (Preview)</a>
236+
</td>
237+
</tr>
238+
<tr>
239+
<td>
240+
<a href="src/sidebar">Sidebar</a>
241+
</td>
242+
<td>
243+
<a href="src/tab">Tabs</a>
244+
</td>
245+
<td>
246+
<a href="src/toolbar">Toolbar</a>
247+
</td>
248+
</tr>
249+
<tr>
250+
<td>
251+
<a href="src/treeview">TreeView</a>
252+
</td>
253+
<td></td>
254+
<td></td>
255+
</tr>
256+
<tr>
257+
<td colspan="3" rowspan="1">
258+
<b>INPUTS<b>
259+
</td>
260+
</tr>
261+
<tr>
262+
<td>
263+
<a href="src/form-validator">Form Validation</a>
264+
</td>
265+
<td>
266+
<a href="src/textbox">TextBox</a>
267+
</td>
268+
<td>
269+
<a href="src/maskedtextbox">Input Mask</a>
270+
</td>
271+
</tr>
272+
<tr>
273+
<td>
274+
<a href="src/numerictextbox">Numeric Textbox</a>
275+
</td>
276+
<td>
277+
<a href="src/button/radio-button.ts">Radio Button</a>
278+
</td>
279+
<td>
280+
<a href="src/button/check-box.ts">Checkbox</a>
281+
</td>
282+
</tr>
283+
<tr>
284+
<td>
285+
<a href="src/color-picker">Color Picker</a>
286+
</td>
287+
<td>
288+
<a href="src/uploader">File Upload</a>
289+
</td>
290+
<td>
291+
<a href="src/slider">Range Slider</a>
292+
</td>
293+
</tr>
294+
<tr>
295+
<td>
296+
<a href="src/button/switch.ts">Toggle Switch Button</a>
297+
</td>
298+
<td></td>
299+
<td></td>
300+
</tr>
301+
<tr>
302+
<td colspan="3" rowspan="1">
303+
<b>LAYOUT<b>
304+
</td>
305+
</tr>
306+
<tr>
307+
<td>
308+
<a href="src/avatar">Avatar</a>
309+
</td>
310+
<td>
311+
<a href="src/card">Card</a>
312+
</td>
313+
<td>
314+
<a href="src/dialog">Dialog</a>
315+
</td>
316+
</tr>
317+
<tr>
318+
<td>
319+
<a href="src/listview">ListView</a>
320+
</td>
321+
<td>
322+
<a href="src/tooltip">Tooltip</a>
323+
</td>
324+
<td></td>
325+
</tr>
326+
<tr>
327+
<td colspan="3" rowspan="1">
328+
<b>NOTIFICATIONS<b>
329+
</td>
330+
</tr>
331+
<tr>
332+
<td>
333+
<a href="src/badge">Badge</a>
334+
</td>
335+
<td>
336+
<a href="src/toast">Toast</a>
337+
</td>
338+
<td></td>
339+
</tr>
340+
</table>
341+
342+
## Support and Feedback
343+
344+
* For any other queries, reach our [Syncfusion support team](https://www.syncfusion.com/support/directtrac/incidents/newincident?utm_source=github&utm_medium=listing&utm_campaign=ej2-samples) or post the queries through the [community forums](https://www.syncfusion.com/forums?utm_source=github&utm_medium=listing&utm_campaign=ej2-samples).
345+
346+
* To renew the subscription, click [here](https://www.syncfusion.com/sales/products?utm_source=github&utm_medium=listing&utm_campaign=ej2-samples) or contact our sales team at [[email protected]]([email protected]).

0 commit comments

Comments
 (0)