Skip to content

Commit a86a34b

Browse files
Merge pull request #6 from GokulSaravanan26/patch-1
Documentation (1021684): Improved ReadMe file content.
2 parents 3f838c5 + 8e44181 commit a86a34b

1 file changed

Lines changed: 52 additions & 7 deletions

File tree

README.md

Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,57 @@
11
# Getting Started with the Angular Button Component
2-
A quick start project that shows how to add the Syncfusion Angular Button component to an Angular application. It shows how to display and position icons on the button and customize the button types and styles.
32

4-
Refer to the following documentation to learn about the Angular Button component: https://ej2.syncfusion.com/angular/documentation/button/getting-started
3+
A quick start project demonstrating how to integrate and customize the Syncfusion Angular Button component in an Angular application, including icon positioning, styling, and component type customization.
54

6-
Check out this online example of the Angular Button Component: https://ej2.syncfusion.com/angular/demos/#/material/button/default
5+
## Overview
76

8-
## Project prerequisites
9-
Make sure that you have the compatible versions of Visual Studio Code and NodeJS or later version in your machine before starting to work on this project.
7+
This project provides a practical introduction to the Syncfusion Angular Button component. You'll learn how to add the Button component to an Angular application, display and position icons, customize button types and styles, and implement best practices for button usage in modern web applications.
108

11-
## How to run this application
12-
To run this application, you need to first clone the getting-started-with-the-angular-button-component repository and then open it in Visual Studio Code. Now, simply build and run your project to view the output.
9+
## Features
10+
11+
- **Button Component Integration**: Step-by-step guide to adding Syncfusion Button component to Angular projects
12+
- **Icon Positioning**: Learn how to display and position icons on buttons effectively
13+
- **Style Customization**: Customize button appearance with different types and styling options
14+
- **Multiple Button Types**: Support for various button types and states
15+
- **Responsive Design**: Create buttons that work across different screen sizes
16+
17+
## Prerequisites
18+
19+
Before starting this project, ensure you have the following installed:
20+
- Visual Studio Code (latest compatible version)
21+
- NodeJS (current or later version)
22+
- npm or yarn package manager
23+
- Angular CLI (recommended for Angular development)
24+
25+
## Installation
26+
27+
1. Clone the repository:
28+
```
29+
git clone https://github.com/your-user/getting-started-with-the-angular-button-component.git
30+
```
31+
32+
2. Navigate to the project directory:
33+
```
34+
cd getting-started-with-the-angular-button-component
35+
```
36+
37+
3. Install dependencies:
38+
```
39+
npm install
40+
```
41+
42+
## How to Run This Application
43+
44+
1. Open the project in Visual Studio Code
45+
2. Build the project
46+
3. Run the development server to view the output
47+
4. The application will display the Angular Button component with various configurations
48+
49+
## Documentation and Resources
50+
51+
For detailed information about the Angular Button component, refer to the official documentation:
52+
- [Angular Button Component Documentation](https://ej2.syncfusion.com/angular/documentation/button/getting-started)
53+
- [Online Demo](https://ej2.syncfusion.com/angular/demos/#/material/button/default)
54+
55+
## Support
56+
57+
For issues, questions, or contributions, please refer to the Syncfusion documentation or create an issue in the repository.

0 commit comments

Comments
 (0)