Skip to content

DOCINFRA-2341_merged_using_automation #680

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

Merged
merged 4 commits into from
Nov 25, 2024
Merged
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
24 changes: 12 additions & 12 deletions ej2-angular/ui-kit/build-your-first-angular-app-with-blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ domainurl: ##DomainURL##
# Build your first Angular app with our blocks

## Create an Angular app
To create an Angular app, please refer to the official Angular setup guide [here](https://v17.angular.io/guide/setup-local) to get started. In this example, I have created an Angular app named **my-angular-app** and will walk you through the step-by-step process of adding a simple sign-in block.
To create a new Angular app, please refer to the official Angular setup guide [here](https://v17.angular.io/guide/setup-local) to get started. In this example, I have created a new Angular app named **my-angular-app** and will walk you through the step-by-step process of adding a simple sign-in block.

![New Angular App](images/new-angular-app.png)

## Setting up Tailwind or Bootstrap 5.3 theme in the app

After creating your 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.
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.

Expand Down Expand Up @@ -154,29 +154,29 @@ Now that **my-angular-app** is set up with the desired theme configuration, the

### Steps to explore and copy block code snippets from the online demo

1. In the online demo, navigate to the "Authentication" category and select the "Sign In" block. This will direct you to the appropriate demo page.
1. In the [online demo](https://ej2.syncfusion.com/angular/essential-ui-kit/#/blocks), navigate to the "Authentication" category and select the "Sign In" block. This will direct you to the appropriate demo page.

![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.

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

3. In the "Code" tab, copy the HTML code using the "Copy to clipboard" option and paste it into the `src -> app -> app.component.html` file.
3. In the "Code" tab, copy the HTML code using the "Copy to clipboard" option and paste it into the **src -> app -> app.component.html** file.

![Copy HTML code snippet to clipboard](images/copy-HTML-code-snippet-to-clipboard.png)

4. If CSS is provided, copy the CSS code and paste it into the `src -> app -> app.component.css` file; otherwise, ignore it.
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

1. After downloading 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 app 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)

2. Inside, you'll find a list of folders, each corresponding to a specific block. Open the "signin" block folder, where you'll see the demo arranged sequentially.

3. Go to the first folder, `src/blocks-section/signin/signin-1`, where you'll find the HTML, CSS, and TS files of the simple sign-in block. You can copy the code directly from these files.
3. Go to the first folder, **src/blocks-section/signin/signin-1**, where you'll find the HTML, CSS, and TS files of the simple sign-in block. You can copy the code directly from these files.

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

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

## Steps to install and configure Syncfusion 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).

![Adding required packages for Syncfusion components](images/adding-required-packages-for-syncfusion-components.png)

Once the necessary packages are added, run the `npm install` command via the terminal to install those packages in the `node_modules` folder.
Once the necessary packages are added, run the `npm install` command via the terminal to install those packages in the **node_modules** folder.

![Install Syncfusion component packages](images/install-syncfusion-component-packages.png)

Finally, go to the online demo or the GitHub repository and copy the required "TypeScript" code into your app. This typically includes the import module to run Syncfusion Angular components and any basic code required for the component to function.
Finally, go to the [online demo](https://ej2.syncfusion.com/angular/essential-ui-kit/#/blocks) or the [GitHub repository](https://github.com/syncfusion/essential-ui-kit-for-angular) and copy the required **TypeScript** code into your app. This typically includes the import module to run Syncfusion Angular components and any basic code required for the component to function.

![Import Syncfusion component module in TypeScript](images/import-syncfusion-component-module-in-typescript.png)

> 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

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) and place it inside the **src** folder of **my-angular-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.

## Steps to run the app

Expand All @@ -214,4 +214,4 @@ Now that everything is set up in **my-angular-app** — the HTML, TS, CSS (if ap

To view the app in your browser, simply **Ctrl + Click** (or **Cmd + Click** on macOS) on the localhost URL displayed in the terminal. This will open the app in your default browser, allowing you to view and experience the simple sign-in block.

![View the app in the browser using the localhost URL](images/View-the-app-in-the-browser-using-the-localhost-URL.png)
![View the app in the browser using the localhost URL](images/view-the-app-in-the-browser-using-the-localhost-URL.png)
14 changes: 6 additions & 8 deletions ej2-angular/ui-kit/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ domainurl: ##DomainURL##

Follow the steps below to get started with Essential UI Kit for Angular. You can begin in one of two ways:

- **Download the App from GitHub**: Get the full source code and run the app locally to explore the blocks.
- **Download the App from GitHub**: Get the full free source code and run the app locally to explore the blocks.
- **View the Online Demo**: Alternatively, you can try out the blocks directly through the online demo to see them in action without needing to download anything.

## Get Started by Downloading the App from GitHub
Expand Down Expand Up @@ -40,13 +40,11 @@ Run the following commands one after the other in the terminal:
This will download and install all the dependencies listed in the **package.json** file.

2. **Serve the App Locally**
After the dependencies are installed, you can run the app locally by starting the Angular local development server.

Run the following command:
Once the dependencies are installed, you can run the app locally by starting the Angular local development server. To do so, run the following command.

![Running the Angular development server](images/running-the-angular-development-server.png)

This command will start the local development server, and you'll see an output in the terminal indicating the application is running. Typically, it will display a local host URL like this:
This command will start the local development server, and you'll see an output in the terminal indicating the app is running. Typically, it will display a local host URL like this:

![Local development server running](images/local-development-server-running.png)

Expand All @@ -60,17 +58,17 @@ The blocks include several Syncfusion Angular components that require an active
To obtain the license key, visit the following page: [Syncfusion License](https://ej2.syncfusion.com/angular/documentation/licensing/overview).

#### How to Register the License Key in the App
Once you have your license key, add it to the `src/main.ts` file for seamless browsing and usage of the blocks.
Once you have your license key, add it to the **src/main.ts** file for seamless browsing and usage of the blocks.

```typescript
import { registerLicense } from '@syncfusion/ej2-base';

registerLicense('Your-License-Key');
```
Replace `'Your-License-Key'` with the actual license key you received from Syncfusion.
Replace **'Your-License-Key'** with the actual license key you received from Syncfusion.

By adding the license key, you ensure that the blocks are fully functional and free from licensing issues.

## Get Started by Viewing the Online Demo

If you prefer a quick demo instead of downloading the app, you can explore the blocks directly through the online demo. Simply visit the official [Essential UI Kit for Angular](#) website to interact with the blocks.
If you prefer a quick demo instead of downloading the app, you can explore the blocks directly through the online demo. Simply visit the official [Essential UI Kit for Angular](https://ej2.syncfusion.com/angular/essential-ui-kit/#/blocks) website to interact with the blocks.