Skip to content

924430: Updating UG for the UI Kit topic for the Angular platform #729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: hotfix/hotfix-v28.1.33
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions ej2-angular/ui-kit/build-your-first-angular-app-with-blocks.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: post
title: Build your first Angular app with our blocks | Syncfusion
description: Learn all about building your first Syncfusion Angular app with our blocks in the Syncfusion Angular UI Kit component of Syncfusion Essential JS 2 and more.
description: Learn all about building your first Angular app using our blocks from the Essential Angular UI Kit in Syncfusion Essential JS 2 and more.
platform: ej2-angular
control: Build your first Angular app with our blocks
documentation: ug
Expand All @@ -19,7 +19,7 @@ To create a new Angular app, please refer to the official Angular setup guide [h

After creating the new Angular app named **my-angular-app**, open it in Visual Studio Code (which we'll be using throughout this walkthrough). Once the app is open, before proceeding further, navigate to the **src -> app -> app.component.html** file and remove the template HTML code. Remember, only remove the template HTML code and not the `<router-outlet />` code.

The next step is to choose a theme, either **Tailwind** or **Bootstrap 5.3**, in both light and dark modes, and configure the app accordingly.
The next step is to choose a theme, either **Tailwind** or **Bootstrap 5.3**, in either light or dark mode, and configure the app accordingly.

### Tailwind configuration

Expand Down Expand Up @@ -49,7 +49,7 @@ If you choose **Tailwind** theme, follow these steps to configure it.
theme: {
extend: {
colors: {
// NOTE: In this demo, we have used different shades of "Indigo" as primary colors.
// NOTE: In this demo, different shades of "Indigo" are used as primary colors.
primary: {
"50": "#eef2ff",
"100": "#e0e7ff",
Expand Down Expand Up @@ -158,7 +158,7 @@ Now that **my-angular-app** is set up with the desired theme configuration, the

![Navigate to the sign-in block demo](images/navigate-to-the-sign-in-block-demo.png)

2. On the demo page, select the first demo, which showcases a simple sign-in block. Choose the desired theme, then switch from the "Preview" tab to the "Code" tab.
2. On the demo page, go to the first demo, which showcases a simple sign-in block. Choose the desired theme, then switch from the "Preview" tab to the "Code" tab.

![Choose Tailwind or Bootstrap theme](images/choose-tailwind-or-bootstrap-theme.png)

Expand All @@ -168,9 +168,9 @@ Now that **my-angular-app** is set up with the desired theme configuration, the

4. If CSS is provided, copy the CSS code and paste it into the **src -> app -> app.component.css** file; otherwise, ignore it.

### Steps to explore and copy block code snippets from the GitHub app
### Steps to explore and copy block code snippets from the GitHub source

1. On [downloading](https://github.com/syncfusion/essential-ui-kit-for-angular) and opening the GitHub app in Visual Studio Code, navigate to the following folder: **src -> blocks-section**.
1. On [downloading](https://github.com/syncfusion/essential-ui-kit-for-angular) and opening the GitHub source in Visual Studio Code, navigate to the following folder: **src -> blocks-section**.

![Downloaded GitHub app in Visual Studio Code](images/downloaded-github-app-in-visual-studio-code.png)

Expand All @@ -180,13 +180,14 @@ Now that **my-angular-app** is set up with the desired theme configuration, the

![View the sign-in block demo files](images/view-the-sign-in-block-demo-files.png)

> In the HTML, the **Tailwind** design code is placed within the "if" block, while the **Bootstrap 5.3** design code is placed in the "else" block.
> **Note:**
>
> 1. In the HTML, the **Tailwind** design code is placed within the "if" block, while the **Bootstrap 5.3** design code is placed in the "else" block.
> 2. Ignore the code within the "SB Code - Start" and "SB Code - End" comments, as it is intended solely for sample browser purposes.

> Ignore the code within the "SB Code - Start" and "SB Code - End" comments, as it is intended solely for sample browser purposes.

## Steps to install and configure Syncfusion components
## Steps to install and configure Syncfusion Angular components

While copying and pasting the HTML code, you'll notice that Syncfusion Angular components are used. To incorporate them into **my-angular-app**, install the necessary packages and add the corresponding modules to the **src/app/app.component.ts** file for the app to run.
While copying and pasting the HTML code, you'll notice that Syncfusion Angular components are used. To incorporate them into **my-angular-app**, install the necessary packages and add the corresponding modules to the **src -> app -> app.component.ts** file for the app to run.

In the simple sign-in block, components such as textbox, checkbox and button are used. After copying and pasting the code into the HTML file, open the **package.json** file and add the required packages: `@syncfusion/ej2-angular-buttons` and `@syncfusion/ej2-angular-inputs`. For more details about other Syncfusion Angular component packages, refer to this [link](https://www.npmjs.com/search?q=%40syncfusion%2Fej2-angular).

Expand All @@ -202,13 +203,13 @@ Finally, go to the [online demo](https://ej2.syncfusion.com/angular/essential-ui

> Ignore the code within the "SB Code - Start" and "SB Code - End" comments, as it is intended solely for sample browser purposes.

## Steps to import and add assets to the app
## Steps to download and add assets to the app

If you want to view and experience the images used in our simple sign-in design, you can download the **assets** folder from the following [GitHub link](https://github.com/syncfusion/essential-ui-kit-for-angular/tree/master/ui-blocks/src) and place it inside the **src** folder of **my-angular-app**, modifying the image URL if required.
If you want to view and experience the images used in our design, you can download the **assets** folder from the following [GitHub repository](https://github.com/syncfusion/essential-ui-kit-for-angular/tree/master/ui-blocks/src), place it inside the **src** folder of **my-angular-app**, and modify the image URLs in the HTML if necessary.

## Steps to run the app

Now that everything is set up in **my-angular-app** — the HTML, TS, CSS (if applicable), and assets — we are ready to build and launch the app. Type the `ng serve` command in the terminal, and you will see a localhost URL provided by the Angular development server.
Now that everything is set up in **my-angular-app** — the HTML, TS, CSS (if applicable), and assets (optional) — you are ready to build and launch the app. Type the `ng serve` command in the terminal, and you will see a localhost URL provided by the Angular development server.

![Build and launch the app](images/build-and-launch-the-app.png)

Expand Down
12 changes: 6 additions & 6 deletions ej2-angular/ui-kit/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: post
title: Getting Started with the Angular UI Kit Component | Syncfusion
description: Checkout and learn about Getting started with Angular UI Kit component of Syncfusion Essential JS 2 and more details.
title: Getting Started with Essential UI Kit for Angular | Syncfusion
description: Checkout and learn about getting started with the Essential UI Kit for Angular in Syncfusion Essential JS 2, along with more details.
platform: ej2-angular
control: Getting started
control: Getting Started
documentation: ug
domainurl: ##DomainURL##
---
Expand All @@ -19,7 +19,7 @@ Follow the steps below to get started with Essential UI Kit for Angular. You can

### Step 1: Download and Open the App in Visual Studio Code

Download the app from the GitHub [link](https://github.com/syncfusion/essential-ui-kit-for-angular), and then open the project folder in Visual Studio Code to start working with it.
Download the app from the GitHub [link](https://github.com/syncfusion/essential-ui-kit-for-angular), and then open the same in Visual Studio Code to start working with it.

![Launching the downloaded app](images/launching-the-downloaded-app.png)

Expand All @@ -32,8 +32,8 @@ In Visual Studio Code, go to the **Terminal** menu and select **New Terminal** t
### Step 3: Install Dependencies and Run the App
Run the following commands one after the other in the terminal:

1. **Install project dependencies**
Run the command below to install all necessary packages related to the Angular project, the sample browser, and the Syncfusion Angular components.
1. **Install dependencies**
Run the command below to install all necessary packages related to the blocks, the Syncfusion Angular components, and the sample browser.

![Installing the required dependencies](images/installing-the-required-dependencies.png)

Expand Down
4 changes: 2 additions & 2 deletions ej2-angular/ui-kit/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: post
title: Overview of Angular UI Kit Component | Syncfusion
description: Learn here all about the Overview in the Syncfusion Angular UI Kit component of Syncfusion Essential JS 2 and more here.
title: Overview of Essential UI Kit for Angular | Syncfusion
description: Learn all about the overview of the Essential UI Kit for Angular in Syncfusion Essential JS 2 and more here.
platform: ej2-angular
control: Overview
documentation: ug
Expand Down