1# Release Notes
2
3## Unreleased
4
5### Breaking
6
7#### Measure function changes
8
9The "measure function" API for integrating Taffy with other measurement systems (such as text layout) has been changed to be more flexible,
10and to interact better with borrow checking (you can now borrow external data in your measure function!).
11
12- There are no longer per-node measure functions.
13- There is now a single "global" measure function, and a per-node "context" of a user-defined type
14- The `Taffy` tree is now a generic `Taffy<T>` where `T` is the "context" type.
15
16If you are not using measure functions, then the only change you will need to make is from:
17
18```rust
19let mut tree = Taffy::new();
20```
21
22to
23
24```rust
25let mut tree : Taffy<()> = Taffy::new();
26```
27
28And generally update any uses of `Taffy` in your codebase to `Taffy<()>`.
29
30If you are using measure functions then you will need to make some bigger (but straightforward) changes. The following Taffy 0.3 code:
31
32```rust
33let mut tree = Taffy::new();
34let leaf = tree.new_leaf_with_measure(
35  Style::DEFAULT,
36  |known_dimensions: Size<Option<f32>>, available_space: Size<AvailableSpace>| Size { width: 100.0, height: 200.0 }
37);
38tree.compute_layout(leaf, Size::MAX_CONTENT);
39```
40
41Should become something like the following with Taffy 0.4:
42
43```rust
44let mut tree : Taffy<Size> = Taffy::new();
45let leaf = tree.new_leaf_with_context(Style::DEFAULT, Size { width: 100.0, height: 200.0 });
46tree.compute_layout_with_measure(
47  leaf,
48  Size::MAX_CONTENT,
49  |known_dimensions: Size<Option<f32>>, available_space: Size<AvailableSpace>, node_id: NodeId, node_context: Option<Size>| {
50    node_context.unwrap_or(Size::ZERO)
51  }
52);
53```
54
55Note that:
56
57- 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).
58- If you don't need a context then you can use `()` for the context type
59- As the single "global" measure function passed to `compute_layout_with_measure` only needs to exist for the duration of a single layout run,
60  it can (mutably) borrow data from it's environment
61
62#### Many APIs have been renamed to replace `points` or `Points` with `length` or `Length`
63
64This new name better describes one-dimentional measure of space in some unspecified unit
65which is often unrelated to the PostScript point or the CSS `pt` unit.
66
67This also removes a misleading similarity with the 2D `Point`,
68whose components can have any unit and are not even necessarily absolute lengths.
69
70Example usage change:
71
72```diff
73 use taffy::prelude::*;
74
75 // …
76
77 let header_node = taffy
78     .new_leaf(
79         Style {
80-            size: Size { width: points(800.0), height: points(100.0) },
81+            size: Size { width: length(800.0), height: length(100.0) },
82             ..Default::default()
83         },
84     ).unwrap();
85```
86
87### Added
88
89- Support 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 inline, inline-block and float have *not* been implemented. The use case supported is block container nodes which contain block-level children.
90- Added `insert_child_at_index()` method to the `Taffy` tree. This can be used to insert a child node at any position instead of just the end.
91
92### Removed
93
94- `layout_flexbox()` has been removed from the prelude. Use `FlexboxAlgorithm::perform_layout()` instead.
95- The following methods have been removed from the `LayoutTree` trait: `parent`, `is_childless`, `layout`, `measure_node`, `needs_measure`, `cache_mut` and `mark_dirty`. These no longer need to be implemented in custom implementations of `LayoutTree`.
96
97### Changes
98
99- The Flexbox algorithm has now been moved behind the `flexbox` feature. The `flexbox` feature is enabled by default.
100- The `justify_self` property has been moved behind the `grid` feature.
101- `taffy::node::Node` has been replaced with `taffy::tree::NodeId`. This should make it much easier to implement the `LayoutTree` trait as the underlying type backing the node id now a `u64` rather than a `slotmap::DefaultKey`.
102- Module organisation changes:
103  - The `math` module has been made private
104  - The `axis` module has been merged into the `geometry` module
105  - The debug module is no longer public. The `print_tree` function is now accesible under `util`.
106  - All types from the `node`, `data`, `layout`, `error` and `cache` modules have been moved to the  the `tree` module.
107- Fixed misspelling: `RunMode::PeformLayout` renamed into `RunMode::PerformLayout` (added missing `r`).
108
109## 0.3.16
110
111### Fixes
112
113- Improve performance of flexbox columns
114
115## 0.3.15
116
117### Fixes
118
119- Fix justify-content and align-content when free space is negative (content overflows container) (#549) (#551)
120
121## 0.3.14
122
123### Fixes
124
125- 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)
126
127## 0.3.13
128
129### Fixes
130
131- Fix rounding accumulation bug (#521) (Fixes #501 and bevyengine/bevy#8911)
132- Flexbox: pass correct cross-axis available space when computing an item's intrinsic main size (#522)(Fixes bevyengine/bevy#9350)
133- Flexbox: Subtract child margin not parent margin when computing stretch-alignment known size
134- Grid: Make CSS Grid algorithm correctly apply max width/height and available space when it is the root node (#491)
135- Grid: Fix CSS Grid "auto track" / placement bugs #481
136  - Fix divide by zero when using grid_auto_rows/grid_auto_columns with zero negative implicit tracks
137  - Fix over counting of tracks (leading to incorrect container heights) when auto-placing in grids that contain negative implicit tracks.
138  - Fix axis conflation in auto-placement code when grid_auto_flow is column
139  - Fix assignment of auto track sizes when initializing negative implicit tracks
140- Leaf: Apply margins to leaf nodes when computing available space for measure functions
141- Leaf: Reserve space for padding/borders in nodes with measure functions (#497)
142  
143  **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.
144
145### Dependencies
146
147- Upgrade `grid` to `0.10`. This eliminates the transitive dependency on `no-std-compat`.
148
149## 0.3.12
150
151### Fixes
152
153- Fix caching issue when toggling `display:none` on and off
154
155## 0.3.11
156
157### Fixes
158
159- Fix exponential blowup when laying out trees containing nodes with min and max sizes.
160
161## 0.3.10
162
163### Fixes
164
165- Fix sizing of children when the available_space < min_size (#407)
166
167## 0.3.9
168
169### Fixes
170
171- 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)
172
173## 0.3.8
174
175### Fixes
176
177- Fix incorrect min-content size for `flex-wrap: wrap` nodes (bevyengine/bevy#8082)
178
179## 0.3.7
180
181### Fixes
182
183- Fix: Make `padding` and `border` floor node sizes (#372)
184- Fix: Prevent percentages contributing to min-content sizes (#388) (also fixes bevyengine/bevy#8017)
185
186## 0.3.6
187
188### Fixes
189
190- Fix: Ignore `align_content` when `flex_wrap` is set to `nowrap` (#383)
191
192## 0.3.5
193
194### Fixes
195
196- Fix `display: none` when it is set on a flexbox child (#380)
197- Fix `display: none` when it is set on a grid child (#381)
198
199## 0.3.4
200
201### Fixes
202
203- Fix `display: none` when it is set for the only node in the hierarchy (#377)
204
205## 0.3.3
206
207### Added
208
209- 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.
210
211### Fixes
212
213- Fixed rounding algorithm such that it never leaves gaps between adjacent nodes (#369)
214- Fixed compiling with the `grid` feature disabled (#370)
215- Fixed compiling with the `std` feature disabled
216
217## 0.3.2
218
219### Fixes
220
221- Allow partial nested values to be deserialized into a `Style` using the `serde` feature.
222
223## 0.3.1
224
225### Fixes
226
227- The `serde` feature now works when the `grid` feature is enabled
228
229## 0.3.0
230
231### Highlights
232
233- [CSS Grid algorithm support](#new-feature-css-grid)
234- [Style helper functions](#new-feature-style-helpers)
235
236See below for details of breaking changes.
237
238### New Feature: CSS Grid
239
240We 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`.
241
242#### Learning Resources
243
244Taffy 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:
245
246- [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.
247- [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 comphrehensive written explanation of the different Grid propertie and how they work.
248
249#### Supported Features & Properties
250
251In addition to the usual sizing/spacing proerties (size, min_size, padding, margin, etc), the following Grid style properties are supported on Grid Containers:
252
253| Property                  | Explanation                                                                                    |
254| ---                       | ---                                                                                            |
255| [`grid-template-columns`] | The track sizing functions of the grid's explicit columns                                      |
256| [`grid-template-rows`]    | The track sizing functions of the grid's explicit rows                                         |
257| [`grid-auto-rows`]        | Track sizing functions for the grid's implicitly generated rows                                |
258| [`grid-auto-columns`]     | Track sizing functions for the grid's implicitly generated columns                             |
259| [`grid-auto-flow`]        | Whether auto-placed items are placed row-wise or column-wise. And sparsely or densely.         |
260| [`gap`]                   | The size of the vertical and horizontal gaps between grid rows/columns                         |
261| [`align-content`]         | Align grid tracks within the container in the inline (horizontal) axis                         |
262| [`justify-content`]       | Align grid tracks within the container in the block (vertical) axis                            |
263| [`align-items`]           | Align the child items within their grid areas in the inline (horizontal) axis                  |
264| [`justify-items`]         | Align the child items within their grid areas in the block (vertical) axis                     |
265
266And the following Grid style properties are supported on Grid Items (children):
267
268| Property                  | Explanation                                                                                    |
269| ---                       | ---                                                                                            |
270| [`grid-row`]              | The (row) grid line the item starts at (or a span)                                             |
271| [`grid-column`]           | The (column) grid line the item end at (or a span)                                             |
272| [`align-self`]            | Align the item within it's grid area in the inline (horizontal) axis. Overrides `align-items`. |
273| [`justify-self`]          | Align the item within it's grid area in the block (vertical) axis. Overrides `justify-items`.  |
274
275[`grid-template-columns`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns
276[`grid-template-rows`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows
277[`grid-auto-rows`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-rows
278[`grid-auto-columns`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-columns
279[`grid-auto-flow`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow
280[`gap`]: https://developer.mozilla.org/en-US/docs/Web/CSS/gap
281[`align-content`]: https://developer.mozilla.org/en-US/docs/Web/CSS/align_content
282[`justify-content`]: https://developer.mozilla.org/en-US/docs/Web/CSS/justify_content
283[`align-items`]: https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
284[`justify-items`]: https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items
285[`grid-row`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row
286[`grid-column`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column
287[`align-self`]: https://developer.mozilla.org/en-US/docs/Web/CSS/align-self
288[`justify-self`]: https://developer.mozilla.org/en-US/docs/Web/CSS/justify-self
289
290The following properties and features are not currently supported:
291
292- Subgrids
293- Masonry grid layout
294- Named grid lines
295- Named areas: `grid-template-areas` and `grid-area`
296- `grid-template` or `grid` shorthand
297
298#### Example
299
300See [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:
301
302```bash
303cargo run --example grid_holy_grail --features grid
304```
305
306### New Feature: Style Helpers
307
308Ten 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.
309
310For example, instead of:
311
312```rust
313let size : Size<Dimension> = Size { width: Dimension::Points(100.0), height: Dimension::Percent(50.0) };
314```
315
316you can now write
317
318```rust
319let size : Size<Dimension> = Size { width: points(100.0), height: percent(50.0) };
320```
321
322And 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
323
324```rust
325let size : Size<Dimension> = points(100.0);
326```
327
328Available style helpers:
329
330<table>
331  <thead><tr><th>Type(s)</th><th colspan="2">Helpers that work with that type</th></tr></thead>
332  <tbody>
333    <tr>
334      <td rowspan="3"><code>LengthPercentage</code></td>
335      <td><code>zero()</code></td>
336      <td>Generates a <code>Points</code> variant with the value <code>0.0</code></td>
337    </tr>
338    <tr>
339      <td><code>points(val:&nbsp;f32)</code></td>
340      <td>Generates a <code>Points</code> variant with the specified value</td>
341    </tr>
342    <tr>
343      <td><code>percent(val:&nbsp;f32)</code></td>
344      <td>Generates a <code>Percent</code> variant with the specified value.<br />Note that the scale of 0-1 not 0-100.</td>
345    </tr>
346    <tr>
347      <td rowspan="2"><code>LengthPercentageAuto</code><br /><code>Dimension</code></td>
348      <td colspan="2"><i>All helpers from <code>LengthPercentage</code> and...</i></td>
349    </tr>
350    <tr>
351      <td><code>auto()</code></td>
352      <td>Generates an <code>Auto</code> variant</td>
353    </tr>
354    <tr>
355      <td rowspan="3"><code>MinTrackSizingFunction</code></td>
356      <td colspan="2"><i>All helpers from <code>LengthPercentageAuto</code>/<code>Dimension</code> and...</i></td>
357    </tr>
358    <tr>
359      <td><code>min_content()</code></td>
360      <td>Generates an <code>MinContent</code> variant</td>
361    </tr>
362      <tr>
363      <td><code>max_content()</code></td>
364      <td>Generates an <code>MinContent</code> variant</td>
365    </tr>
366    <tr>
367      <td rowspan="3"><code>MaxTrackSizingFunction</code></td>
368      <td colspan="2"><i>All helpers from <code>MinTrackSizingFunction</code> and...</i></td>
369    </tr>
370    <tr>
371      <td><code>fit_content(limit:&nbsp;LengthPercentage)</code></td>
372      <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>
373    </tr>
374      <tr>
375      <td><code>fr(fraction:&nbsp;f32)</code></td>
376      <td>Generates a <code>Fraction</code> (<code>fr</code>) variant with the specified flex fraction </td>
377    </tr>
378    <tr>
379      <td rowspan="3"><code>NonRepeatingTrackSizingFunction</code></td>
380      <td colspan="2"><i>All helpers from <code>MaxTrackSizingFunction</code> and...</i></td>
381    </tr>
382    <tr>
383      <td><code>minmax(min: MinTrackSizingFunction, max: MaxTrackSizingFunction)</code></td>
384      <td>Equivalent to CSS <code>minmax()</code> function.</td>
385    </tr>
386    <tr>
387      <td><code>flex(fraction:&nbsp;f32)</code></td>
388      <td>Equivalent to CSS <code>minmax(0px, 1fr)</code>. This is likely what you want if you want evenly sized rows/columns.</td>
389    </tr>
390    <tr>
391      <td rowspan="2"><code>TrackSizingFunction</code></td>
392      <td colspan="2"><i>All helpers from <code>NonRepeatingTrackSizingFunction</code> and...</i></td>
393    </tr>
394    <tr>
395      <td><code>repeat(rep: GridTrackRepetition, tracks: Vec&lt;TrackSizingFunction&gt;)</code></td>
396      <td>Equivalent to css <code>repeat()</code> function.</td>
397    </tr>
398    <tr>
399      <td><code>Vec&lt;TrackSizingFunction&gt;</code></td>
400      <td><code>evenly_sized_tracks(count:&nbsp;u16)</code></td>
401      <td>Equivalent to CSS <code>repeat(count, minmax(0px, 1fr)</code></td>
402    </tr>
403    <tr>
404      <td rowspan="3"><code>AvailableSpace</code></td>
405      <td><code>auto()</code></td>
406      <td>Generates an <code>Auto</code> variant</td>
407    </tr>
408    <tr>
409      <td><code>min_content()</code></td>
410      <td>Generates an <code>MinContent</code> variant</td>
411    </tr>
412      <tr>
413      <td><code>max_content()</code></td>
414      <td>Generates an <code>MinContent</code> variant</td>
415    </tr>
416    <tr>
417      <td><code>Size&lt;T&gt;</code></td>
418      <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>
419    </tr>
420    <tr>
421      <td><code>Rect&lt;T&gt;</code></td>
422      <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>
423    </tr>
424  </tbody>
425</table>
426
427### Breaking API changes
428
429#### Changes to alignment style types
430
431- `AlignContent` and `JustifyContent` has been merged.
432  - `JustifyContent` is now an alias of `AlignContent` and contains the `Stretch` variant.
433  - This variant will be *ignored* (falling back to `Start`) when applied Flexbox containers. It is valid value for Grid containers.
434- `AlignItems` and `AlignSelf` have been merged.
435  - The `Auto` variant of `AlignSelf` has been removed. You should now use `Option::None` if you wish to specify `AlignSelf::Auto`.
436  - `AlignSelf` is now an alias of `AlignItems`.
437  - `JustifyItems` and `JustifySelf` aliases have been added. These properties have no affect on Flexbox containers, but apply to Grid containers.
438- `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.
439
440#### Strict style types
441
442- New types `LengthPercentage` and `LengthPercentageAuto` have been added.
443  - `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.
444  - `LengthPercentageAuto` is currently identical to `Dimension` but will allow us to expand dimension in future to support values like `MinContent`, `MaxContent` and `FitContent`.
445- 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).
446
447#### Position properties renamed
448
449- 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)
450- 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`.
451
452#### Changes to `LayoutTree`
453
454- Added generic associated type to `LayoutTree` for a `ChildIter`, an iterator on the children of a given node.
455- 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.
456- 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.
457- Added `is_childless` method to `LayoutTree` for querying whether a node has no children.
458
459#### `AvailableSpace` has been moved
460
461The `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.
462
463### Fixes
464
465- Flexbox nodes sized under a min-content constraint now size correctly (#291)
466- Aspect ratio is now applied correctly in many circumstances
467- Absolutely positioned items now apply margins correctly
468- Min/max size are now applied correctly
469- Inset applied incorrectly to relatively positioned flexbox children when both `top` and `bottom` or `left` and `right` were specified (#348)
470- 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)
471
472### Removed
473
474- 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.
475- 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.
476- 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.
477
478## 0.2.2
479
480### Fixes
481
482- Border or padding on the horizontal axis could, in some cases, increase the height of nodes.
483
484## 0.2.1
485
486### Fixes
487
488- 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`.
489- `taffy::compute_layout` has been made public allowing Taffy to be used with custom storage (#263)
490
491## 0.2.0
492
493### New features
494
495#### Flexbox "gap" and `AlignContent::SpaceEvenly`
496
497The [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.
498
499Additionally 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)
500
501#### Debug module and cargo feature
502
503Two debugging features have been added:
504
505- `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.
506- A cargo feature `debug`. This enabled debug logging of the layout computation process itself (this is probably mainly useful for those working taffy itself).
507
508### Performance improvements
509
510A number of performance improvements have landed since taffy 0.1:
511
512- 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%.
513- 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 chache slots to better match the actual usage patterns of the flexbox layout algorithm. This had a particularly dramatic effect on deep hierachies (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!
514
515#### Benchmarks vs. Taffy 0.1
516
517| Benchmark                                 | Taffy 0.1 | Taffy 0.2 | % change (0.1 -> 0.2) |
518| ---                                       | ---       | ---       | ---                   |
519| wide/1_000 nodes (2-level hierarchy)      | 699.18 µs | 445.01 µs | -36.279%              |
520| wide/10_000 nodes (2-level hierarchy)     | 8.8244 ms | 7.1313 ms | -16.352%              |
521| wide/100_000 nodes (2-level hierarchy)    | 204.48 ms | 242.93 ms | +18.803%              |
522| deep/4000 nodes (12-level hierarchy))     | 5.2320 s  | 2.7363 ms | -99.947%              |
523| deep/10_000 nodes (14-level hierarchy)    | 75.207 s  | 6.9415 ms | -99.991%              |
524| deep/100_000 nodes (17-level hierarchy)   | -         | 102.72 ms | -                     |
525| deep/1_000_000 nodes (20-level hierarchy) | -         | 799.35 ms | -                     |
526
527(note that the table above contains multiple different units (milliseconds vs. microseconds vs. nanoseconds))
528
529As 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.
530
531However, in the "deep" benchmarks we see dramatic improvements. The previous version of Taffy suffered from exponential blowup in the case of deeply nested hierachies. This has resulted in somewhat silly improvements like the 10,000 node (14-level) hierachy 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.
532
533#### Benchmarks vs. [Yoga](https://github.com/facebook/yoga)
534
535Yoga 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.
536
537| Benchmark | Yoga | Taffy 0.2 |
538| --- | --- | --- |
539| yoga/10 nodes (1-level hierarchy) | 45.1670 µs | 33.297 ns |
540| yoga/100 nodes (2-level hierarchy) | 134.1250 µs | 336.53 ns |
541| yoga/1_000 nodes (3-level hierarchy) | 1.2221 ms | 3.8928 µs |
542| yoga/10_000 nodes (4-level hierarchy) | 13.8672 ms | 36.162 µs |
543| yoga/100_000 nodes (5-level hierarchy) | 141.5307 ms | 1.6404 ms |
544
545(note that the table above contains multiple different units (milliseconds vs. microseconds vs. nanoseconds))
546
547While 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!
548
549### Breaking API changes
550
551#### Node creation changes
552
553- `taffy::Node` is now unique only to the Taffy instance from which it was created.
554- Renamed `Taffy.new_node(..)` -> `Taffy.new_with_children(..)`
555- Renamed `Taffy.new_leaf()` -> `Taffy.new_leaf_with_measure()`
556- Added `taffy::node::Taffy.new_leaf()` which allows the creation of new leaf-nodes without having to supply a measure function
557
558#### Error handling/representation improvements
559
560- Renamed `taffy::Error` -> `taffy::error::TaffyError`
561- Replaced `taffy::error::InvalidChild` with a new `InvalidChild` variant of `taffy::error::TaffyError`
562- Replaced `taffy::error::InvalidNode` with a new `InvalidNode` variant of `taffy::error::TaffyError`
563- The following method new return `Err(TaffyError::ChildIndexOutOfBounds)` instead of panicking:
564  - `taffy::Taffy::remove_child_at_index`
565  - `taffy::Taffy::replace_child_at_index`
566  - `taffy::Taffy::child_at_index`
567- `Taffy::remove` now returns a `Result<usize, Error>`, to indicate if the operation was sucessful (and if it was, which ID was invalidated).
568
569#### Some uses of `Option<f32>` replaced with a new `AvailableSpace` enum
570
571A new enum `Taffy::layout::AvailableSpace` has been added.
572
573The definition looks like this:
574
575```rust
576/// The amount of space available to a node in a given axis
577pub enum AvailableSpace {
578    /// The amount of space available is the specified number of pixels
579    Definite(f32),
580    /// The amount of space available is indefinite and the node should be laid out under a min-content constraint
581    MinContent,
582    /// The amount of space available is indefinite and the node should be laid out under a max-content constraint
583    MaxContent,
584}
585```
586
587This 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`).
588
589And 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..
590
591#### Builder methods are now `const` where possible
592
593- Several convenience constants have been defined: notably `Style::DEFAULT`
594- `Size<f32>.zero()` is now `Size::<f32>::ZERO`
595- `Point<f32>.zero()` is now  `Point::<f32>::ZERO`
596- `Size::undefined()` is now `Size::NONE`
597
598#### Removals
599
600- 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%).
601- Removed `taffy::number::Number`. Use `Option<f32>` is used instead
602  - the associated public `MinMax` and `OrElse` traits have also been removed; these should never have been public
603- 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).
604
605### Fixes
606
607- Miscellaneous correctness fixes which align our implementation with Chrome:
608
609  - Nodes can only ever have one parent
610  - Fixed rounding of fractional values to follow latest Chrome - values are now rounded the same regardless of their position
611  - Fixed computing free space when using both `flex-grow` and a minimum size
612  - 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)
613  - `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
614- Taffy can now be vendored using `cargo-vendor` (README.md is now included in package).
615
616## 0.1.0
617
618### 0.1.0 Changed
619
620- the `order` field of `Layout` is now public, and describes the relative z-ordering of nodes
621- renamed crate from `stretch2` to `taffy`
622- updated to the latest version of all dependencies to reduce upstream pain caused by duplicate dependencies
623- renamed `stretch::node::Strech` -> `taffy::node::Taffy`
624
625### 0.1.0 Fixed
626
627- fixed feature strategy for `alloc` and `std`: these can now be compiled together, with `std`'s types taking priority
628
629### 0.1.0 Removed
630
631- removed Javascript / Kotlin / Swift bindings
632  - the maintainer team lacks expertise to keep these working
633  - more serious refactors are planned, and this will be challenging to keep working through that process
634  - if you are interested in helping us maintain bindings to other languages, [get in touch](https://github.com/DioxusLabs/taffy/discussions)!
635- 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)
636- removed the `Direction` and `Overflow` structs, and the corresponding `direction` and `overflow` fields from `Style`
637  - these had no effect in the current code base and were actively misleading
638
639## stretch2 0.4.3
640
641This is the final release of `stretch`: migrate to the crate named `taffy` for future fixes and features!
642
643These notes describe the differences between this release and `stretch` 0.3.2, the abandoned crate from which this library was forked.
644
645### Changed
646
647- updated [assorted dependencies](https://github.com/vislyhq/stretch/commit/a6491117379cea52dedc9584d892594a143e8cb0)
648
649### Fixed
650
651- fixed an exponential performance blow-up with deep nesting
652- fixed percent height values, which were using parent width
653- recomputing layout no longer moves children of non-zero-positioned parent
654- fixed broken Swift bindings