diff --git a/README.md b/README.md index 78a140b..7d1e40d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,71 @@ # binding-data-to-angular-spreadsheet -A quick-start project that helps you bind local and remote data to the Syncfusion Angular Spreadsheet component. In this project, remote data is bound by assigning service url as an instance of the Data Manager. This project also contains code to bind cell data and change the data source dynamically. + +This quick-start project demonstrates how to bind both **local and remote data sources** to the [Syncfusion Angular Spreadsheet](https://help.syncfusion.com/document-processing/excel/spreadsheet/angular/overview) component. It showcases dynamic data integration using the `DataManager` for remote services, as well as manual cell-level data binding for granular control. + +Built with [Angular CLI](https://github.com/angular/angular-cli), this example is ideal for developers looking to integrate spreadsheet-style data presentation and editing into enterprise-grade Angular applications. + +## Project Highlights + +- Bind remote data using `DataManager` with service URLs +- Populate cells with local JSON or object arrays +- Dynamically switch data sources at runtime +- Customize cell formatting and structure based on incoming data +- Maintain spreadsheet interactivity while syncing with external data + +## Live Documentation + +Explore Syncfusion’s official guide on [Spreadsheet Data Binding](https://help.syncfusion.com/document-processing/excel/spreadsheet/angular/data-binding) for deeper insights. + +## Features + +- **Remote Data Binding**: Connect to REST APIs or web services using `DataManager`. +- **Local Data Binding**: Populate spreadsheet cells with static or dynamic local data. +- **Dynamic Source Switching**: Change the data source on-the-fly based on user input or app state. +- **Cell-Level Control**: Assign values, styles, and formulas directly to individual cells. +- **Responsive UI**: Works seamlessly across devices with full spreadsheet interactivity. + +## Use Cases + +- Admin dashboards with live data feeds +- Financial reports from remote databases +- Inventory tracking with editable spreadsheets +- Educational platforms with dynamic gradebooks +- CRM tools with spreadsheet-style data entry + +## Getting Started + +1. Clone the repository +2. Run `npm install` to install dependencies +3. Run `ng serve` to launch the app at `http://localhost:4200/` + +## Development Notes + +- Remote data is configured via `DataManager` using a service URL. +- Local data is assigned directly to the spreadsheet’s `sheets` configuration. +- You can toggle between sources using a dropdown or button event. + +## Build + +Run `ng build` to compile the project. +Artifacts will be stored in the `dist/` directory. + +## Testing + +Run `ng test` for unit tests via Karma. +Run `ng e2e` for end-to-end testing (requires a configured framework). + +## Contributing + +Pull requests are welcome! +Feel free to submit improvements, bug fixes, or feature suggestions. + +## License + +This project is licensed under terms outlined by Syncfusion. +For detailed licensing information, please refer to the official documentation: +[Syncfusion Document Processing Licensing Overview](https://help.syncfusion.com/document-processing/licensing/overview) + +## Further Help + +For more help with Angular CLI, run `ng help` or visit: +🔗 [Angular CLI Overview and Command Reference](https://angular.io/cli)