Skip to content

Commit ee9e8c3

Browse files
committed
Updated README
1 parent b2326ae commit ee9e8c3

2 files changed

Lines changed: 15 additions & 4 deletions

File tree

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,24 @@ flutter pub add auto_layout_frame
2424
### 💙 Use cases
2525
- 🎨 **Figma-like layouts**: Replicate Figma's Auto Layout behavior in your Flutter apps
2626
- 📱 **Responsive UI**: Build flexible, responsive layouts that adapt to different screen sizes
27-
- 🚀 **Rapid prototyping**: Quickly create complex layouts with intuitive, declarative syntax
27+
- 🚀 **Rapid prototyping**: Quickly create complex layouts with an intuitive, declarative syntax
28+
29+
<img style="width: 100%;" src="screenshots/editor.gif"/>
2830

2931

3032
## ✨ Features
31-
- **🎯 Alignment**: Control child alignment with `alignChildren` and self alignment with `alignSelf`
33+
- **🎯 Alignment**: Control child alignment with `alignChildren`
3234
- **📏 Padding & Gap**: Set padding around children and gap between them (including auto-spacing with `gap: double.infinity`)
3335
- **📐 Resizing**: Choose from `fixed`, `hugContents`, or `fillContainer` for horizontal and vertical axes
3436
- **↔️ Direction**: Layout children horizontally, vertically, or with wrapping
3537
- **🔄 Overflow handling**: Choose from `none`, `clip`, `visible`, or `scroll` behaviors
3638
- **🪆 Proper nesting**: Automatically handles nested `AutoLayoutFrame`s with correct constraint handling
3739

40+
#### Coming soon:
41+
- **📚 More docs/examples**
42+
- **🧩 More layout options**
43+
- **⚡ Performance optimizations**
44+
3845
---
3946

4047
## 🔮 Usage Guide
@@ -88,13 +95,17 @@ AutoLayoutFrame(
8895
)
8996
```
9097

91-
### Resizing Behaviors
98+
### Resizing
99+
100+
**Like Figma**, you can control how the frame resizes on both axes:
92101

93102
- **`AutoLayoutResizing.fixed`**: Fixed size (requires explicit `width`/`height`)
94103
- **`AutoLayoutResizing.hugContents`**: Shrink-wrap to fit children
95104
- **`AutoLayoutResizing.fillContainer`**: Expand to fill available space
96105

97-
### Overflow Behaviors
106+
### Overflow
107+
108+
**New!**: Control how overflow is handled when children exceed frame bounds:
98109

99110
- **`AutoLayoutOverflowBehavior.none`**: Allow overflow errors (default)
100111
- **`AutoLayoutOverflowBehavior.clip`**: Clip overflow to frame bounds

screenshots/editor.gif

2.58 MB
Loading

0 commit comments

Comments
 (0)