Skip to content

Commit 397c054

Browse files
Merge pull request #309 from Yuvaraj-Gajaraj/master
Update the readme content
2 parents bbcdf40 + 35313eb commit 397c054

File tree

2 files changed

+102
-10
lines changed

2 files changed

+102
-10
lines changed

README.md

Lines changed: 102 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,108 @@
1-
# flutter_examples
1+
# Syncfusion Flutter examples
22

3-
This project contains the Syncfusion Flutter UI widgets examples.
3+
This repository contains awesome demos of [Syncfusion Flutter UI widgets](https://www.syncfusion.com/flutter-widgets). This is the best place to check our widgets to get more insight into the usage of APIs. You can also check our widgets by installing the complete Flutter sample browser from [Google Play Store](https://play.google.com/store/apps/details?id=com.syncfusion.flutter.examples) or [App Store](https://apps.apple.com/us/app/syncfusion-flutter-ui-widgets/id1475231341), in which you can browse the demo for all the widgets and view the source code of each sample within the app itself.
44

5-
## Getting Started
5+
<img src="images/flutter_examples.png"/>
66

7-
This project is a starting point for a Flutter application.
7+
## Table of contents
88

9-
A few resources to get you started if this is your first Flutter project:
9+
* [Requirements to run the demo](#requirements-to-run-the-demo)
10+
* [Repository Structure](#repository-structure)
11+
* [Widgets Catalog](#widgets-catalog)
12+
* [License](#license)
13+
* [Using the examples](#using-the-examples)
14+
* [Support and Feedback](#support-and-feedback)
1015

11-
- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
16+
## <a name="requirements-to-run-the-demo"></a>Requirements to run the demo ##
17+
* IDE tools are [Visual Studio code](https://flutter.dev/docs/get-started/editor?tab=vscode) and [Android studio](https://flutter.dev/docs/get-started/editor?tab=androidstudio).
18+
* Flutter SDK
19+
| Channel| Version|
20+
|--------|--------|
21+
| Stable | [2.0.2](https://code.visualstudio.com/download)|
22+
| Beta | [2.0.2](https://storage.googleapis.com/flutter_infra/releases/beta/windows/flutter_windows_2.0.2-beta.zip)|
23+
* Dart and Flutter add-ons for Visual Studio Code (available via the Visual studio code extension) in Android Studio it available in plugin preference.
1324

14-
For help getting started with Flutter, view our
15-
[online documentation](https://flutter.dev/docs), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.
25+
## <a name="repository-structure"></a> Repository Structure ##
26+
The <b>lib/samples</b> directory contains the Flutter widget examples for each widget such as Charts, DataGrid, etc. All the examples can be deployed in Android, iOS, and web platforms.
27+
28+
## <a name="widgets-catalog"></a>Widgets Catalog ##
29+
30+
| Widgets | Repository |
31+
| ------------- | --------------- |
32+
| Barcode Generator | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/barcodes) |
33+
| Calendar | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/calendar) |
34+
| Charts | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/chart) |
35+
| DataGrid | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/datagrid) |
36+
| Date Range Picker | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/date_picker) |
37+
| Maps | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/maps) |
38+
| PDF | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/pdf) |
39+
| PDF Viewer | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/pdf_viewer) |
40+
| Progress Bar | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/progress_bar) |
41+
| Radial Gauge | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/gauge) |
42+
| Range Selector | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/sliders/range_selector) |
43+
| Range Slider | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/sliders/range_slider) |
44+
| Slider | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/sliders/slider) |
45+
| Spark Charts | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/sparkline) |
46+
| Signature Pad | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/signature_pad) |
47+
| XlsIO | [Link](https://github.com/syncfusion/flutter-examples/tree/master/lib/samples/xlsio) |
48+
49+
## <a name="license"></a>License ##
50+
51+
Syncfusion has no liability for any damage or consequence that may arise by the use or viewing of the examples. The examples are for demonstrative purposes and if you choose to use or access the examples you agree to not hold Syncfusion liable, in any form, for any damage that is related to use, accessing or otherwise viewing the examples. By accessing, viewing, or otherwise seeing the examples you acknowledge and agree Syncfusion’s examples will not allow you to seek injunctive relief in any form for any claim related to the sample. If you do not agree to this, do not view, access, utilize or otherwise do anything with Syncfusion’s examples.
52+
53+
## <a name="using-the-examples"></a>Using the examples ##
54+
55+
**Step 1**
56+
57+
Unzip the downloaded flutter example archive.
58+
59+
**Note:** If you clone this repository ignore this step.
60+
61+
**Step 2**
62+
63+
Open the flutter example folder in an IDE.
64+
65+
**Step 3**
66+
67+
Run the following command to get the required packages.
68+
69+
```dart
70+
$ flutter pub get
71+
```
72+
73+
**Step 4**
74+
75+
Run your application either using `F5` or `Run > Start Debugging`.
76+
77+
## Get the demo application
78+
79+
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.
80+
81+
<p align="center">
82+
<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>
83+
<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>
84+
</p>
85+
<p align="center">
86+
<a href="https://github.com/syncfusion/flutter-examples"><img src="https://cdn.syncfusion.com/content/images/FTControl/GitHub.png"/></a>
87+
<a href="https://flutter.syncfusion.com"><img src="https://cdn.syncfusion.com/content/images/FTControl/web_sample_browser.png"/></a>
88+
</p>
89+
90+
## Useful links
91+
Take a look at the following to learn more about Syncfusion Flutter widgets:
92+
93+
* [Syncfusion Flutter product page](https://www.syncfusion.com/flutter-widgets)
94+
* [User guide documentation](https://help.syncfusion.com/flutter/introduction/overview)
95+
* [API reference](https://help.syncfusion.com/flutter/introduction/api-reference)
96+
* [Knowledge base](https://www.syncfusion.com/kb/flutter)
97+
* [Video tutorials](https://www.syncfusion.com/tutorial-videos/flutter)
98+
99+
## Support and feedback
100+
101+
* 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).
102+
* To renew the subscription, click [renew](https://www.syncfusion.com/sales/products) or contact our sales team at [email protected] | Toll Free: 1-888-9 DOTNET.
103+
104+
## About Syncfusion
105+
106+
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.
107+
108+
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.

images/flutter_examples.png

107 KB
Loading

0 commit comments

Comments
 (0)