Introduction to Syncfusion Flutter Widgets Documentation

20 Nov 20242 minutes to read

The Syncfusion Flutter Widgets are a set of advanced custom widgets and file formats packages needed to create rich and high-quality cross-platform applications in iOS, Android, and Web using a single code base. This article gives you a quick overview of how to read the Flutter widgets documentation and other help resources such as video tutorials, code examples, demos, and the knowledge base.

How to best read this user guide

  • The best way to read the user guide is to start with the Getting Started section of the documentation for the widget or library that you need. The Getting Started guide gives the needed information to write the code. This is the only section recommended for end-to-end reading before writing the code. All other information can be referred when needed. The widgets catalog section helps you find the user guide link and its package in pub.dev.
  • Now, that you are familiar with the basics of using the widget, the next step would be to start integrating the library into your application. It is very likely that you would find a code example that resembles your intended usage scenario.
  • After you have integrated the component into your application, it is likely that you would need additional information on specific features and API. Search the specific topic using the search box available at the top of the user guide.

Additional help resources

The user guide itself has enough information to get you up and running. However, there are other valuable resources you must be aware of.

API References

The API reference is a valuable resource that provides detailed information on the classes and its members.

Widget Examples

The widgets examples section contains the GitHub link for each widget’s codes examples. This is very useful when you want to learn by practice.

Knowledge Base

The Knowledge Base section contains responses for some of the most common questions other customers had asked in the past. You can search for topics that are not covered in the user guide.
Similar to the Knowledge Base, the Forum section also contains responses for questions asked in the past.

Video Tutorials

Video tutorials of our widgets can be found here.

Demos

Explore the full capabilities of our Flutter widgets on your device by installing our sample browser applications from the below app stores, and view code samples in GitHub.

Flutter Google Play Store Flutter Web Sample Browser Flutter Windows Store
Flutter macOS App Center Flutter Snap Store Flutter GitHub Samples

Create a support incident

In case, you are not able to find the information that you are looking for in the self-help resources mentioned above, please contact us by creating a support ticket.