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