You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/en/components/general-getting-started.md
+27-20Lines changed: 27 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,18 @@ _keywords: {ProductName}, Infragistics, Getting Started
5
5
mentionedTypes: ["XamBulletGraph", "IgrGrid"]
6
6
---
7
7
8
-
<!-- React -->
8
+
<!-- React, WebComponents-->
9
9
10
10
# Getting Started With {ProductName}
11
11
12
+
[`{ProductName}`]({GithubLink}) is a complete set of UI widgets, components, and Sketch UI kits for {Platform} by Infragistics. It enables developers to build modern, high-performance HTML5 and JavaScript apps for desktop browsers, mobile experiences, and progressive web apps (PWAs).
13
+
14
+
{ProductName} comprises several packages available under either an MIT or a commercial license, depending on the components and services they contain. For a detailed list of components and their license, please refer to the [License FAQ and Installation](./general-licensing.md) and [Open Source vs Premium](./general-open-source-vs-premium.md) topics.
15
+
16
+
<!-- end: React, WebComponents -->
17
+
18
+
<!-- React -->
19
+
12
20
## Prerequisites
13
21
14
22
1. Install NodeJS.
@@ -41,20 +49,23 @@ To create an application from scratch and configure it to use Ignite UI React yo
41
49
npm install -g igniteui-cli
42
50
```
43
51
44
-
If you want to get a guided experience through the available options, you can initialize the step by step mode that will help you create and setup your new application. To start the guide, simply run the `ig` command:
52
+
If you want to get a guided experience through the available options, you can initialize the step-by-step mode that will help you create and set up your new application. To start the guide, simply run the `ig` command:
45
53
46
54
```cmd
47
55
ig
48
56
```
49
57
50
-
Then choose `React` as framework, `Ignite UI for React TS` as type, select `Default Top Navigation` project template, add a specific component/view or select `Complete & Run`.
58
+
Then choose `React` as the framework and `Ignite UI for React TS` as the project type. Select the `Default Top Navigation` project template, add a specific component/view, or select `Complete & Run`.
51
59
For more information about the Ignite UI CLI, see the [CLI overview](general-cli-overview.md).
52
60
53
61
If you added a Grid component during the prompts, once the application is running you should see something similar to the following:
54
62
55
63
<imgsrc="../images/general/ig-cli-grid.png" />
56
64
57
-
Alternatively, you can use popular frameworks such as Next.js, Vite or Expo as recommended by the React team. Following is a step-by-step instructions for creating React applications with Ignite UI React using one of these methods.
65
+
>[!NOTE]
66
+
> Keep in mind that by default Ignite UI CLI installs the Trial version of Ignite UI for React's Grid component which is under [commercial license](./general-open-source-vs-premium.md#comparison-table-for-all-components).
67
+
68
+
Alternatively, you can use popular frameworks such as Next.js, Vite, or Expo as recommended by the React team. The following are step-by-step instructions for creating React applications with Ignite UI for React using one of these methods.
58
69
59
70
## Using Vite CLI
60
71
@@ -70,7 +81,7 @@ All popular frameworks for React development provide powerful CLI tools for scaf
70
81
npm create vite@latest
71
82
```
72
83
73
-
Then follow the prompts to choose a name for the project, React as a platform to create the project for, whether to use Typescript or not and for various other options Vite provides. Please, refer to this <ahref="https://react.dev/learn/creating-a-react-app"target="_blank">topic</a> for more information on the different ways to boilerplate a React application.
84
+
Then follow the prompts to choose a name for the project, React as the framework, whether to use TypeScript, and various other options provided by Vite. Please refer to this <ahref="https://react.dev/learn/creating-a-react-app"target="_blank">topic</a> for more information on the different ways to boilerplate a React application.
74
85
75
86
### Adding an Ignite UI React Grid Component
76
87
@@ -140,20 +151,16 @@ After executing this command, your project will be built and served locally on y
140
151
<!-- end: React -->
141
152
142
153
<!-- WebComponents -->
143
-
# Getting Started With {ProductName}
144
-
145
-
This section provides step-by-step instructions for creating Web Components application with Ignite UI for Web Components.
146
-
147
154
148
-
## Install IgniteUI CLI
155
+
## Install Ignite UI CLI
149
156
150
157
To create an application from scratch and configure it to use the Ignite UI Web Components you can use the Ignite UI CLI. The first step is to install the respective package globally as follows:
151
158
152
159
```cmd
153
160
npm install -g igniteui-cli
154
161
```
155
162
156
-
If you want to get a guided experience through the available options, you can initialize the step by step mode that will help you create and setup your new application. To start the guide, simply run the `ig` command:
163
+
If you want to get a guided experience through the available options, you can initialize the step-by-step mode that will help you create and set up your new application. To start the guide, simply run the `ig` command:
157
164
158
165
```cmd
159
166
ig
@@ -281,7 +288,7 @@ code .
281
288
> [!Note]
282
289
> This script will use webpack to bundle the **index.js** file into another file called **index.bundle.js** and place it into a folder named **dist**.
283
290
>
284
-
> If a **javaScript heap out of memory** issue occurs while building you can increase the heap size by using this build command instead:
291
+
> If a **JavaScript heap out of memory** issue occurs while building you can increase the heap size by using this build command instead:
285
292
286
293
```json
287
294
"scripts": {
@@ -386,7 +393,7 @@ npm run build
386
393
387
394
## Updating Existing Apps
388
395
389
-
If you want to use {ProductName} in an existing {Platform} CLI project (one that you have from before). We have you covered! All you have to do is execute these commands:
396
+
If you want to use {ProductName} in an existing {Platform} CLI project, we have you covered! All you have to do is execute these commands:
390
397
391
398
```cmd
392
399
npm install --save {PackageCommon}
@@ -416,7 +423,7 @@ This will automatically install packages for {ProductName}, along with all of th
416
423
<!-- WebComponents -->
417
424
# {ProductName} Packages Overview
418
425
419
-
{ProductName} is a complete set of UI widgets, components, UI kits for design tools and supporting services for Web Components. Designed to enable developers to build the most modern, high-performance HTML5 & JavaScript apps for modern desktop browsers, mobile experiences and progressive web apps (PWA’s) targeting the browsers web components APIs.
426
+
{ProductName} is a complete set of UI widgets, components, and UI kits for design tools and supporting services for Web Components. Designed to enable developers to build the most modern, high-performance HTML5 and JavaScript apps for modern desktop browsers, mobile experiences, and progressive web apps (PWAs) targeting the browsers web components APIs.
420
427
421
428
<!-- end: WebComponents -->
422
429
@@ -430,19 +437,19 @@ This will automatically install packages for {ProductName}, along with all of th
430
437
<!-- WebComponents, React -->
431
438
432
439
## Charts & Graphs
433
-
{ProductName} contains a library of [Charts & Graphs](charts/chart-overview.md) that lets you visualize any type of data through its 65+ types of chart series and combinations into stunning and interactive charts and dashboards. Built for speed and beauty, designed to work on every modern browser and with complete touch and interactivity, you can quickly build responsive visuals on any device.
440
+
{ProductName} contains a library of [Charts & Graphs](charts/chart-overview.md) that lets you visualize any type of data through its 65+ types of chart series and combinations to create stunning and interactive charts and dashboards. Built for speed and beauty, designed to work on every modern browser and with complete touch and interactivity, you can quickly build responsive visuals on any device.
434
441
435
442
## Gauges
436
-
{ProductName} provides [Radial Gauge](radial-gauge.md), [Linear Gauge](linear-gauge.md), and [Bullet Graph](bullet-graph.md) components used to illustrate data in an easy and intuitive way. The [Radial Gauge](radial-gauge.md) has a variety of customization options in order to create a predefined shape and scale. The [Linear Gauge](linear-gauge.md) provides a simple view of a value compared against a scale and one or more ranges. It supports one scale, one set of tick marks and one set of labels. The [Bullet Graph](bullet-graph.md) component that lets you create data visualizations, replacing meters and gauges that are used on dashboards with simple bar charts.
443
+
{ProductName} provides [Radial Gauge](radial-gauge.md), [Linear Gauge](linear-gauge.md), and [Bullet Graph](bullet-graph.md) components used to illustrate data in an easy and intuitive way. The [Radial Gauge](radial-gauge.md) has a variety of customization options in order to create a predefined shape and scale. The [Linear Gauge](linear-gauge.md) provides a simple view of a value compared against a scale and one or more ranges. It supports one scale, one set of tick marks and one set of labels. The [Bullet Graph](bullet-graph.md) component lets you create data visualizations, replacing meters and gauges that are used on dashboards with simple bar charts.
437
444
438
445
## Maps
439
-
{ProductName} [Geographic Maps](geo-map.md) brings the ability to visualize geographic data in your application. It can render data sets consisting of many geographic locations in shapes of markers, lines, polygons, or even interactive bitmaps. It allows you to overlay multiple map layers with geographic data, mark specific geographic locations and display information using custom markers and colors.
446
+
The {ProductName} [Geographic Map](geo-map.md) component brings the ability to visualize geographic data in your application. It can render data sets consisting of many geographic locations in shapes of markers, lines, polygons, or even interactive bitmaps. It allows you to overlay multiple map layers with geographic data, mark specific geographic locations and display information using custom markers and colors.
440
447
441
448
## Grids & Inputs
442
-
{ProductName} provides several [Grids](grids/grids-header.md) components that allows you to bind and display data with little configuration in form of [Data Grid](grids/data-grid.md), [List](grids/list.md), [Tree](grids/tree.md), and even [Spreadsheet](spreadsheet-overview.md). It also provides features such as filtering, sorting, grouping, pinning and more.
449
+
{ProductName} provides several [Grid](grids/grids-header.md) components that allow you to bind and display data with little configuration in the form of [Grid Lite](grid-lite/overview.md) - a light-weight grid component under MIT license, [Data Grid](grids/data-grid.md) - a feature-rich grid component under commercial license, [List](grids/list.md), [Tree](grids/tree.md), and even [Spreadsheet](spreadsheet-overview.md).
443
450
444
-
## Buttons, Inputs, Layouts & Menus
445
-
{ProductName} provides various types of [Buttons](inputs/button.md), [Inputs](inputs/input.md), [Menus](menus/navbar.md), and [Layouts](layouts/tabs.md) that give you the ability to build modern web applications using encapsulation and the concept of reusable components in a dependency-free approach. See the [Storybook Here](https://igniteui.github.io/igniteui-webcomponents). These components are based on the [Indigo Design System](https://www.infragistics.com/products/appbuilder/ui-toolkit), are fully supported by [App Builder](https://appbuilder.indigo.design/) and are backed by ready-to-use UI kits for Sketch, Adobe XD and Figma.
451
+
## Buttons, Inputs, Layouts, and Menus
452
+
{ProductName} provides various types of [Buttons](inputs/button.md), [Inputs](inputs/input.md), [Menus](menus/navbar.md), and [Layouts](layouts/tabs.md) that give you the ability to build modern web applications using encapsulation and the concept of reusable components in a dependency-free approach. See the [Storybook here](https://igniteui.github.io/igniteui-webcomponents). These components are based on the [Indigo Design System](https://www.infragistics.com/products/appbuilder/ui-toolkit), are fully supported by [App Builder](https://appbuilder.indigo.design/) and are backed by ready-to-use UI kits for Sketch, Adobe XD and Figma.
0 commit comments