README.md

The easy way to unnest even the most complicated of widget trees, based on the power of the upcoming macros feature.

---

IMPORTANT

This library is now abandoned since macros have been canceled.

If you would like this package name on pub.dev, please email me at contact at gsconrad dot com so I can transfer ownership.

Features

• 📦 Unnests widget trees in an easy, declarative way
• 🤲 Effectively divides state management logic and stateless UI code
• 😌 Super simple: concept and initial prototype created in a single day!
• 🤝 Works well with your choice of state management solution

Sponsors

You can become a sponsor of my work here!

Getting Started

Step 1: Add Unnested

First, simply run flutter pub add unnested

Step 2: Configure Unnested

Next, create an unnested_config.dart somewhere in your project (exact filename/location do not matter):

@unnested
import 'package:flutter/material.dart';
@unnested
import 'package:my_app/my_custom_widget.dart';
// other Widget imports with @unnested...

Step 3: Use Unnested

Finally, using Unnested is as simple as:

Stateless Widgets

Widget build(BuildContext context) => Unnest()
    .container(
      width: 40,
      height: 40,
      color: Colors.yellow,
    )
    .center()
    .text('Hello World!');

Stateful Widgets

// This example uses ReArch, a modern state management solution.
// After you are done here, go check it out!
@rearchWidget
Widget _countDisplay(WidgetHandle use) => Unnest()
    .padding(padding: const EdgeInsets.all(8))
    .text('${use(countCapsule)}'); // simply reference your state variables

Including Custom Widgets

In your Unnested configuration file:

@unnested
import 'package:my_app/my_custom_widget.dart';
// other Widget imports with @unnested...

In your other files:

Widget build(BuildContext context) => Unnest()
    .center()
    .myCustomWidget(foo: bar);

Widgets With Named Constructors (e.g., SizedBox.shrink())

Widget build(BuildContext context) => Unnest()
    .sizedBox_shrink() // just use an underscore
    .someOtherWidget();

When the Last Widget Consumes a child

Widget build(BuildContext context) => Unnest()
    .container( // Container() has a "child" parameter
      color: Colors.red,
      width: 40,
      height: 40,
    )
    .end(); // finishes the build when the previous Widget consumes a child

Creating Reusable Widgets

Widget build(BuildContext context) => Unnest()
    .center()
    .end(child); // you can end() with a child Widget

Step 4: Going Beyond

Here are some helpful hints to make working with Unnested easier.

• Unnested plays very nicely with ReArch for state management, as they are sister projects
• Create a widgets Flutter package and use a monorepo tool like Melos
  • Helps split up your code in a logical way too!
• When using Unnested to create stateless widgets, using the => syntax for build functions helps reduce code whitespace/padding near the start of the line
• It is not always a good idea to use Unnested everywhere in your project!
  • For simple widgets, ideally with 2 or less levels of depth, it is often more readable to write out the widgets normally
  • See the example application for more details