# NyFutureBuilder

<div id="introduction"></div>

## Introduction to NyFutureBuilder

The **NyFutureBuilder** is a helpful widget for handling `Future`'s in your Flutter projects.
It will display a loader while the future is in progress, after the Future completes, it will return the data via the `child` parameter.

Let's dive into some code.

1. We have a Future that returns a String
2. We want to display the data on the UI for our user

``` dart
// 1. Example future that takes 3 seconds to complete
Future<String> _findUserName() async {
  await sleep(3); // wait for 3 seconds
  return "John Doe";
}

// 2. Use the NyFutureBuilder widget
@override
Widget build(BuildContext context) {
  return Scaffold(
    body: SafeArea(
       child: Container(
         child: NyFutureBuilder<String>(future: _findUserName(), child: (context, data) {
           // data = "John Doe"
           return Text(data!);
         },),
       ),
    ),
  );
}
```

> This widget will handle the loading on the UI for your users until the future completes.

<div id="customizing-the-nyfuturebuilder"></div>

## Customizing the NyFutureBuilder

You can pass the following parameters to the `NyFutureBuilder` class to customize it for your needs.

#### Options:

``` dart 
@override
Widget build(BuildContext context) {
  return Scaffold(
    body: SafeArea(
       child: NyFutureBuilder(
         future: NyStorage.read("product_name"), 
         child: (context, data) {
            return Text(data);
         },
         loadingStyle: LoadingStyle.normal(child: Text("Loading...")), // change the default loader
         onError: (AsyncSnapshot snapshot) { // handle exceptions thrown from your future.
           print(snapshot.error.toString());
           return Text("Error");
         },
       )
    ),
  );
}
```