tawasuyu

tawasuyu/taffy

A high performance rust-powered UI layout library

HTML 5544Rust 89Markdown 11TOML 91930 Sutichaykuna

⎇ 4fcdaac6dcc35a83127e65158cb0aca2f2060296 CHANGELOG.md Markdown · 1071 siq'ikuna · 49.5 KB Ñawpa willay ch'uya

Change numeric style helpers to accept Into<f64> to avoid f32-fallback lint (#974) (#983) 4fcdaac6d · Nico Burns ·

1# Changelog
2
3## Unreleased
4
5### Fixed
6
7- Numeric style helpers (`length`, `percent`, `fr`, `flex`) now accept `Input: Into<f64>` instead of `Input: Into<f32>`. This allows bare float literals such as `length(800.0)` to be used without triggering the `float_literal_f32_fallback` future-compatibility lint, while widening the set of accepted numeric input types (#974)
8
9## 0.12.2
10
11### Fixed
12
13- Block: return margin-collapsing outputs from vertical axis ComputeSize calls (#976)
14
15## 0.12.1
16
17This release container a couple of critical fixes for layout/caching bugs in the 0.12.0 release.
18
19### Fixed
20
21- Block: don't commit deferred in-flow layouts to the tree when only computing size (#971)
22- Block: pass through the requested `run_mode` when performing final layout on in-flow children, instead of always using `MeasureSize` (#972)
23
24## 0.12.0
25
26The MSRV for this release is 1.71.
27
28### Block: support for `align-content` (#959)
29
30Block containers now implement `align_content` along the block axis for their in-flow children.
31
32### More correct caching logic
33
34- The cache key now includes the axis, parent size, and available space, and ignores available space in an axis when a known dimension is set there. This is a performance hit (~10% in common cases, ~60% in pathalogically ones) but is necessary for correctness. It does also enable early-return optimizations (in cases where only the horizontal size is needed, which can allow that performance to be recouped in some cases (#911)
35
36### Fixed
37
38- Flexbox: fall back to safe `align-self` of `start` on absolute-position overflow (#958)
39- Block: derive definite height from `aspect-ratio` at final layout. A block container with `aspect-ratio` and an automatic height now becomes definite when its width is filled/stretched, so children's percentage heights resolve correctly and the ratio is preserved (#965)
40
41## 0.11.0
42
43The MSRV for this release is 1.71.
44
45### Implemented safe alignment keywords (#952)
46
47Taffy now implements [safe alignment](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Properties/align-items#safe) (in addition to unsafe alignment).
48
49The alignment style types are now structs consisting of an `AlignmentKeyword` and an `AlignmentSafety` modifier. For most users this will mean changing from using enum variants like `AlignContent::Start` to associated constants like `AlignContent::START`.
50
51This change applies to the `AlignContent`, `JustifyContent`, `AlignItems`, `JustifyItems`, `AlignSelf`, and `JustifySelf` types.
52
53### Fixed
54
55- Grid: resolve item percentages against grid area rather than grid container (#960)
56
57## 0.10.1
58
59### Fixed
60
61- CSS Grid auto-repeat and minimum-size handling (#946)
62
63## 0.10.0
64
65The MSRV for this release is 1.71.
66
67### Support for `direction`
68
69The `direction` property is now supported, allowing for RTL layout of boxes in Block, Flexbox, and CSS Grid layout modes.
70
71### Support for floats
72
73The `float` and `clear` properties are now supported. Support consists of a general-purpose `FloatContext` in the `compute` module, and integration of float layout into Block layout. Block layout now also has a `BlockContext` that allows a `FloatContext` to be shared across an entire Block formatting context.
74
75Float support is feature flagged by the `float_layout` feature.
76
77### Support for parsing styles from CSS string (#929)
78
79All of Taffy's style types (except the top-level `Style` struct) now have `FromStr` implementations that parses the type from the CSS representation of that value (e.g. `30px` or `50%` for `LengthPercentage`. A future version of Taffy will likely add support for parsing `Style` from `;`-seperated CSS.
80
81CSS parsing is feature flagged by the `parse` feature.
82
83Additionally the `parse_faster` feature enables optimizations for faster parsing at the cost of pulling in proc-macro dependencies such as `syn`.
84
85### Changed
86
87- Make DetailedGridTracksInfo accessible from a public module (#899)
88- Add `TaffyTree::write_tree` method to debug print the tree into an arbitrary writer (#925)
89- The cache `set` and `set` APIs now take `&LayoutInput` rather than individual values (#933)
90
91### Fixed
92
93- Flexbox: apply gap even when there are auto margins (#938)
94
95## 0.9.3
96
97### Added
98
99- Added write_tree method to utils.
100
101## 0.9.2
102
103### Fixed
104
105- Fix wrong size propogation for absolute elements (#878)
106- Fix bounds check in CellOccupancyMatrix::last_of_type (#890)
107- Use doc_cfg instead of doc_auto_cfg (#868)
108
109### Changed
110
111- Upgraded grid dependency from 0.18 to 1.0 (#864)
112
113## 0.9.1
114
115### Fixed
116
117- Flexbox: don't apply cross-axis stretch alignment to children with auto margins (#861)
118
119## 0.9.0
120
121The MSRV for this release is 1.65.
122
123### Support for named grid lines and grid areas
124
125Taffy now supports named grid lines and areas.
126
127As these rely on arbitrary user-provided strings, Taffy's `Style` struct is now generic
128over a string-like type (via the `CheapCloneStr` trait). Additionally as the `grid` feature is optional,
129it has a `PhantomData` field of that type to make type inference work.
130
131### Changed
132
133- `PrintTree` and `RoundTree`: use `Layout` instead of `&Layout` (#849).
134- Renamed `TrackSizingFunction` to `GridTemplateComponent`
135- Renamed `NonRepeatedTrackSizingFunction` to `TrackSizingFunction`
136- The `Repeat` variant of `GridTemplateComponent` now contains a new `GridTemplateRepetition` struct, which allows
137  line names to be specifed in addition to tracks.
138- The way that grid styles are exposed in the low-level API is now a lot more generic with many associated types.
139
140### Added
141
142- `GridTemplateArea` struct and `Style::grid_template_areas` field
143- `Style::grid_template_column_names` and `Style::grid_template_row_names` fields. If non-empty, these
144  should have length of exactly one greater than the corresponding `grid_template_column`/`grid_template_rows` style.
145
146## 0.8.3
147
148### Fixed
149
150- Fix `serde` feature on 32bit targets (#845)
151
152## 0.8.2
153
154### Fixed
155
156- Fix: Calculate correct new grid size when expanding cell_occupancy_matrix in the negative direction (#843)
157
158## 0.8.1
159
160### Added
161
162- Impl `GridItemStyle` and `BlockContainerStyle` for `Style` (#832).
163
164## 0.8.0
165
166### Highlights
167
168**The big feature in this release is support for `calc()` values in the low-level API.**
169
170To use this API:
171
172- Implement the `resolve_calc_value` method when implementing the `LayoutPartialTree` trait.
173- Pass a type-erased pointer (`*const ()`) to constructors like `LengthPercentage::calc(...)`
174
175Taffy treats the pointer as an opaque value (excepting that it uses the low 3 bits as a tag) which it will
176pass to `LayoutPartialTree::resolve_calc_value` along with a percentage resolution basis when it needs to
177resolve the value.
178
179### Changed
180
181- The representation of many "size" types is now a tagged pointer than an enum. This is to enable `calc()`.
182  The effected types are `LengthPercentage`, `LengthPercentageAuto`, `Dimension`, `MinTrackSizingFunction`, and
183`MaxTrackSizingFunction` types.
184
185### Added
186
187- Special-case "compressible replaced elements" in grid sizing algorithm (#807)
188  This allows for more correct sizing of "replaced" elements such as images that are children
189  of flexbox or grid containers.
190
191### Fixed
192
193- Grid: Fix infinite loop due to float precision in grid layout maximise tracks step (#792)
194- Grid: Fix removed wrong addition, causing items to be misplaced. (#817)
195- Grid: Fix grid placement for items with fixed primary axis (#818)
196- Leaf layout: don't set available space to max-size (#819)
197
198## 0.7.7
199
200### Fixed
201
202- Add `#[inline]` annotation to some methods on `TaffyTree` (#802)
203- Add `TaffyTree::remove_children_range` method (#802)
204
205## 0.7.6
206
207### Fixed
208
209- Fix infinite loop due to float precision in grid layout maximise tracks step (#792)
210
211## 0.7.5
212
213### Fixed
214
215- Grid: only stretch auto tracks if content-alignment is stretch (#783)
216
217## 0.7.4
218
219### Fixed
220
221- Fix detailed grid info for empty grid (#782)
222
223## 0.7.3
224
225### Fixed
226
227- Make `TaffyTree::detailed_layout_info` take `&self` rather than `&mut self` (#779)
228
229## 0.7.2
230
231### Added
232
233- The ability to access computed track sizes and item positions of a CSS Grid layout (#772).
234  This information can be accessed using the `LayoutGridContainer::set_detailed_grid_info` method
235  in the low-level API or the `TaffyTree::detailed_layout_info` method in the high-level API.
236
237## 0.7.1
238
239### Fixed
240
241- Improve interaction of abspos children of block containers with margin collapsing (#760)
242
243### Added
244
245- Add `TaffyTree::unrounded_layout` getter (#765)
246
247### Removed
248
249- The `num-traits` dependency was removed (#761) (#762)
250
251## 0.7.0
252
253### Changed
254
255- BREAKING: The `cache_mut` method on the `LayoutPartialTree` trait has been replaced with a separate `CacheTree` trait. This allows
256  Taffy to be more easily used without caching or with a custom cache implementation.
257- BREAKING: the `TaffyTree::set_children` method now removes the children from their previous parent (if they have one).
258
259### Added
260
261- Helper methods to retrieve content-box sizes were added to `Layout`
262
263## 0.6.3
264
265### Fixes
266
267- Block: ignore margin collapsing when computing static position of abspos items (#747)
268
269## 0.6.2
270
271### Fixes
272
273- Fix: clamp indefinite available space by min- and max- size as appropriate (#742)
274
275## 0.6.1
276
277### Fixes
278
279- Fix calculation of `auto-fill`/`auto-fit` repetition count when container has a definite percentage size (#722)
280- Fix min-size style not affecting intrinsic sizes (#723)
281- Fix documentation of dirty and mark_dirty functions (#724)
282- Fix intrinsic size of scroll containers that have a small explicit flex-basis (#728)
283
284## 0.6.0
285
286### Highlights
287
288- The `Style` struct has been "traitified". This supports Taffy's integration in Servo and generally makes Taffy more flexible. The
289  `Style` struct still exists and implements the new traits so existing uses of Taffy will continue to work as before.
290- The `box-sizing` style is supported
291- Computed margins are output in `Layout`
292
293### Fixes
294
295- Fix `print_tree()` when rounding is disabled (#680)
296- Absolute Insets should be resolved against the container size minus border (#666)
297- Fix flooring hypothetical_main_size by computed min size (#689)
298- Fix flex line cross-size determination (#690)
299- Fix panics in the grid algorithm (#691)
300- Fix resolving flexible lengths (WPT css/flexbox-multiline-min-max test) (#692)
301- Fix wrapping when a max main size style is present (#694)
302- Fix case where Taffy allowed margins to collapse through an element when it shouldn't have (#695)
303
304### Added
305
306- Legacy text align (for laying out `<center>` and `<div align="..">`) is supported
307- Add `is_table` for block items (#701)
308- Impl `Debug` and `Clone` for `Cache` (#688)
309- Implement `Debug` and `PartialEq` for tree types (#697)
310
311## 0.5.2
312
313- Fix block stretch sizing (don't always apply stretch sizing to block containers) (#674)
314- Fix computation of intrinsic main size when it depends on a child's known cross size (#673)
315- Fix panic when GridLine 0 is specified (#671)
316- Docs: Document feature flags and scrape examples (#672)
317- Docs: Update cosmic-text example to cosmic-text 0.12 (#670)
318
319## 0.5.1
320
321- Fix: Clamp block item stretch widths by their min and max width (#664)
322- Fix: Auto margin computation in block layout (#663)
323
324## 0.5.0
325
326The changes in 0.5 are relatively small but the new measure function parameter is a breaking change so it requires a minor version bump.
327
328- Added: A `style: &Style` parameter has been added to measure functions.
329- Added: The `MaybeMath`, `MaybeResolve`, and `ResolveOrZero` traits have been made public.
330- Fix: use SizingMode::Inherent when sizing absolute children of flexbox nodes.
331
332## 0.4.4
333
334### Fixes
335
336- Content alignment (`align-content`/`justify-content`) behaviour was updated to match the latest spec (and Chrome 123+) (#635)
337- Ensure that root Flexbox nodes are floored by their padding-border (#651, #655)
338- Use grid area size not available space when applying aspect ratio to grid containers (#656)
339
340## 0.4.3
341
342### Fixes
343
344- Fix compilation error in `evenly_sized_tracks` style helper in recent versions of rustc caused by a change/regression in type
345  inference (#643). Note that 3rd-party code that call style helpers that take an `Into<f32>` parameter may still be affected by this issue,
346  but they should be able to fix on their side by clarifying the type passed in
347
348## 0.4.2
349
350- Fixed: single-line flex-container should clamp the line's cross-size (#638)
351- Reduced binary footprint of Taffy from around 300kb to around 150kb (#636)
352
353## 0.4.1
354
355- Fixed: CSS Grid track sizing not respecting growth limits in some circumstances (#624)
356
357## 0.4.0
358
359### Highlights
360
361- Support for CSS Block layout (`display: block`)
362- Support for the `overflow` property (+ `scrollbar_width` for `overflow: scroll`)
363- Improved measure function API
364- Completely refactored low-level API
365- Simplified module hierarchy (+ most types/functions are now exported from the crate root)
366- Expanded set of examples which better document integration with other layout systems (e.g. text layout)
367- Computed values for `padding` and `border` are now output into the `Layout` struct
368
369### Block layout
370
371Support for [CSS Block layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flow_Layout/Block_and_Inline_Layout_in_Normal_Flow#elements_participating_in_a_block_formatting_context) has been added. This can be used via the new `Display::Block` variant of the `Display` enum. Note that  full flow layout: inline, inline-block and float layout have *not* been implemented. The use case supported is block container nodes which contain block-level children.
372
373### Overflow property
374
375Support has been added for a new `overflow` style property with `Visible`, `Clip`, `Hidden`, and `Scroll` values (`Auto` is not currently implemented). Additionally a `scrollbar_width` property has been added to control the size of scrollbars for nodes with `Overflow::Scroll` set.
376
377- Overflow is settable indpendently in each axis.
378- `Visible` and `Clip` will produce layouts equivalent to the Taffy 0.3. `Clip` will affect the new `content_size` output by restricting it to the available space.
379- `Hidden` and `Scroll` affect layout by changing the automatic minimum size of Flexbox and Grid children
380- `Scroll` additionally reserves `scrollbar_width` pixels for a scrollbar in the opposite axis to which scrolling is enabled. `Scroll` with `scrollbar_width` set to zero is equivalent to `Hidden`.
381
382### Measure function changes
383
384The "measure function" API for integrating Taffy with other measurement systems (such as text layout) has been changed to be more flexible
385and to interact better with borrow checking (you can now borrow external data in your measure function!).
386
387- There are no longer per-node measure functions.
388- There is now a single "global" measure function, and a per-node "context" of a user-defined type
389- The `Taffy` tree is now a generic `TaffyTree<T>` where `T` is the "context" type.
390- The measure function is now called for all leaf nodes (nodes without children). If you wish to maintain compatibility with the previous
391  behaviour then your measure function should return `Size::ZERO` for leaf nodes whose context is `None`.
392
393If you are not using measure functions, then the only change you will need to make is from:
394
395```rust
396let mut tree = Taffy::new();
397```
398
399to
400
401```rust
402let mut tree : TaffyTree<()> = TaffyTree::new();
403```
404
405And generally update any uses of `Taffy` in your codebase to `TaffyTree<()>`.
406
407If you are using measure functions then you will need to make some bigger (but straightforward) changes. The following Taffy 0.3 code:
408
409```rust
410let mut tree = Taffy::new();
411let leaf = tree.new_leaf_with_measure(
412  Style::DEFAULT,
413  |known_dimensions: Size<Option<f32>>, available_space: Size<AvailableSpace>| Size { width: 100.0, height: 200.0 }
414);
415tree.compute_layout(leaf, Size::MAX_CONTENT);
416```
417
418Should become something like the following with Taffy 0.4:
419
420```rust
421let mut tree : TaffyTree<Size> = TaffyTree::new();
422let leaf = tree.new_leaf_with_context(Style::DEFAULT, Size { width: 100.0, height: 200.0 });
423tree.compute_layout_with_measure(
424  leaf,
425  Size::MAX_CONTENT,
426  |known_dimensions: Size<Option<f32>>, available_space: Size<AvailableSpace>, node_id: NodeId, node_context: Option<Size>| {
427    node_context.unwrap_or(Size::ZERO)
428  }
429);
430```
431
432Note that:
433
434- You can choose any type instead of `Size` in the above example. This includes your own custom type (which can be an enum or a trait object).
435- If you don't need a context then you can use `()` for the context type
436- As the single "global" measure function passed to `compute_layout_with_measure` only needs to exist for the duration of a single layout run,
437  it can (mutably) borrow data from it's environment
438
439### Low-level API (`LayoutTree` trait) refactor
440
441The low-level API has been completely reworked:
442
443- The `LayoutTree` trait has been split into 5 smaller traits which live in the `taffy::tree:traits` module (along with their associated documentation)
444- The following methods have been removed from split `LayoutTree` traits entirely: `parent`, `is_childless`, `measure_node`, `needs_measure`, and `mark_dirty`.
445- `taffy::node::Node` has been replaced with `taffy::NodeId`. This should make it much easier to implement the low-level traits as the underlying type backing the node id now a `u64` rather than a `slotmap::DefaultKey`.
446- Support for running each layout algorithm individually on a single node via the following top-level functions:
447  - `compute_flexbox_layout`
448  - `compute_grid_layout`
449  - `compute_block_layout`
450  - `compute_leaf_layout`
451  - `compute_root_layout`
452  - `compute_hidden_layout`
453
454It is believed that nobody was previously using the low-level API so we are not providing a migration guide. However, along with the refactor we have greatly
455improved both the documentation and have added examples using the new API, both of which are linked to from the [main documentation page](https://docs.rs/taffy).
456
457### Module hierarchy changes
458
459The specific changes are detailed below. However for most users the most significant change will be that almost all types are now re-exported from the root module. This means that module specific imports like `use taffy::layout::Layout` can now in almost all cases be replaced with the simpler `use taffy::Layout`.
460
461Specific changes:
462
463- The `math` module has been made private
464- The `axis` module has been merged into the `geometry` module
465- The debug module is no longer public. The `print_tree` function is now accessible under `util`.
466- All types from the `node`, `data`, `layout`, `error` and `cache` modules have been moved to the  the `tree` module.
467- The `layout_flexbox()` function has been removed from the prelude. Use `taffy::compute_flexbox_layout` instead.
468
469### Many APIs have been renamed to replace `points` or `Points` with `length` or `Length`
470
471This new name better describes one-dimensional measure of space in some unspecified unit
472which is often unrelated to the PostScript point or the CSS `pt` unit.
473
474This also removes a misleading similarity with the 2D `Point`,
475whose components can have any unit and are not even necessarily absolute lengths.
476
477Example usage change:
478
479```diff
480 use taffy::prelude::*;
481
482 // …
483
484 let header_node = taffy
485     .new_leaf(
486         Style {
487-            size: Size { width: points(800.0), height: points(100.0) },
488+            size: Size { width: length(800.0), height: length(100.0) },
489             ..Default::default()
490         },
491     ).unwrap();
492```
493
494### Other Changes
495
496- The `Taffy` type was renamed to `TaffyTree` and made generic of a context parameter
497- The Flexbox algorithm has now been moved behind the `flexbox` feature. The `flexbox` feature is enabled by default.
498- The `justify_self` property has been moved behind the `grid` feature.
499- Fixed misspelling: `RunMode::PeformLayout` renamed into `RunMode::PerformLayout` (added missing `r`).
500- `serde` dependency has been made compatible with `no_std` environments
501- `slotmap` dependency has been made compatible with `no_std` environments
502- Added `insert_child_at_index()` method to the `TaffyTree`. This can be used to insert a child node at any position instead of just the end.
503- Added `total_node_count()` method to the `TaffyTree` which returns the total number of nodes in the tree.
504- Added `get_disjoint_node_context_mut()` method to the `TaffyTree`. This can be used to safely get multiple mutable borrows at the same time.
505
506## 0.3.19
507
508### Fixes
509
510- Fix compilation error in `evenly_sized_tracks` style helper in recent versions of rustc caused by a change/regression in type
511  inference (#643). Note that 3rd-party code that call style helpers that take an `Into<f32>` parameter may still be affected by this issue,
512  but they should be able to fix on their side by clarifying the type passed in
513
514## 0.3.18
515
516### Fixes
517
518- Fix computation of Flexbox automatic minimum size when grid or flexbox child has an explicit width/height style set (#576)
519
520## 0.3.17
521
522### Added
523
524- Added `total_node_count` method to the `Taffy` struct. Returns the total number of nodes in the tree.
525
526## 0.3.16
527
528### Fixes
529
530- Improve performance of flexbox columns
531
532## 0.3.15
533
534### Fixes
535
536- Fix justify-content and align-content when free space is negative (content overflows container) (#549) (#551)
537
538## 0.3.14
539
540### Fixes
541
542- Flex: Fix issue where constraints were not being propagated, causing nodes with inherent aspect-ratio (typically images) to not apply that aspect-ratio (#545) (Fixes bevyengine/bevy#9841)
543
544## 0.3.13
545
546### Fixes
547
548- Fix rounding accumulation bug (#521) (Fixes #501 and bevyengine/bevy#8911)
549- Flexbox: pass correct cross-axis available space when computing an item's intrinsic main size (#522)(Fixes bevyengine/bevy#9350)
550- Flexbox: Subtract child margin not parent margin when computing stretch-alignment known size
551- Grid: Make CSS Grid algorithm correctly apply max width/height and available space when it is the root node (#491)
552- Grid: Fix CSS Grid "auto track" / placement bugs #481
553  - Fix divide by zero when using grid_auto_rows/grid_auto_columns with zero negative implicit tracks
554  - Fix over counting of tracks (leading to incorrect container heights) when auto-placing in grids that contain negative implicit tracks.
555  - Fix axis conflation in auto-placement code when grid_auto_flow is column
556  - Fix assignment of auto track sizes when initializing negative implicit tracks
557- Leaf: Apply margins to leaf nodes when computing available space for measure functions
558- Leaf: Reserve space for padding/borders in nodes with measure functions (#497)
559  
560  **NOTE: This has the potential to break layouts relying on the old behaviour.** However, such layouts would be relying on a style having no effect, so it is judged that such layouts are unlikely to exist in the wild. If this turns out not to be true then this fix will be reverted on the 0.3.x branch.
561
562### Dependencies
563
564- Upgrade `grid` to `0.10`. This eliminates the transitive dependency on `no-std-compat`.
565
566## 0.3.12
567
568### Fixes
569
570- Fix caching issue when toggling `display:none` on and off
571
572## 0.3.11
573
574### Fixes
575
576- Fix exponential blowup when laying out trees containing nodes with min and max sizes.
577
578## 0.3.10
579
580### Fixes
581
582- Fix sizing of children when the available_space < min_size (#407)
583
584## 0.3.9
585
586### Fixes
587
588- Fix caching bug where a cached result would sometimes be incorrectly used when the amount of available space increased (bevyengine/bevy#8111) and (bevyengine/bevy#8124)
589
590## 0.3.8
591
592### Fixes
593
594- Fix incorrect min-content size for `flex-wrap: wrap` nodes (bevyengine/bevy#8082)
595
596## 0.3.7
597
598### Fixes
599
600- Fix: Make `padding` and `border` floor node sizes (#372)
601- Fix: Prevent percentages contributing to min-content sizes (#388) (also fixes bevyengine/bevy#8017)
602
603## 0.3.6
604
605### Fixes
606
607- Fix: Ignore `align_content` when `flex_wrap` is set to `nowrap` (#383)
608
609## 0.3.5
610
611### Fixes
612
613- Fix `display: none` when it is set on a flexbox child (#380)
614- Fix `display: none` when it is set on a grid child (#381)
615
616## 0.3.4
617
618### Fixes
619
620- Fix `display: none` when it is set for the only node in the hierarchy (#377)
621
622## 0.3.3
623
624### Added
625
626- Added `enable_rounding` and `disable_rounding` methods to the `Taffy` struct which enable consumers of Taffy to obtain unrounded `f32` values for the computed layouts if they want them. Rounding remains enabled by default.
627
628### Fixes
629
630- Fixed rounding algorithm such that it never leaves gaps between adjacent nodes (#369)
631- Fixed compiling with the `grid` feature disabled (#370)
632- Fixed compiling with the `std` feature disabled
633
634## 0.3.2
635
636### Fixes
637
638- Allow partial nested values to be deserialized into a `Style` using the `serde` feature.
639
640## 0.3.1
641
642### Fixes
643
644- The `serde` feature now works when the `grid` feature is enabled
645
646## 0.3.0
647
648### Highlights
649
650- [CSS Grid algorithm support](#new-feature-css-grid)
651- [Style helper functions](#new-feature-style-helpers)
652
653See below for details of breaking changes.
654
655### New Feature: CSS Grid
656
657We very excited to report that we now have support for CSS Grid layout. This is in addition to the existing Flexbox layout support, and the two modes interoperate. You can set a node to use Grid layout by setting the `display` property to `Display::Grid`.
658
659#### Learning Resources
660
661Taffy implements the CSS Grid specification faithfully, so documentation designed for the web should translate cleanly to Taffy's implementation. If you are interested in learning how to use CSS Grid, we would recommend the following resources:
662
663- [CSS Grid Garden](https://cssgridgarden.com/). This is an interactive tutorial/game that allows you to learn the essential parts of CSS Grid in a fun engaging way.
664- [A Complete Guide To CSS Grid](https://css-tricks.com/snippets/css/complete-guide-grid/) by CSS Tricks. This is detailed guide with illustrations and comprehensive written explanation of the different Grid properties and how they work.
665
666#### Supported Features & Properties
667
668In addition to the usual sizing/spacing properties (size, min_size, padding, margin, etc), the following Grid style properties are supported on Grid Containers:
669
670| Property                  | Explanation                                                                                    |
671| ---                       | ---                                                                                            |
672| [`grid-template-columns`] | The track sizing functions of the grid's explicit columns                                      |
673| [`grid-template-rows`]    | The track sizing functions of the grid's explicit rows                                         |
674| [`grid-auto-rows`]        | Track sizing functions for the grid's implicitly generated rows                                |
675| [`grid-auto-columns`]     | Track sizing functions for the grid's implicitly generated columns                             |
676| [`grid-auto-flow`]        | Whether auto-placed items are placed row-wise or column-wise. And sparsely or densely.         |
677| [`gap`]                   | The size of the vertical and horizontal gaps between grid rows/columns                         |
678| [`align-content`]         | Align grid tracks within the container in the inline (horizontal) axis                         |
679| [`justify-content`]       | Align grid tracks within the container in the block (vertical) axis                            |
680| [`align-items`]           | Align the child items within their grid areas in the inline (horizontal) axis                  |
681| [`justify-items`]         | Align the child items within their grid areas in the block (vertical) axis                     |
682
683And the following Grid style properties are supported on Grid Items (children):
684
685| Property                  | Explanation                                                                                    |
686| ---                       | ---                                                                                            |
687| [`grid-row`]              | The (row) grid line the item starts at (or a span)                                             |
688| [`grid-column`]           | The (column) grid line the item end at (or a span)                                             |
689| [`align-self`]            | Align the item within it's grid area in the inline (horizontal) axis. Overrides `align-items`. |
690| [`justify-self`]          | Align the item within it's grid area in the block (vertical) axis. Overrides `justify-items`.  |
691
692[`grid-template-columns`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns
693[`grid-template-rows`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows
694[`grid-auto-rows`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-rows
695[`grid-auto-columns`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-columns
696[`grid-auto-flow`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow
697[`gap`]: https://developer.mozilla.org/en-US/docs/Web/CSS/gap
698[`align-content`]: https://developer.mozilla.org/en-US/docs/Web/CSS/align_content
699[`justify-content`]: https://developer.mozilla.org/en-US/docs/Web/CSS/justify_content
700[`align-items`]: https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
701[`justify-items`]: https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items
702[`grid-row`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row
703[`grid-column`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column
704[`align-self`]: https://developer.mozilla.org/en-US/docs/Web/CSS/align-self
705[`justify-self`]: https://developer.mozilla.org/en-US/docs/Web/CSS/justify-self
706
707The following properties and features are not currently supported:
708
709- Subgrids
710- Masonry grid layout
711- Named grid lines
712- Named areas: `grid-template-areas` and `grid-area`
713- `grid-template` or `grid` shorthand
714
715#### Example
716
717See [examples/grid_holy_grail.rs](https://github.com/DioxusLabs/taffy/blob/main/examples/grid_holy_grail.rs) for an example using Taffy to implement the so-called [Holy Grail Layout](https://en.wikipedia.org/wiki/Holy_grail_(web_design)). If you want to run this example, the don't forget the enable the CSS Grid cargo feature:
718
719```bash
720cargo run --example grid_holy_grail --features grid
721```
722
723### New Feature: Style Helpers
724
725Ten new helper functions have added to the taffy prelude. These helper functions have short, intuitive names, and have generic return types which allow them to magically return the correct type depending on context. They make defining styles much easier, and means you won't typically need to use types like `Dimension` or `TrackSizingFunction` directly.
726
727For example, instead of:
728
729```rust
730let size : Size<Dimension> = Size { width: Dimension::Points(100.0), height: Dimension::Percent(50.0) };
731```
732
733you can now write
734
735```rust
736let size : Size<Dimension> = Size { width: points(100.0), height: percent(50.0) };
737```
738
739And that same helper function will work other types like `LengthPercentage` and `MinTrackSizingFunction` that also have a `Points` variant. There are also generic impl's for `Size<T>`, `Rect<T>` and `Line<T>` which means if your node is the same size in all dimensions you can even write
740
741```rust
742let size : Size<Dimension> = points(100.0);
743```
744
745Available style helpers:
746
747<table>
748  <thead><tr><th>Type(s)</th><th colspan="2">Helpers that work with that type</th></tr></thead>
749  <tbody>
750    <tr>
751      <td rowspan="3"><code>LengthPercentage</code></td>
752      <td><code>zero()</code></td>
753      <td>Generates a <code>Points</code> variant with the value <code>0.0</code></td>
754    </tr>
755    <tr>
756      <td><code>points(val:&nbsp;f32)</code></td>
757      <td>Generates a <code>Points</code> variant with the specified value</td>
758    </tr>
759    <tr>
760      <td><code>percent(val:&nbsp;f32)</code></td>
761      <td>Generates a <code>Percent</code> variant with the specified value.<br />Note that the scale of 0-1 not 0-100.</td>
762    </tr>
763    <tr>
764      <td rowspan="2"><code>LengthPercentageAuto</code><br /><code>Dimension</code></td>
765      <td colspan="2"><i>All helpers from <code>LengthPercentage</code> and...</i></td>
766    </tr>
767    <tr>
768      <td><code>auto()</code></td>
769      <td>Generates an <code>Auto</code> variant</td>
770    </tr>
771    <tr>
772      <td rowspan="3"><code>MinTrackSizingFunction</code></td>
773      <td colspan="2"><i>All helpers from <code>LengthPercentageAuto</code>/<code>Dimension</code> and...</i></td>
774    </tr>
775    <tr>
776      <td><code>min_content()</code></td>
777      <td>Generates an <code>MinContent</code> variant</td>
778    </tr>
779      <tr>
780      <td><code>max_content()</code></td>
781      <td>Generates an <code>MinContent</code> variant</td>
782    </tr>
783    <tr>
784      <td rowspan="3"><code>MaxTrackSizingFunction</code></td>
785      <td colspan="2"><i>All helpers from <code>MinTrackSizingFunction</code> and...</i></td>
786    </tr>
787    <tr>
788      <td><code>fit_content(limit:&nbsp;LengthPercentage)</code></td>
789      <td>Generates a <code>FitContent</code> variant with the specified limit.<br />Nest the <code>points</code> or <code>percent</code> helper inside this function to specified the limit.</td>
790    </tr>
791      <tr>
792      <td><code>fr(fraction:&nbsp;f32)</code></td>
793      <td>Generates a <code>Fraction</code> (<code>fr</code>) variant with the specified flex fraction </td>
794    </tr>
795    <tr>
796      <td rowspan="3"><code>NonRepeatingTrackSizingFunction</code></td>
797      <td colspan="2"><i>All helpers from <code>MaxTrackSizingFunction</code> and...</i></td>
798    </tr>
799    <tr>
800      <td><code>minmax(min: MinTrackSizingFunction, max: MaxTrackSizingFunction)</code></td>
801      <td>Equivalent to CSS <code>minmax()</code> function.</td>
802    </tr>
803    <tr>
804      <td><code>flex(fraction:&nbsp;f32)</code></td>
805      <td>Equivalent to CSS <code>minmax(0px, 1fr)</code>. This is likely what you want if you want evenly sized rows/columns.</td>
806    </tr>
807    <tr>
808      <td rowspan="2"><code>TrackSizingFunction</code></td>
809      <td colspan="2"><i>All helpers from <code>NonRepeatingTrackSizingFunction</code> and...</i></td>
810    </tr>
811    <tr>
812      <td><code>repeat(rep: GridTrackRepetition, tracks: Vec&lt;TrackSizingFunction&gt;)</code></td>
813      <td>Equivalent to css <code>repeat()</code> function.</td>
814    </tr>
815    <tr>
816      <td><code>Vec&lt;TrackSizingFunction&gt;</code></td>
817      <td><code>evenly_sized_tracks(count:&nbsp;u16)</code></td>
818      <td>Equivalent to CSS <code>repeat(count, minmax(0px, 1fr)</code></td>
819    </tr>
820    <tr>
821      <td rowspan="3"><code>AvailableSpace</code></td>
822      <td><code>auto()</code></td>
823      <td>Generates an <code>Auto</code> variant</td>
824    </tr>
825    <tr>
826      <td><code>min_content()</code></td>
827      <td>Generates an <code>MinContent</code> variant</td>
828    </tr>
829      <tr>
830      <td><code>max_content()</code></td>
831      <td>Generates an <code>MinContent</code> variant</td>
832    </tr>
833    <tr>
834      <td><code>Size&lt;T&gt;</code></td>
835      <td colspan="2">Any helper that works for <code>T</code> will also work for <code>Size&lt;T&gt;</code> and will set both <code>width</code> and <code>height</code> to that value</td>
836    </tr>
837    <tr>
838      <td><code>Rect&lt;T&gt;</code></td>
839      <td colspan="2">Any helper that works for <code>T</code> will also work for <code>Rect&lt;T&gt;</code> and will set <code>top</code>, <code>left</code>, <code>bottom</code>, and <code>right</code> to that value</td>
840    </tr>
841  </tbody>
842</table>
843
844### Breaking API changes
845
846#### Changes to alignment style types
847
848- `AlignContent` and `JustifyContent` has been merged.
849  - `JustifyContent` is now an alias of `AlignContent` and contains the `Stretch` variant.
850  - This variant will be *ignored* (falling back to `Start`) when applied Flexbox containers. It is valid value for Grid containers.
851- `AlignItems` and `AlignSelf` have been merged.
852  - The `Auto` variant of `AlignSelf` has been removed. You should now use `Option::None` if you wish to specify `AlignSelf::Auto`.
853  - `AlignSelf` is now an alias of `AlignItems`.
854  - `JustifyItems` and `JustifySelf` aliases have been added. These properties have no affect on Flexbox containers, but apply to Grid containers.
855- `Default` impls have been removed from all alignment types. This is because the correct default varies by property, and the types are now shared between multiple properties. The `Style` struct still has a default for each alignment property, so this is considered unlikely to affect you in practice.
856
857#### Strict style types
858
859- New types `LengthPercentage` and `LengthPercentageAuto` have been added.
860  - `LengthPercentage` is like `Dimension` but only contains the `Points` and `Percent` variants, which allows us to increase type safety for properties that don't support the `Auto` value.
861  - `LengthPercentageAuto` is currently identical to `Dimension` but will allow us to expand dimension in future to support values like `MinContent`, `MaxContent` and `FitContent`.
862- Some style properties have been updated to use either `LengthPercentage` or `LengthPercentageAuto` instead of `Dimension`. You will need to update your code, but it is recommended that you use the new style helpers (see above) rather than using the new types directly (although you certainly can use them directly if you want to).
863
864#### Position properties renamed
865
866- The `position` property is now renamed to `inset` and is now in line with [CSS inset specs](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)
867- The `position_type` property is now renamed to `position` and is now in line with [CSS position specs](https://developer.mozilla.org/en-US/docs/Web/CSS/position). The `PositionType` enum has been similarly renamed to `Position`.
868
869#### Changes to `LayoutTree`
870
871- Added generic associated type to `LayoutTree` for a `ChildIter`, an iterator on the children of a given node.
872- Changed the `children` method of `LayoutTree` to return the `ChildIter` generic associated type to allow for custom tree storage implementations which do not store the children of a node contiguously.
873- Added `child_count`  method to `LayoutTree` for querying the number of children of a node. Required because the `children` method now returns an iterator instead of an array.
874- Added `is_childless` method to `LayoutTree` for querying whether a node has no children.
875
876#### `AvailableSpace` has been moved
877
878The `AvailableSpace` enum has been moved from the `layout` module to the `style` module. If you are importing it via the prelude then you will unaffected by the change.
879
880### Fixes
881
882- Flexbox nodes sized under a min-content constraint now size correctly (#291)
883- Aspect ratio is now applied correctly in many circumstances
884- Absolutely positioned items now apply margins correctly
885- Min/max size are now applied correctly
886- Inset applied incorrectly to relatively positioned flexbox children when both `top` and `bottom` or `left` and `right` were specified (#348)
887- Fix case where column-gap style could be used in place of row-gap style (when using a percentage gap with an indefinite container size)
888
889### Removed
890
891- Removed `top_from_points`, `bot_from_points`, `top_from_percent`, and `bot_from_percent` methods removed from `Rect<Dimension>`. These functions were incredibly specific for an unusual use case, so we would be surprised if anyone was using them. Please use the new style helpers instead.
892- Removed `min_main_size`, `max_main_size`, `min_cross_size`, `max_cross_size`, and `cross_size` methods from `Style`. Use the more general `cross` and `main` methods directly on the `size`, `min_size`, and `max_size` properties instead.
893- Removed `main_margin_start`, `main_margin_end`, `cross_margin_start`, `cross_margin_end` from `Style`. Use the more general `main_start`, `main_end`, `cross_start`, and `cross_end` on the `margin` property instead.
894
895## 0.2.2
896
897### Fixes
898
899- Border or padding on the horizontal axis could, in some cases, increase the height of nodes.
900
901## 0.2.1
902
903### Fixes
904
905- In case of conflicts, `min_size` now overrides `max_size` which overrides `size` (#261). This is the behaviour specified in the CSS specification, and was also the behaviour in Taffy `v0.1.0`, but a regression was introduced in Taffy `v0.2.0`.
906- `taffy::compute_layout` has been made public allowing Taffy to be used with custom storage (#263)
907
908## 0.2.0
909
910### New features
911
912#### Flexbox "gap" and `AlignContent::SpaceEvenly`
913
914The [gap](https://developer.mozilla.org/en-US/docs/Web/CSS/gap) property is now supported on flex containers. This can make it much easier to create even spacing or "gutters" between nodes.
915
916Additionally we have a `SpaceEvenly` variant to the `AlignContent` enum to support evenly spaced justification in the cross axis (equivalent to  `align-content: space-evenly` in CSS)
917
918#### Debug module and cargo feature
919
920Two debugging features have been added:
921
922- `taffy::debug::print_tree(&Taffy, root)` - This will print a debug representation of the computed layout of an entire node tree (starting at `root`), which can be useful for debugging layouts.
923- A cargo feature `debug`. This enabled debug logging of the layout computation process itself (this is probably mainly useful for those working taffy itself).
924
925### Performance improvements
926
927A number of performance improvements have landed since taffy 0.1:
928
929- Firstly, our custom `taffy::forest` storage implementation was ripped out and replaced with a much simpler implementation using the `slotmap` crate. This led to performance increases of up to 90%.
930- Secondly, the caching implementation was improved by upping the number of cache slots from 2 to 4 and tweaking how computed results are allocated to cache slots to better match the actual usage patterns of the flexbox layout algorithm. This had a particularly dramatic effect on deep hierarchies (which often involve recomputing the same results repeatedly), fixing the exponential blowup that was previously exhibited on these trees and improving performance by over 1000x in some cases!
931
932#### Benchmarks vs. Taffy 0.1
933
934| Benchmark                                 | Taffy 0.1 | Taffy 0.2 | % change (0.1 -> 0.2) |
935| ---                                       | ---       | ---       | ---                   |
936| wide/1_000 nodes (2-level hierarchy)      | 699.18 µs | 445.01 µs | -36.279%              |
937| wide/10_000 nodes (2-level hierarchy)     | 8.8244 ms | 7.1313 ms | -16.352%              |
938| wide/100_000 nodes (2-level hierarchy)    | 204.48 ms | 242.93 ms | +18.803%              |
939| deep/4000 nodes (12-level hierarchy))     | 5.2320 s  | 2.7363 ms | -99.947%              |
940| deep/10_000 nodes (14-level hierarchy)    | 75.207 s  | 6.9415 ms | -99.991%              |
941| deep/100_000 nodes (17-level hierarchy)   | -         | 102.72 ms | -                     |
942| deep/1_000_000 nodes (20-level hierarchy) | -         | 799.35 ms | -                     |
943
944(note that the table above contains multiple different units (milliseconds vs. microseconds vs. nanoseconds))
945
946As you can see, we have actually regressed slightly in the "wide" benchmarks (where all nodes are siblings of a single parent node). Although it should be noted our results in these benchmarks are still very fast, especially on the 10,000 node benchmark which we consider to be the most realistic size where the result is measured in microseconds.
947
948However, in the "deep" benchmarks we see dramatic improvements. The previous version of Taffy suffered from exponential blowup in the case of deeply nested hierarchies. This has resulted in somewhat silly improvements like the 10,000 node (14-level) hierarchy where Taffy 0.2 is a full 1 million times faster than Taffy 0.1. We've also included results with larger numbers of nodes (although you're unlikely to need that many) to demonstrate that this scalability continues up to even deeper levels of nesting.
949
950#### Benchmarks vs. [Yoga](https://github.com/facebook/yoga)
951
952Yoga benchmarks run via it's node.js bindings (the `yoga-layout-prebuilt` npm package), they were run a few times manually and it was verified that variance in the numbers of each run was minimal. It should be noted that this is using an old version of Yoga.
953
954| Benchmark | Yoga | Taffy 0.2 |
955| --- | --- | --- |
956| yoga/10 nodes (1-level hierarchy) | 45.1670 µs | 33.297 ns |
957| yoga/100 nodes (2-level hierarchy) | 134.1250 µs | 336.53 ns |
958| yoga/1_000 nodes (3-level hierarchy) | 1.2221 ms | 3.8928 µs |
959| yoga/10_000 nodes (4-level hierarchy) | 13.8672 ms | 36.162 µs |
960| yoga/100_000 nodes (5-level hierarchy) | 141.5307 ms | 1.6404 ms |
961
962(note that the table above contains multiple different units (milliseconds vs. microseconds vs. nanoseconds))
963
964While we're trying not to get too excited (there could easily be an issue with our benchmarking methodology which make this an unfair comparison), we are pleased to see that we seem to be anywhere between 100x and 1000x times faster depending on the node count!
965
966### Breaking API changes
967
968#### Node creation changes
969
970- `taffy::Node` is now unique only to the Taffy instance from which it was created.
971- Renamed `Taffy.new_node(..)` -> `Taffy.new_with_children(..)`
972- Renamed `Taffy.new_leaf()` -> `Taffy.new_leaf_with_measure()`
973- Added `taffy::node::Taffy.new_leaf()` which allows the creation of new leaf-nodes without having to supply a measure function
974
975#### Error handling/representation improvements
976
977- Renamed `taffy::Error` -> `taffy::error::TaffyError`
978- Replaced `taffy::error::InvalidChild` with a new `InvalidChild` variant of `taffy::error::TaffyError`
979- Replaced `taffy::error::InvalidNode` with a new `InvalidNode` variant of `taffy::error::TaffyError`
980- The following method new return `Err(TaffyError::ChildIndexOutOfBounds)` instead of panicking:
981  - `taffy::Taffy::remove_child_at_index`
982  - `taffy::Taffy::replace_child_at_index`
983  - `taffy::Taffy::child_at_index`
984- `Taffy::remove` now returns a `Result<usize, Error>`, to indicate if the operation was successful (and if it was, which ID was invalidated).
985
986#### Some uses of `Option<f32>` replaced with a new `AvailableSpace` enum
987
988A new enum `Taffy::layout::AvailableSpace` has been added.
989
990The definition looks like this:
991
992```rust
993/// The amount of space available to a node in a given axis
994pub enum AvailableSpace {
995    /// The amount of space available is the specified number of pixels
996    Definite(f32),
997    /// The amount of space available is indefinite and the node should be laid out under a min-content constraint
998    MinContent,
999    /// The amount of space available is indefinite and the node should be laid out under a max-content constraint
1000    MaxContent,
1001}
1002```
1003
1004This enum is now used instead of `Option<f32>` when calling `Taffy.compute_layout` (if you previously passing `Size::NONE` to `compute_layout`, then you will need to change this to `Size::MAX_CONTENT`).
1005
1006And a different instance of it is passed as a new second parameter to `MeasureFunc`. `MeasureFunc`s may choose to use this parameter in their computation or ignore it as they see fit. The canonical example of when it makes sense to use it is when laying out text. If `MinContent` has been passed in the axis in which the text is flowing (i.e. the horizontal axis for left-to-right text), then you should line-break at every possible opportunity (e.g. all word boundaries), whereas if `MaxContent` has been passed then you shouldn't line break at all..
1007
1008#### Builder methods are now `const` where possible
1009
1010- Several convenience constants have been defined: notably `Style::DEFAULT`
1011- `Size<f32>.zero()` is now `Size::<f32>::ZERO`
1012- `Point<f32>.zero()` is now  `Point::<f32>::ZERO`
1013- `Size::undefined()` is now `Size::NONE`
1014
1015#### Removals
1016
1017- Removed `taffy::forest::Forest`. `taffy::node::Taffy` now handles it's own storage using a slotmap (which comes with a performance boost up to 90%).
1018- Removed `taffy::number::Number`. Use `Option<f32>` is used instead
1019  - the associated public `MinMax` and `OrElse` traits have also been removed; these should never have been public
1020- Removed unused dependencies `hashbrown`, `hash32`, and `typenum`. `slotmap` is now the only required dependency (`num_traits` and `arrayvec` are also required if you wish to use taffy in a `no_std` environment).
1021
1022### Fixes
1023
1024- Miscellaneous correctness fixes which align our implementation with Chrome:
1025
1026  - Nodes can only ever have one parent
1027  - Fixed rounding of fractional values to follow latest Chrome - values are now rounded the same regardless of their position
1028  - Fixed computing free space when using both `flex-grow` and a minimum size
1029  - Padding is now only subtracted when determining the available space if the node size is unspecified, following [section 9.2.2 of the flexbox spec](https://www.w3.org/TR/css-flexbox-1/#line-sizing)
1030  - `MeasureFunc` (and hence `NodeData` and hence `Forest` and hence the public `Taffy` type) are now `Send` and `Sync`, enabling their use in async and parallel applications
1031- Taffy can now be vendored using `cargo-vendor` (README.md is now included in package).
1032
1033## 0.1.0
1034
1035### 0.1.0 Changed
1036
1037- the `order` field of `Layout` is now public, and describes the relative z-ordering of nodes
1038- renamed crate from `stretch2` to `taffy`
1039- updated to the latest version of all dependencies to reduce upstream pain caused by duplicate dependencies
1040- renamed `stretch::node::Stretch` -> `taffy::node::Taffy`
1041
1042### 0.1.0 Fixed
1043
1044- fixed feature strategy for `alloc` and `std`: these can now be compiled together, with `std`'s types taking priority
1045
1046### 0.1.0 Removed
1047
1048- removed Javascript / Kotlin / Swift bindings
1049  - the maintainer team lacks expertise to keep these working
1050  - more serious refactors are planned, and this will be challenging to keep working through that process
1051  - if you are interested in helping us maintain bindings to other languages, [get in touch](https://github.com/DioxusLabs/taffy/discussions)!
1052- the `serde_camel_case` and `serde_kebab_case` features have been removed: they were poorly motivated and were not correctly additive (if both were enabled compilation would fail)
1053- removed the `Direction` and `Overflow` structs, and the corresponding `direction` and `overflow` fields from `Style`
1054  - these had no effect in the current code base and were actively misleading
1055
1056## stretch2 0.4.3
1057
1058This is the final release of `stretch`: migrate to the crate named `taffy` for future fixes and features!
1059
1060These notes describe the differences between this release and `stretch` 0.3.2, the abandoned crate from which this library was forked.
1061
1062### Changed
1063
1064- updated [assorted dependencies](https://github.com/vislyhq/stretch/commit/a6491117379cea52dedc9584d892594a143e8cb0)
1065
1066### Fixed
1067
1068- fixed an exponential performance blow-up with deep nesting
1069- fixed percent height values, which were using parent width
1070- recomputing layout no longer moves children of non-zero-positioned parent
1071- fixed broken Swift bindings

CHANGELOG.md

Changelog

Unreleased

Fixed

0.12.2

Fixed

0.12.1

This release container a couple of critical fixes for layout/caching bugs in the 0.12.0 release.

Fixed

0.12.0

The MSRV for this release is 1.71.

Block: support for align-content (#959)

Block containers now implement align_content along the block axis for their in-flow children.

More correct caching logic

Fixed

0.11.0

The MSRV for this release is 1.71.

Implemented safe alignment keywords (#952)

Taffy now implements safe alignment (in addition to unsafe alignment).

The alignment style types are now structs consisting of an AlignmentKeyword and an AlignmentSafety modifier. For most users this will mean changing from using enum variants like AlignContent::Start to associated constants like AlignContent::START.

This change applies to the AlignContent, JustifyContent, AlignItems, JustifyItems, AlignSelf, and JustifySelf types.

Fixed

0.10.1

Fixed

0.10.0

The MSRV for this release is 1.71.

Support for direction

The direction property is now supported, allowing for RTL layout of boxes in Block, Flexbox, and CSS Grid layout modes.

Support for floats

The float and clear properties are now supported. Support consists of a general-purpose FloatContext in the compute module, and integration of float layout into Block layout. Block layout now also has a BlockContext that allows a FloatContext to be shared across an entire Block formatting context.

Float support is feature flagged by the float_layout feature.

Support for parsing styles from CSS string (#929)

All of Taffy's style types (except the top-level Style struct) now have FromStr implementations that parses the type from the CSS representation of that value (e.g. 30px or 50% for LengthPercentage. A future version of Taffy will likely add support for parsing Style from ;-seperated CSS.

CSS parsing is feature flagged by the parse feature.

Additionally the parse_faster feature enables optimizations for faster parsing at the cost of pulling in proc-macro dependencies such as syn.

Changed

Fixed

0.9.3

Added

0.9.2

Fixed

Changed

0.9.1

Fixed

0.9.0

The MSRV for this release is 1.65.

Support for named grid lines and grid areas

Taffy now supports named grid lines and areas.

As these rely on arbitrary user-provided strings, Taffy's Style struct is now generic over a string-like type (via the CheapCloneStr trait). Additionally as the grid feature is optional, it has a PhantomData field of that type to make type inference work.

Changed

Added

0.8.3

Fixed

0.8.2

Fixed

0.8.1

Added

0.8.0

Highlights

The big feature in this release is support for calc() values in the low-level API.

To use this API:

Taffy treats the pointer as an opaque value (excepting that it uses the low 3 bits as a tag) which it will pass to LayoutPartialTree::resolve_calc_value along with a percentage resolution basis when it needs to resolve the value.

Changed

Added

Fixed

0.7.7

Fixed

0.7.6

Fixed

0.7.5

Fixed

0.7.4

Fixed

0.7.3

Fixed

0.7.2

Added

0.7.1

Fixed

Added

Removed

0.7.0

Changed

Added

0.6.3

Fixes

0.6.2

Fixes

0.6.1

Fixes

0.6.0

Highlights

Fixes

Added

0.5.2

0.5.1

0.5.0

The changes in 0.5 are relatively small but the new measure function parameter is a breaking change so it requires a minor version bump.

0.4.4

Fixes

0.4.3

Fixes

0.4.2

0.4.1

0.4.0

Highlights

Block layout

Support for CSS Block layout has been added. This can be used via the new Display::Block variant of the Display enum. Note that full flow layout: inline, inline-block and float layout have not been implemented. The use case supported is block container nodes which contain block-level children.

Overflow property

Support has been added for a new overflow style property with Visible, Clip, Hidden, and Scroll values (Auto is not currently implemented). Additionally a scrollbar_width property has been added to control the size of scrollbars for nodes with Overflow::Scroll set.

Measure function changes

The "measure function" API for integrating Taffy with other measurement systems (such as text layout) has been changed to be more flexible and to interact better with borrow checking (you can now borrow external data in your measure function!).

If you are not using measure functions, then the only change you will need to make is from:

let mut tree = Taffy::new();

to

let mut tree : TaffyTree<()> = TaffyTree::new();

And generally update any uses of Taffy in your codebase to TaffyTree<()>.

If you are using measure functions then you will need to make some bigger (but straightforward) changes. The following Taffy 0.3 code:

let mut tree = Taffy::new();
let leaf = tree.new_leaf_with_measure(
  Style::DEFAULT,
  |known_dimensions: Size<Option<f32>>, available_space: Size<AvailableSpace>| Size { width: 100.0, height: 200.0 }
);
tree.compute_layout(leaf, Size::MAX_CONTENT);

Should become something like the following with Taffy 0.4:

let mut tree : TaffyTree<Size> = TaffyTree::new();
let leaf = tree.new_leaf_with_context(Style::DEFAULT, Size { width: 100.0, height: 200.0 });
tree.compute_layout_with_measure(
  leaf,
  Size::MAX_CONTENT,
  |known_dimensions: Size<Option<f32>>, available_space: Size<AvailableSpace>, node_id: NodeId, node_context: Option<Size>| {
    node_context.unwrap_or(Size::ZERO)
  }
);

Note that:

Low-level API (LayoutTree trait) refactor

The low-level API has been completely reworked:

It is believed that nobody was previously using the low-level API so we are not providing a migration guide. However, along with the refactor we have greatly improved both the documentation and have added examples using the new API, both of which are linked to from the main documentation page.

Module hierarchy changes

The specific changes are detailed below. However for most users the most significant change will be that almost all types are now re-exported from the root module. This means that module specific imports like use taffy::layout::Layout can now in almost all cases be replaced with the simpler use taffy::Layout.

Specific changes:

Many APIs have been renamed to replace points or Points with length or Length

This new name better describes one-dimensional measure of space in some unspecified unit which is often unrelated to the PostScript point or the CSS pt unit.

This also removes a misleading similarity with the 2D Point, whose components can have any unit and are not even necessarily absolute lengths.

Example usage change:

 use taffy::prelude::*;

 // …

 let header_node = taffy
     .new_leaf(
         Style {
-            size: Size { width: points(800.0), height: points(100.0) },
+            size: Size { width: length(800.0), height: length(100.0) },
             ..Default::default()
         },
     ).unwrap();

Other Changes

0.3.19

Fixes

0.3.18

Fixes

0.3.17

Added

0.3.16

Fixes

0.3.15

Fixes

0.3.14

Fixes

0.3.13

Fixes

Dependencies

0.3.12

Fixes

0.3.11

Fixes

0.3.10

Fixes

0.3.9

Fixes

0.3.8

Fixes

0.3.7

Fixes

0.3.6

Fixes

0.3.5

Fixes

0.3.4

Fixes

0.3.3

Added

Fixes

0.3.2

Fixes

0.3.1

Fixes

0.3.0

Highlights

See below for details of breaking changes.

New Feature: CSS Grid

We very excited to report that we now have support for CSS Grid layout. This is in addition to the existing Flexbox layout support, and the two modes interoperate. You can set a node to use Grid layout by setting the display property to Display::Grid.

Learning Resources

Taffy implements the CSS Grid specification faithfully, so documentation designed for the web should translate cleanly to Taffy's implementation. If you are interested in learning how to use CSS Grid, we would recommend the following resources:

Supported Features & Properties

In addition to the usual sizing/spacing properties (size, min_size, padding, margin, etc), the following Grid style properties are supported on Grid Containers:

PropertyExplanation
grid-template-columnsThe track sizing functions of the grid's explicit columns
grid-template-rowsThe track sizing functions of the grid's explicit rows
grid-auto-rowsTrack sizing functions for the grid's implicitly generated rows
grid-auto-columnsTrack sizing functions for the grid's implicitly generated columns
grid-auto-flowWhether auto-placed items are placed row-wise or column-wise. And sparsely or densely.
gapThe size of the vertical and horizontal gaps between grid rows/columns
align-contentAlign grid tracks within the container in the inline (horizontal) axis
justify-contentAlign grid tracks within the container in the block (vertical) axis
align-itemsAlign the child items within their grid areas in the inline (horizontal) axis
justify-itemsAlign the child items within their grid areas in the block (vertical) axis

And the following Grid style properties are supported on Grid Items (children):

PropertyExplanation
grid-rowThe (row) grid line the item starts at (or a span)
grid-columnThe (column) grid line the item end at (or a span)
align-selfAlign the item within it's grid area in the inline (horizontal) axis. Overrides align-items.
justify-selfAlign the item within it's grid area in the block (vertical) axis. Overrides justify-items.

The following properties and features are not currently supported:

Example

See examples/grid_holy_grail.rs for an example using Taffy to implement the so-called Holy Grail Layout. If you want to run this example, the don't forget the enable the CSS Grid cargo feature:

cargo run --example grid_holy_grail --features grid

New Feature: Style Helpers

Ten new helper functions have added to the taffy prelude. These helper functions have short, intuitive names, and have generic return types which allow them to magically return the correct type depending on context. They make defining styles much easier, and means you won't typically need to use types like Dimension or TrackSizingFunction directly.

For example, instead of:

let size : Size<Dimension> = Size { width: Dimension::Points(100.0), height: Dimension::Percent(50.0) };

you can now write

let size : Size<Dimension> = Size { width: points(100.0), height: percent(50.0) };

And that same helper function will work other types like LengthPercentage and MinTrackSizingFunction that also have a Points variant. There are also generic impl's for Size<T>, Rect<T> and Line<T> which means if your node is the same size in all dimensions you can even write

let size : Size<Dimension> = points(100.0);

Available style helpers:

<table> <thead><tr><th>Type(s)</th><th colspan="2">Helpers that work with that type</th></tr></thead> <tbody> <tr> <td rowspan="3"><code>LengthPercentage</code></td> <td><code>zero()</code></td> <td>Generates a <code>Points</code> variant with the value <code>0.0</code></td> </tr> <tr> <td><code>points(val:&nbsp;f32)</code></td> <td>Generates a <code>Points</code> variant with the specified value</td> </tr> <tr> <td><code>percent(val:&nbsp;f32)</code></td> <td>Generates a <code>Percent</code> variant with the specified value.<br />Note that the scale of 0-1 not 0-100.</td> </tr> <tr> <td rowspan="2"><code>LengthPercentageAuto</code><br /><code>Dimension</code></td> <td colspan="2"><i>All helpers from <code>LengthPercentage</code> and...</i></td> </tr> <tr> <td><code>auto()</code></td> <td>Generates an <code>Auto</code> variant</td> </tr> <tr> <td rowspan="3"><code>MinTrackSizingFunction</code></td> <td colspan="2"><i>All helpers from <code>LengthPercentageAuto</code>/<code>Dimension</code> and...</i></td> </tr> <tr> <td><code>min_content()</code></td> <td>Generates an <code>MinContent</code> variant</td> </tr> <tr> <td><code>max_content()</code></td> <td>Generates an <code>MinContent</code> variant</td> </tr> <tr> <td rowspan="3"><code>MaxTrackSizingFunction</code></td> <td colspan="2"><i>All helpers from <code>MinTrackSizingFunction</code> and...</i></td> </tr> <tr> <td><code>fit_content(limit:&nbsp;LengthPercentage)</code></td> <td>Generates a <code>FitContent</code> variant with the specified limit.<br />Nest the <code>points</code> or <code>percent</code> helper inside this function to specified the limit.</td> </tr> <tr> <td><code>fr(fraction:&nbsp;f32)</code></td> <td>Generates a <code>Fraction</code> (<code>fr</code>) variant with the specified flex fraction </td> </tr> <tr> <td rowspan="3"><code>NonRepeatingTrackSizingFunction</code></td> <td colspan="2"><i>All helpers from <code>MaxTrackSizingFunction</code> and...</i></td> </tr> <tr> <td><code>minmax(min: MinTrackSizingFunction, max: MaxTrackSizingFunction)</code></td> <td>Equivalent to CSS <code>minmax()</code> function.</td> </tr> <tr> <td><code>flex(fraction:&nbsp;f32)</code></td> <td>Equivalent to CSS <code>minmax(0px, 1fr)</code>. This is likely what you want if you want evenly sized rows/columns.</td> </tr> <tr> <td rowspan="2"><code>TrackSizingFunction</code></td> <td colspan="2"><i>All helpers from <code>NonRepeatingTrackSizingFunction</code> and...</i></td> </tr> <tr> <td><code>repeat(rep: GridTrackRepetition, tracks: Vec&lt;TrackSizingFunction&gt;)</code></td> <td>Equivalent to css <code>repeat()</code> function.</td> </tr> <tr> <td><code>Vec&lt;TrackSizingFunction&gt;</code></td> <td><code>evenly_sized_tracks(count:&nbsp;u16)</code></td> <td>Equivalent to CSS <code>repeat(count, minmax(0px, 1fr)</code></td> </tr> <tr> <td rowspan="3"><code>AvailableSpace</code></td> <td><code>auto()</code></td> <td>Generates an <code>Auto</code> variant</td> </tr> <tr> <td><code>min_content()</code></td> <td>Generates an <code>MinContent</code> variant</td> </tr> <tr> <td><code>max_content()</code></td> <td>Generates an <code>MinContent</code> variant</td> </tr> <tr> <td><code>Size&lt;T&gt;</code></td> <td colspan="2">Any helper that works for <code>T</code> will also work for <code>Size&lt;T&gt;</code> and will set both <code>width</code> and <code>height</code> to that value</td> </tr> <tr> <td><code>Rect&lt;T&gt;</code></td> <td colspan="2">Any helper that works for <code>T</code> will also work for <code>Rect&lt;T&gt;</code> and will set <code>top</code>, <code>left</code>, <code>bottom</code>, and <code>right</code> to that value</td> </tr> </tbody> </table>

Breaking API changes

Changes to alignment style types

Strict style types

Position properties renamed

Changes to LayoutTree

AvailableSpace has been moved

The AvailableSpace enum has been moved from the layout module to the style module. If you are importing it via the prelude then you will unaffected by the change.

Fixes

Removed

0.2.2

Fixes

0.2.1

Fixes

0.2.0

New features

Flexbox "gap" and AlignContent::SpaceEvenly

The gap property is now supported on flex containers. This can make it much easier to create even spacing or "gutters" between nodes.

Additionally we have a SpaceEvenly variant to the AlignContent enum to support evenly spaced justification in the cross axis (equivalent to align-content: space-evenly in CSS)

Debug module and cargo feature

Two debugging features have been added:

Performance improvements

A number of performance improvements have landed since taffy 0.1:

Benchmarks vs. Taffy 0.1

BenchmarkTaffy 0.1Taffy 0.2% change (0.1 -> 0.2)
wide/1_000 nodes (2-level hierarchy)699.18 µs445.01 µs-36.279%
wide/10_000 nodes (2-level hierarchy)8.8244 ms7.1313 ms-16.352%
wide/100_000 nodes (2-level hierarchy)204.48 ms242.93 ms+18.803%
deep/4000 nodes (12-level hierarchy))5.2320 s2.7363 ms-99.947%
deep/10_000 nodes (14-level hierarchy)75.207 s6.9415 ms-99.991%
deep/100_000 nodes (17-level hierarchy)-102.72 ms-
deep/1_000_000 nodes (20-level hierarchy)-799.35 ms-

(note that the table above contains multiple different units (milliseconds vs. microseconds vs. nanoseconds))

As you can see, we have actually regressed slightly in the "wide" benchmarks (where all nodes are siblings of a single parent node). Although it should be noted our results in these benchmarks are still very fast, especially on the 10,000 node benchmark which we consider to be the most realistic size where the result is measured in microseconds.

However, in the "deep" benchmarks we see dramatic improvements. The previous version of Taffy suffered from exponential blowup in the case of deeply nested hierarchies. This has resulted in somewhat silly improvements like the 10,000 node (14-level) hierarchy where Taffy 0.2 is a full 1 million times faster than Taffy 0.1. We've also included results with larger numbers of nodes (although you're unlikely to need that many) to demonstrate that this scalability continues up to even deeper levels of nesting.

Benchmarks vs. Yoga

Yoga benchmarks run via it's node.js bindings (the yoga-layout-prebuilt npm package), they were run a few times manually and it was verified that variance in the numbers of each run was minimal. It should be noted that this is using an old version of Yoga.

BenchmarkYogaTaffy 0.2
yoga/10 nodes (1-level hierarchy)45.1670 µs33.297 ns
yoga/100 nodes (2-level hierarchy)134.1250 µs336.53 ns
yoga/1_000 nodes (3-level hierarchy)1.2221 ms3.8928 µs
yoga/10_000 nodes (4-level hierarchy)13.8672 ms36.162 µs
yoga/100_000 nodes (5-level hierarchy)141.5307 ms1.6404 ms

(note that the table above contains multiple different units (milliseconds vs. microseconds vs. nanoseconds))

While we're trying not to get too excited (there could easily be an issue with our benchmarking methodology which make this an unfair comparison), we are pleased to see that we seem to be anywhere between 100x and 1000x times faster depending on the node count!

Breaking API changes

Node creation changes

Error handling/representation improvements

Some uses of Option<f32> replaced with a new AvailableSpace enum

A new enum Taffy::layout::AvailableSpace has been added.

The definition looks like this:

/// The amount of space available to a node in a given axis
pub enum AvailableSpace {
    /// The amount of space available is the specified number of pixels
    Definite(f32),
    /// The amount of space available is indefinite and the node should be laid out under a min-content constraint
    MinContent,
    /// The amount of space available is indefinite and the node should be laid out under a max-content constraint
    MaxContent,
}

This enum is now used instead of Option<f32> when calling Taffy.compute_layout (if you previously passing Size::NONE to compute_layout, then you will need to change this to Size::MAX_CONTENT).

And a different instance of it is passed as a new second parameter to MeasureFunc. MeasureFuncs may choose to use this parameter in their computation or ignore it as they see fit. The canonical example of when it makes sense to use it is when laying out text. If MinContent has been passed in the axis in which the text is flowing (i.e. the horizontal axis for left-to-right text), then you should line-break at every possible opportunity (e.g. all word boundaries), whereas if MaxContent has been passed then you shouldn't line break at all..

Builder methods are now const where possible

Removals

Fixes

0.1.0

0.1.0 Changed

0.1.0 Fixed

0.1.0 Removed

stretch2 0.4.3

This is the final release of stretch: migrate to the crate named taffy for future fixes and features!

These notes describe the differences between this release and stretch 0.3.2, the abandoned crate from which this library was forked.

Changed

Fixed