https://github.com/pingbird/boxy

Overcome limitations of built-in layouts, advanced flex, custom multi-child layouts, slivers, and more!
https://github.com/pingbird/boxy

flutter

Last synced: 26 days ago
JSON representation

Overcome limitations of built-in layouts, advanced flex, custom multi-child layouts, slivers, and more!

• Host: GitHub
• URL: https://github.com/pingbird/boxy
• Owner: pingbird
• License: other
• Created: 2020-03-11T05:30:36.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-21T02:06:55.000Z (10 months ago)
• Last Synced: 2024-09-28T12:04:36.032Z (about 1 month ago)
• Topics: flutter
• Language: Dart
• Homepage: https://boxy.wiki
• Size: 15.8 MB
• Stars: 456
• Watchers: 4
• Forks: 25
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![boxy, Layout made simple](https://i.tst.sh/zncIM.png)

## About

Boxy is a Flutter package created to overcome the limitations of built-in layout widgets, it provides utilities for flex, custom multi-child layouts, dynamic widget inflation, slivers, and more!

The package is ready for production use, it has excellent documentation, test coverage, and passes strict analysis.

Check out the new wiki! https://boxy.wiki

## Flex layouts

A common design problem is when you need one or more children of a `Row` or `Column` to have the same cross-axis size

as another child in the list, with boxy this can be achieved trivially using `BoxyRow`, `BoxyColumn` and `Dominant`.

![Using BoxyRow. A sidebar matches the height of a dynamically sized container](https://i.tst.sh/WDmbR.png)

![Using BoxyColumn. An underbar matches the width of a dynamically sized container](https://i.tst.sh/FdoiA.png)

![Using BoxyColumn and BoxyFlexible.align; The top child has a custom cross axis alignment from the others](https://i.tst.sh/Bn42V.png)

See the documentation of [BoxyRow](https://pub.dev/documentation/boxy/latest/flex/BoxyRow-class.html) and

[BoxyColumn](https://pub.dev/documentation/boxy/latest/flex/BoxyColumn-class.html) for more information.

## Custom layouts

One of the pains of implementing custom layouts is learning the `RenderObject` model and how verbose it is, to make this

process easier we provide an extremely simple container `CustomBoxy` that delegates layout, paint, and hit testing.

![1. Declare widget using CustomBoxy 2. Implement delegate. Dynamic header and content in a column with an avatar pinned to the center of both](https://i.tst.sh/e0M7b.png)

The most powerful feature of `CustomBoxy` is the ability to inflate arbitrary widgets at layout time, this means widgets

can depend on the size of others, something previously impossible without hacky workarounds.

![Lazy-loading children with BoxyDelegate.inflate to match the width of a container](https://i.tst.sh/sYQHo.png)

See the documentation of [CustomBoxy](https://pub.dev/documentation/boxy/latest/boxy/CustomBoxy-class.html) and

[BoxyDelegate](https://pub.dev/documentation/boxy/latest/boxy/BoxyDelegate-class.html) for more information.

## Slivers

Ever want to give SliverList a box decoration? The [sliver](https://pub.dev/documentation/boxy/latest/sliver) library

provides [SliverContainer](https://pub.dev/documentation/boxy/latest/slivers/SliverContainer-class.html) which allows

you to use box widgets as the foreground or background of a sliver.

This library also provides [SliverCard](https://pub.dev/documentation/boxy/latest/slivers/SliverCard-class.html), a

[SliverContainer](https://pub.dev/documentation/boxy/latest/slivers/SliverContainer-class.html) that looks like a card.

![Adding a custom card-like background to a SliverList, while still building lazily](https://i.tst.sh/iiyrk.png)

Also check out:

* [SliverPadding](https://api.flutter.dev/flutter/widgets/SliverPadding-class.html), an underrated built-in widget

* [sliver_tools](https://pub.dev/packages/sliver_tools), a cool package that does similar things

## Miscellaneous

The [utils](https://pub.dev/documentation/boxy/latest/utils/utils-library.html) library provides extensions with dozens

of axis-dependant methods on `BoxConstraints`, `Size`, `Offset`, and more. These extensions make writing directional

layouts significantly less cumbersome.

The [OverflowPadding](https://pub.dev/documentation/boxy/latest/padding/OverflowPadding-class.html) widget is similar to

`Padding` but allows the child to overflow when given negative insets.