|
1 |
| -# flutter-widgets |
2 |
| -Syncfusion Flutter widgets libraries include high quality UI widgets and file-format packages to help you create rich, high-quality applications for iOS, Android, and web from a single code base. |
| 1 | +<img src="https://cdn.syncfusion.com/content/images/flutter-widgets-banner-1.png"/> |
| 2 | + |
| 3 | +# Syncfusion Flutter Widgets |
| 4 | + |
| 5 | +Syncfusion Flutter widgets libraries include high-quality UI widgets and file-format packages to help you create rich, high-quality applications for iOS, Android, and web from a single code base. |
| 6 | + |
| 7 | +**Disclaimer:** This is a commercial package. To use our packages, you need to have either the Syncfusion Commercial License or Syncfusion Community license. For more details, please check the [LICENSE](https://github.com/syncfusion/flutter-examples/blob/master/LICENSE) file. |
| 8 | + |
| 9 | +**Note:** Our packages are now compatible with Flutter for Web. However, this will be in Beta until Flutter for Web becomes stable. |
| 10 | + |
| 11 | +<img src="https://cdn.syncfusion.com/content/images/flutter-widgets-collage.png"/> |
| 12 | + |
| 13 | + |
| 14 | +## Table of contents |
| 15 | +- [Repository structure](#repository-structure) |
| 16 | +- [Packages](#packages) |
| 17 | +- [How to use](#how-to-use) |
| 18 | + - [Referring packages source in your application](#referring-packages-source-in-your-application) |
| 19 | + - [Running the available example](#running-the-available-example) |
| 20 | +- [Get the demo application](#get-the-demo-application) |
| 21 | +- [Useful links](#useful-links) |
| 22 | +- [Support and feedback](#support-and-feedback) |
| 23 | +- [About Syncfusion](#about-syncfusion) |
| 24 | + |
| 25 | +## Repository structure |
| 26 | + |
| 27 | +This repository holds the source code of all the Syncfusion Flutter widgets and libraries. Source code of the widget, a working example, read me, changelog, etc., files are available in the `packages` directory. |
| 28 | + |
| 29 | +Also, you can view the samples code from [this repository](https://github.com/syncfusion/flutter-examples). |
| 30 | + |
| 31 | +## Packages |
| 32 | + |
| 33 | +| Package/Plugin | Available widgets/libraries | Pub | Points | Popularity | Likes | |
| 34 | +|----------------|-----------------------------|-----|--------|------------|-------| |
| 35 | +| [syncfusion_flutter_charts](./packages/syncfusion_flutter_charts/) | <ul><li>SfCartesianChart</li><li>SfCircularChart</li><li>SfPyramidChart</li><li>SfFunnelChart</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_charts) | [](https://pub.dev/packages/syncfusion_flutter_charts/score) | [](https://pub.dev/packages/syncfusion_flutter_charts/score) | [](https://pub.dev/packages/syncfusion_flutter_charts/score) | |
| 36 | +| [syncfusion_flutter_calendar](./packages/syncfusion_flutter_calendar/) | <ul><li>SfCalendar</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_calendar) | [](https://pub.dev/packages/syncfusion_flutter_calendar/score) | [](https://pub.dev/packages/syncfusion_flutter_calendar/score) | [](https://pub.dev/packages/syncfusion_flutter_calendar/score) | |
| 37 | +| [syncfusion_flutter_datagrid](./packages/syncfusion_flutter_datagrid/) | <ul><li>SfDataGrid</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_datagrid) | [](https://pub.dev/packages/syncfusion_flutter_datagrid/score) | [](https://pub.dev/packages/syncfusion_flutter_datagrid/score) | [](https://pub.dev/packages/syncfusion_flutter_datagrid/score) | |
| 38 | +| [syncfusion_flutter_pdfviewer](./packages/syncfusion_flutter_pdfviewer/) | <ul><li>SfPdfViewer</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_pdfviewer) | [](https://pub.dev/packages/syncfusion_flutter_pdfviewer/score) | [](https://pub.dev/packages/syncfusion_flutter_pdfviewer/score) | [](https://pub.dev/packages/syncfusion_flutter_pdfviewer/score) | |
| 39 | +| [syncfusion_flutter_pdf](./packages/syncfusion_flutter_pdf/) | <ul><li>PDF library</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_pdf) | [](https://pub.dev/packages/syncfusion_flutter_pdf/score) | [](https://pub.dev/packages/syncfusion_flutter_pdf/score) | [](https://pub.dev/packages/syncfusion_flutter_pdf/score) | |
| 40 | +| [syncfusion_flutter_xlsio](./packages/syncfusion_flutter_xlsio/) | <ul><li>XlsIO library</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_xlsio) | [](https://pub.dev/packages/syncfusion_flutter_xlsio/score) | [](https://pub.dev/packages/syncfusion_flutter_xlsio/score) | [](https://pub.dev/packages/syncfusion_flutter_xlsio/score) | |
| 41 | +| [syncfusion_flutter_datepicker](./packages/syncfusion_flutter_datepicker/) | <ul><li>SfDateRangePicker</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_datepicker) | [](https://pub.dev/packages/syncfusion_flutter_datepicker/score) | [](https://pub.dev/packages/syncfusion_flutter_datepicker/score) | [](https://pub.dev/packages/syncfusion_flutter_datepicker/score) | |
| 42 | +| [syncfusion_flutter_maps](./packages/syncfusion_flutter_maps/) | <ul><li>SfMaps</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_maps) | [](https://pub.dev/packages/syncfusion_flutter_maps/score) | [](https://pub.dev/packages/syncfusion_flutter_maps/score) | [](https://pub.dev/packages/syncfusion_flutter_maps/score) | |
| 43 | +| [syncfusion_flutter_gauges](./packages/syncfusion_flutter_gauges/) | <ul><li>SfRadialGauge</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_gauges) | [](https://pub.dev/packages/syncfusion_flutter_gauges/score) | [](https://pub.dev/packages/syncfusion_flutter_gauges/score) | [](https://pub.dev/packages/syncfusion_flutter_gauges/score) | |
| 44 | +| [syncfusion_flutter_sliders](./packages/syncfusion_flutter_sliders/) | <ul><li>SfSlider</li><li>SfRangeSlider</li><li>SfRangeSelector</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_sliders) | [](https://pub.dev/packages/syncfusion_flutter_sliders/score) | [](https://pub.dev/packages/syncfusion_flutter_sliders/score) | [](https://pub.dev/packages/syncfusion_flutter_sliders/score) | |
| 45 | +| [syncfusion_flutter_signaturepad](./packages/syncfusion_flutter_signaturepad/) | <ul><li>SfSignaturePad</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_signaturepad) | [](https://pub.dev/packages/syncfusion_flutter_signaturepad/score) | [](https://pub.dev/packages/syncfusion_flutter_signaturepad/score) | [](https://pub.dev/packages/syncfusion_flutter_signaturepad/score) | |
| 46 | +| [syncfusion_flutter_barcodes](./packages/syncfusion_flutter_barcodes/) | <ul><li>SfBarcodeGenerator</li></ul> | [](https://pub.dev/packages/syncfusion_flutter_barcodes) | [](https://pub.dev/packages/syncfusion_flutter_barcodes/score) | [](https://pub.dev/packages/syncfusion_flutter_barcodes/score) | [](https://pub.dev/packages/syncfusion_flutter_barcodes/score) | |
| 47 | +| [syncfusion_officechart](./packages/syncfusion_officechart/) | <ul><li>Office chart library</li></ul> | [](https://pub.dev/packages/syncfusion_officechart) | [](https://pub.dev/packages/syncfusion_officechart/score) | [](https://pub.dev/packages/syncfusion_officechart/score) | [](https://pub.dev/packages/syncfusion_officechart/score) | |
| 48 | +| [syncfusion_officecore](./packages/syncfusion_officecore/) | This package is a dependecy package for `Office chart` library. | [](https://pub.dev/packages/syncfusion_officecore) | [](https://pub.dev/packages/syncfusion_officecore/score) | [](https://pub.dev/packages/syncfusion_officecore/score) | [](https://pub.dev/packages/syncfusion_officecore/score) | |
| 49 | +| [syncfusion_flutter_core](./packages/syncfusion_flutter_core/) | This package is a dependecy package for all the Syncfusion Flutter widgets and libraries. | [](https://pub.dev/packages/syncfusion_flutter_core) | [](https://pub.dev/packages/syncfusion_flutter_core/score) | [](https://pub.dev/packages/syncfusion_flutter_core/score) | [](https://pub.dev/packages/syncfusion_flutter_core/score) | |
| 50 | +| [syncfusion_localizations](./packages/syncfusion_localizations/) | This package contains localized text for 77 cultures for all the applicable Syncfusion Flutter Widgets.| [](https://pub.dev/packages/syncfusion_localizations) | [](https://pub.dev/packages/syncfusion_localizations/score) | [](https://pub.dev/packages/syncfusion_localizations/score) | [](https://pub.dev/packages/syncfusion_localizations/score) | |
| 51 | + |
| 52 | +## How to use |
| 53 | + |
| 54 | +### Referring packages source in your application |
| 55 | + |
| 56 | +All the packages available in the `packages` folder can be referred in your application by following the below steps. |
| 57 | + |
| 58 | +**Step 1** |
| 59 | + |
| 60 | +Clone the [flutter-widgets]() repository into your machine. |
| 61 | + |
| 62 | +**Step 2** |
| 63 | + |
| 64 | +Refer the required package in your application's `pubspec.yaml` file by mentioning its local path. For example, here we have referred the charts package. |
| 65 | + |
| 66 | +```dart |
| 67 | +syncfusion_flutter_charts: |
| 68 | + path: D:/flutter-widgets/packages/syncfusion_flutter_charts |
| 69 | +``` |
| 70 | + |
| 71 | +**Step 3** |
| 72 | + |
| 73 | +Run the following command to get the required packages. |
| 74 | + |
| 75 | +```dart |
| 76 | +$ flutter pub get |
| 77 | +``` |
| 78 | + |
| 79 | +**Step 4** |
| 80 | + |
| 81 | +Run your application either using `F5` or `Run > Start Debugging`. |
| 82 | + |
| 83 | +### Running the available example |
| 84 | + |
| 85 | +All the packages available in the `packages` folder has an example and it can be run by following the below steps. |
| 86 | + |
| 87 | +**Step 1** |
| 88 | + |
| 89 | +Clone the [flutter-widgets]() repository into your machine. |
| 90 | + |
| 91 | +**Step 2** |
| 92 | + |
| 93 | +Open the example folder available in packages in an IDE. The below path is for reference. |
| 94 | + |
| 95 | +```dart |
| 96 | +..\flutter-widgets\packages\syncfusion_flutter_charts\example |
| 97 | +``` |
| 98 | + |
| 99 | +**Step 3** |
| 100 | + |
| 101 | +Run the following command to get the required packages. |
| 102 | + |
| 103 | +```dart |
| 104 | +$ flutter pub get |
| 105 | +``` |
| 106 | + |
| 107 | +**Note:** In the example, packages are referred from the local folder which is available in this repository. If you wish, you can also refer the packages from [pub](https://pub.dev). |
| 108 | + |
| 109 | +**Step 4** |
| 110 | + |
| 111 | +Run your application either using `F5` or `Run > Start Debugging`. |
| 112 | + |
| 113 | +## Get the demo application |
| 114 | + |
| 115 | +Explore the full capabilities of our Flutter widgets on your device by installing our sample browser applications from the below app stores, and view samples code in GitHub. |
| 116 | + |
| 117 | +<p align="center"> |
| 118 | + <a href="https://play.google.com/store/apps/details?id=com.syncfusion.flutter.examples"><img src="https://cdn.syncfusion.com/content/images/FTControl/google-play.png"/></a> |
| 119 | + <a href="https://apps.apple.com/us/app/syncfusion-flutter-ui-widgets/id1475231341"><img src="https://cdn.syncfusion.com/content/images/FTControl/apple-button.png"/></a> |
| 120 | + </p> |
| 121 | + <p align="center"> |
| 122 | + <a href="https://github.com/syncfusion/flutter-examples"><img src="https://cdn.syncfusion.com/content/images/FTControl/GitHub.png"/></a> |
| 123 | + <a href="https://flutter.syncfusion.com"><img src="https://cdn.syncfusion.com/content/images/FTControl/web_sample_browser.png"/></a> |
| 124 | +</p> |
| 125 | + |
| 126 | +## Useful links |
| 127 | +Take a look at the following to learn more about Syncfusion Flutter widgets: |
| 128 | + |
| 129 | +* [Syncfusion Flutter product page](https://www.syncfusion.com/flutter-widgets) |
| 130 | +* [User guide documentation](https://help.syncfusion.com/flutter/introduction/overview) |
| 131 | +* [API reference](https://help.syncfusion.com/flutter/introduction/api-reference) |
| 132 | +* [Knowledge base](https://www.syncfusion.com/kb/flutter) |
| 133 | +* [Video tutorials](https://www.syncfusion.com/tutorial-videos/flutter) |
| 134 | + |
| 135 | +## Support and feedback |
| 136 | + |
| 137 | +* For any other queries, reach our [Syncfusion support team](https://www.syncfusion.com/support/directtrac/incidents/newincident) or post the queries through the [Community forums](https://www.syncfusion.com/forums) and submit a feature request or a bug through our [Feedback portal](https://www.syncfusion.com/feedback/flutter). |
| 138 | +* To renew the subscription, click [renew](https://www.syncfusion.com/sales/products) or contact our sales team at salessupport@syncfusion.com | Toll Free: 1-888-9 DOTNET. |
| 139 | + |
| 140 | +## About Syncfusion |
| 141 | + |
| 142 | +Founded in 2001 and headquartered in Research Triangle Park, N.C., Syncfusion has more than 20,000 customers and more than 1 million users, including large financial institutions, Fortune 500 companies, and global IT consultancies. |
| 143 | + |
| 144 | +Today we provide 1,000+ controls and frameworks for web ([ASP.NET Core](https://www.syncfusion.com/aspnet-core-ui-controls), [ASP.NET MVC](https://www.syncfusion.com/aspnet-mvc-ui-controls), [ASP.NET WebForms](https://www.syncfusion.com/jquery/aspnet-web-forms-ui-controls), [JavaScript](https://www.syncfusion.com/javascript-ui-controls), [Angular](https://www.syncfusion.com/angular-ui-components), [React](https://www.syncfusion.com/react-ui-components), [Vue](https://www.syncfusion.com/vue-ui-components), and [Blazor](https://www.syncfusion.com/blazor-components), mobile ([Xamarin](https://www.syncfusion.com/xamarin-ui-controls), [Flutter](https://www.syncfusion.com/flutter-widgets), [UWP](https://www.syncfusion.com/uwp-ui-controls), and [JavaScript](https://www.syncfusion.com/javascript-ui-controls)), and desktop development ([WinForms](https://www.syncfusion.com/winforms-ui-controls), [WPF](https://www.syncfusion.com/wpf-ui-controls), and [UWP](https://www.syncfusion.com/uwp-ui-controls)). We provide ready-to deploy enterprise software for dashboards, reports, data integration, and big data processing. Many customers have saved millions in licensing fees by deploying our software. |
0 commit comments