1# Release Notes
2
3## 0.6.2
4
5### Fixes
6
7- Fix: clamp indefinite available space by min- and max- size as appropriate (#742)
8
9## 0.6.1
10
11### Fixes
12
13- Fix calculation of `auto-fill`/`auto-fit` repetition count when container has a definite percentage size (#722)
14- Fix min-size style not affecting intrinsic sizes (#723)
15- Fix documentation of dirty and mark_dirty functions (#724)
16- Fix intrinsic size of scroll containers that have a small explicit flex-basis (#728)
17
18## 0.6.0
19
20### Highlights
21
22- The `Style` struct has been "traitified". This supports Taffy's integration in Servo and generally makes Taffy more flexible. The
23  `Style` struct still exists and implements the new traits so existing uses of Taffy will continue to work as before.
24- The `box-sizing` style is supported
25- Computed margins are output in `Layout`
26
27### Fixes
28
29- Fix `print_tree()` when rounding is disabled (#680)
30- Absolute Insets should be resolved against the container size minus border (#666)
31- Fix flooring hypothetical_main_size by computed min size (#689)
32- Fix flex line cross-size determination (#690)
33- Fix panics in the grid algorithm (#691)
34- Fix resolving flexible lengths (WPT css/flexbox-multiline-min-max test) (#692)
35- Fix wrapping when a max main size style is present (#694)
36- Fix case where Taffy allowed margins to collapse through an element when it shouldn't have (#695)
37
38### Added
39
40- Legacy text align (for laying out `<center>` and `<div align="..">`) is supported
41- Add `is_table` for block items (#701)
42- Impl `Debug` and `Clone` for `Cache` (#688)
43- Implement `Debug` and `PartialEq` for tree types (#697)
44
45## 0.5.2
46
47- Fix block stretch sizing (don't always apply stretch sizing to block containers) (#674)
48- Fix computation of intrinsic main size when it depends on a child's known cross size (#673)
49- Fix panic when GridLine 0 is specified (#671)
50- Docs: Document feature flags and scrape examples (#672)
51- Docs: Update cosmic-text example to cosmic-text 0.12 (#670)
52
53## 0.5.1
54
55- Fix: Clamp block item stretch widths by their min and max width (#664)
56- Fix: Auto margin computation in block layout (#663)
57
58## 0.5.0
59
60The changes in 0.5 are relatively small but the new measure function parameter is a breaking change so it requires a minor version bump.
61
62- Added: A `style: &Style` parameter has been added to measure functions.
63- Added: The `MaybeMath`, `MaybeResolve`, and `ResolveOrZero` traits have been made public.
64- Fix: use SizingMode::Inherent when sizing absolute children of flexbox nodes.
65
66## 0.4.4
67
68### Fixes
69
70- Content alignment (`align-content`/`justify-content`) behaviour was updated to match the latest spec (and Chrome 123+) (#635)
71- Ensure that root Flexbox nodes are floored by their padding-border (#651, #655)
72- Use grid area size not available space when applying aspect ratio to grid containers (#656)
73
74## 0.4.3
75
76### Fixes
77
78- Fix compilation error in `evenly_sized_tracks` style helper in recent versions of rustc caused by a change/regression in type
79  inference (#643). Note that 3rd-party code that call style helpers that take an `Into<f32>` parameter may still be affected by this issue,
80  but they should be able to fix on their side by clarifying the type passed in
81
82## 0.4.2
83
84- Fixed: single-line flex-container should clamp the line's cross-size (#638)
85- Reduced binary footprint of Taffy from around 300kb to around 150kb (#636)
86
87## 0.4.1
88
89- Fixed: CSS Grid track sizing not respecting growth limits in some circumstances (#624)
90
91## 0.4.0
92
93### Highlights
94
95- Support for CSS Block layout (`display: block`)
96- Support for the `overflow` property (+ `scrollbar_width` for `overflow: scroll`)
97- Improved measure function API
98- Completely refactored low-level API
99- Simplified module hierarchy (+ most types/functions are now exported from the crate root)
100- Expanded set of examples which better document integration with other layout systems (e.g. text layout)
101- Computed values for `padding` and `border` are now output into the `Layout` struct
102
103### Block layout
104
105Support 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.
106
107### Overflow property
108
109Support 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.
110
111- Overflow is settable indpendently in each axis.
112- `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.
113- `Hidden` and `Scroll` affect layout by changing the automatic minimum size of Flexbox and Grid children
114- `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`.
115
116### Measure function changes
117
118The "measure function" API for integrating Taffy with other measurement systems (such as text layout) has been changed to be more flexible
119and to interact better with borrow checking (you can now borrow external data in your measure function!).
120
121- There are no longer per-node measure functions.
122- There is now a single "global" measure function, and a per-node "context" of a user-defined type
123- The `Taffy` tree is now a generic `TaffyTree<T>` where `T` is the "context" type.
124- The measure function is now called for all leaf nodes (nodes without children). If you wish to maintain compatibility with the previous
125  behaviour then your measure function should return `Size::ZERO` for leaf nodes whose context is `None`.
126
127If you are not using measure functions, then the only change you will need to make is from:
128
129```rust
130let mut tree = Taffy::new();
131```
132
133to
134
135```rust
136let mut tree : TaffyTree<()> = TaffyTree::new();
137```
138
139And generally update any uses of `Taffy` in your codebase to `TaffyTree<()>`.
140
141If you are using measure functions then you will need to make some bigger (but straightforward) changes. The following Taffy 0.3 code:
142
143```rust
144let mut tree = Taffy::new();
145let leaf = tree.new_leaf_with_measure(
146  Style::DEFAULT,
147  |known_dimensions: Size<Option<f32>>, available_space: Size<AvailableSpace>| Size { width: 100.0, height: 200.0 }
148);
149tree.compute_layout(leaf, Size::MAX_CONTENT);
150```
151
152Should become something like the following with Taffy 0.4:
153
154```rust
155let mut tree : TaffyTree<Size> = TaffyTree::new();
156let leaf = tree.new_leaf_with_context(Style::DEFAULT, Size { width: 100.0, height: 200.0 });
157tree.compute_layout_with_measure(
158  leaf,
159  Size::MAX_CONTENT,
160  |known_dimensions: Size<Option<f32>>, available_space: Size<AvailableSpace>, node_id: NodeId, node_context: Option<Size>| {
161    node_context.unwrap_or(Size::ZERO)
162  }
163);
164```
165
166Note that:
167
168- 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).
169- If you don't need a context then you can use `()` for the context type
170- As the single "global" measure function passed to `compute_layout_with_measure` only needs to exist for the duration of a single layout run,
171  it can (mutably) borrow data from it's environment
172
173### Low-level API (`LayoutTree` trait) refactor
174
175The low-level API has been completely reworked:
176
177- The `LayoutTree` trait has been split into 5 smaller traits which live in the `taffy::tree:traits` module (along with their associated documentation)
178- The following methods have been removed from split `LayoutTree` traits entirely: `parent`, `is_childless`, `measure_node`, `needs_measure`, and `mark_dirty`.
179- `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`.
180- Support for running each layout algorithm individually on a single node via the following top-level functions:
181  - `compute_flexbox_layout`
182  - `compute_grid_layout`
183  - `compute_block_layout`
184  - `compute_leaf_layout`
185  - `compute_root_layout`
186  - `compute_hidden_layout`
187
188It 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
189improved 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).
190
191### Module hierarchy changes
192
193The 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`.
194
195Specific changes:
196
197- The `math` module has been made private
198- The `axis` module has been merged into the `geometry` module
199- The debug module is no longer public. The `print_tree` function is now accessible under `util`.
200- All types from the `node`, `data`, `layout`, `error` and `cache` modules have been moved to the  the `tree` module.
201- The `layout_flexbox()` function has been removed from the prelude. Use `taffy::compute_flexbox_layout` instead.
202
203### Many APIs have been renamed to replace `points` or `Points` with `length` or `Length`
204
205This new name better describes one-dimensional measure of space in some unspecified unit
206which is often unrelated to the PostScript point or the CSS `pt` unit.
207
208This also removes a misleading similarity with the 2D `Point`,
209whose components can have any unit and are not even necessarily absolute lengths.
210
211Example usage change:
212
213```diff
214 use taffy::prelude::*;
215
216 // …
217
218 let header_node = taffy
219     .new_leaf(
220         Style {
221-            size: Size { width: points(800.0), height: points(100.0) },
222+            size: Size { width: length(800.0), height: length(100.0) },
223             ..Default::default()
224         },
225     ).unwrap();
226```
227
228### Other Changes
229
230- The `Taffy` type was renamed to `TaffyTree` and made generic of a context parameter
231- The Flexbox algorithm has now been moved behind the `flexbox` feature. The `flexbox` feature is enabled by default.
232- The `justify_self` property has been moved behind the `grid` feature.
233- Fixed misspelling: `RunMode::PeformLayout` renamed into `RunMode::PerformLayout` (added missing `r`).
234- `serde` dependency has been made compatible with `no_std` environments
235- `slotmap` dependency has been made compatible with `no_std` environments
236- 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.
237- Added `total_node_count()` method to the `TaffyTree` which returns the total number of nodes in the tree.
238- Added `get_disjoint_node_context_mut()` method to the `TaffyTree`. This can be used to safely get multiple mutable borrows at the same time.
239
240## 0.3.19
241
242### Fixes
243
244- Fix compilation error in `evenly_sized_tracks` style helper in recent versions of rustc caused by a change/regression in type
245  inference (#643). Note that 3rd-party code that call style helpers that take an `Into<f32>` parameter may still be affected by this issue,
246  but they should be able to fix on their side by clarifying the type passed in
247
248## 0.3.18
249
250### Fixes
251
252- Fix computation of Flexbox automatic minimum size when grid or flexbox child has an explicit width/height style set (#576)
253
254## 0.3.17
255
256### Added
257
258- Added `total_node_count` method to the `Taffy` struct. Returns the total number of nodes in the tree.
259
260## 0.3.16
261
262### Fixes
263
264- Improve performance of flexbox columns
265
266## 0.3.15
267
268### Fixes
269
270- Fix justify-content and align-content when free space is negative (content overflows container) (#549) (#551)
271
272## 0.3.14
273
274### Fixes
275
276- 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)
277
278## 0.3.13
279
280### Fixes
281
282- Fix rounding accumulation bug (#521) (Fixes #501 and bevyengine/bevy#8911)
283- Flexbox: pass correct cross-axis available space when computing an item's intrinsic main size (#522)(Fixes bevyengine/bevy#9350)
284- Flexbox: Subtract child margin not parent margin when computing stretch-alignment known size
285- Grid: Make CSS Grid algorithm correctly apply max width/height and available space when it is the root node (#491)
286- Grid: Fix CSS Grid "auto track" / placement bugs #481
287  - Fix divide by zero when using grid_auto_rows/grid_auto_columns with zero negative implicit tracks
288  - Fix over counting of tracks (leading to incorrect container heights) when auto-placing in grids that contain negative implicit tracks.
289  - Fix axis conflation in auto-placement code when grid_auto_flow is column
290  - Fix assignment of auto track sizes when initializing negative implicit tracks
291- Leaf: Apply margins to leaf nodes when computing available space for measure functions
292- Leaf: Reserve space for padding/borders in nodes with measure functions (#497)
293  
294  **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.
295
296### Dependencies
297
298- Upgrade `grid` to `0.10`. This eliminates the transitive dependency on `no-std-compat`.
299
300## 0.3.12
301
302### Fixes
303
304- Fix caching issue when toggling `display:none` on and off
305
306## 0.3.11
307
308### Fixes
309
310- Fix exponential blowup when laying out trees containing nodes with min and max sizes.
311
312## 0.3.10
313
314### Fixes
315
316- Fix sizing of children when the available_space < min_size (#407)
317
318## 0.3.9
319
320### Fixes
321
322- 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)
323
324## 0.3.8
325
326### Fixes
327
328- Fix incorrect min-content size for `flex-wrap: wrap` nodes (bevyengine/bevy#8082)
329
330## 0.3.7
331
332### Fixes
333
334- Fix: Make `padding` and `border` floor node sizes (#372)
335- Fix: Prevent percentages contributing to min-content sizes (#388) (also fixes bevyengine/bevy#8017)
336
337## 0.3.6
338
339### Fixes
340
341- Fix: Ignore `align_content` when `flex_wrap` is set to `nowrap` (#383)
342
343## 0.3.5
344
345### Fixes
346
347- Fix `display: none` when it is set on a flexbox child (#380)
348- Fix `display: none` when it is set on a grid child (#381)
349
350## 0.3.4
351
352### Fixes
353
354- Fix `display: none` when it is set for the only node in the hierarchy (#377)
355
356## 0.3.3
357
358### Added
359
360- 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.
361
362### Fixes
363
364- Fixed rounding algorithm such that it never leaves gaps between adjacent nodes (#369)
365- Fixed compiling with the `grid` feature disabled (#370)
366- Fixed compiling with the `std` feature disabled
367
368## 0.3.2
369
370### Fixes
371
372- Allow partial nested values to be deserialized into a `Style` using the `serde` feature.
373
374## 0.3.1
375
376### Fixes
377
378- The `serde` feature now works when the `grid` feature is enabled
379
380## 0.3.0
381
382### Highlights
383
384- [CSS Grid algorithm support](#new-feature-css-grid)
385- [Style helper functions](#new-feature-style-helpers)
386
387See below for details of breaking changes.
388
389### New Feature: CSS Grid
390
391We 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`.
392
393#### Learning Resources
394
395Taffy 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:
396
397- [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.
398- [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.
399
400#### Supported Features & Properties
401
402In addition to the usual sizing/spacing properties (size, min_size, padding, margin, etc), the following Grid style properties are supported on Grid Containers:
403
404| Property                  | Explanation                                                                                    |
405| ---                       | ---                                                                                            |
406| [`grid-template-columns`] | The track sizing functions of the grid's explicit columns                                      |
407| [`grid-template-rows`]    | The track sizing functions of the grid's explicit rows                                         |
408| [`grid-auto-rows`]        | Track sizing functions for the grid's implicitly generated rows                                |
409| [`grid-auto-columns`]     | Track sizing functions for the grid's implicitly generated columns                             |
410| [`grid-auto-flow`]        | Whether auto-placed items are placed row-wise or column-wise. And sparsely or densely.         |
411| [`gap`]                   | The size of the vertical and horizontal gaps between grid rows/columns                         |
412| [`align-content`]         | Align grid tracks within the container in the inline (horizontal) axis                         |
413| [`justify-content`]       | Align grid tracks within the container in the block (vertical) axis                            |
414| [`align-items`]           | Align the child items within their grid areas in the inline (horizontal) axis                  |
415| [`justify-items`]         | Align the child items within their grid areas in the block (vertical) axis                     |
416
417And the following Grid style properties are supported on Grid Items (children):
418
419| Property                  | Explanation                                                                                    |
420| ---                       | ---                                                                                            |
421| [`grid-row`]              | The (row) grid line the item starts at (or a span)                                             |
422| [`grid-column`]           | The (column) grid line the item end at (or a span)                                             |
423| [`align-self`]            | Align the item within it's grid area in the inline (horizontal) axis. Overrides `align-items`. |
424| [`justify-self`]          | Align the item within it's grid area in the block (vertical) axis. Overrides `justify-items`.  |
425
426[`grid-template-columns`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns
427[`grid-template-rows`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows
428[`grid-auto-rows`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-rows
429[`grid-auto-columns`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-columns
430[`grid-auto-flow`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow
431[`gap`]: https://developer.mozilla.org/en-US/docs/Web/CSS/gap
432[`align-content`]: https://developer.mozilla.org/en-US/docs/Web/CSS/align_content
433[`justify-content`]: https://developer.mozilla.org/en-US/docs/Web/CSS/justify_content
434[`align-items`]: https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
435[`justify-items`]: https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items
436[`grid-row`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row
437[`grid-column`]: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column
438[`align-self`]: https://developer.mozilla.org/en-US/docs/Web/CSS/align-self
439[`justify-self`]: https://developer.mozilla.org/en-US/docs/Web/CSS/justify-self
440
441The following properties and features are not currently supported:
442
443- Subgrids
444- Masonry grid layout
445- Named grid lines
446- Named areas: `grid-template-areas` and `grid-area`
447- `grid-template` or `grid` shorthand
448
449#### Example
450
451See [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:
452
453```bash
454cargo run --example grid_holy_grail --features grid
455```
456
457### New Feature: Style Helpers
458
459Ten 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.
460
461For example, instead of:
462
463```rust
464let size : Size<Dimension> = Size { width: Dimension::Points(100.0), height: Dimension::Percent(50.0) };
465```
466
467you can now write
468
469```rust
470let size : Size<Dimension> = Size { width: points(100.0), height: percent(50.0) };
471```
472
473And 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
474
475```rust
476let size : Size<Dimension> = points(100.0);
477```
478
479Available style helpers:
480
481<table>
482  <thead><tr><th>Type(s)</th><th colspan="2">Helpers that work with that type</th></tr></thead>
483  <tbody>
484    <tr>
485      <td rowspan="3"><code>LengthPercentage</code></td>
486      <td><code>zero()</code></td>
487      <td>Generates a <code>Points</code> variant with the value <code>0.0</code></td>
488    </tr>
489    <tr>
490      <td><code>points(val:&nbsp;f32)</code></td>
491      <td>Generates a <code>Points</code> variant with the specified value</td>
492    </tr>
493    <tr>
494      <td><code>percent(val:&nbsp;f32)</code></td>
495      <td>Generates a <code>Percent</code> variant with the specified value.<br />Note that the scale of 0-1 not 0-100.</td>
496    </tr>
497    <tr>
498      <td rowspan="2"><code>LengthPercentageAuto</code><br /><code>Dimension</code></td>
499      <td colspan="2"><i>All helpers from <code>LengthPercentage</code> and...</i></td>
500    </tr>
501    <tr>
502      <td><code>auto()</code></td>
503      <td>Generates an <code>Auto</code> variant</td>
504    </tr>
505    <tr>
506      <td rowspan="3"><code>MinTrackSizingFunction</code></td>
507      <td colspan="2"><i>All helpers from <code>LengthPercentageAuto</code>/<code>Dimension</code> and...</i></td>
508    </tr>
509    <tr>
510      <td><code>min_content()</code></td>
511      <td>Generates an <code>MinContent</code> variant</td>
512    </tr>
513      <tr>
514      <td><code>max_content()</code></td>
515      <td>Generates an <code>MinContent</code> variant</td>
516    </tr>
517    <tr>
518      <td rowspan="3"><code>MaxTrackSizingFunction</code></td>
519      <td colspan="2"><i>All helpers from <code>MinTrackSizingFunction</code> and...</i></td>
520    </tr>
521    <tr>
522      <td><code>fit_content(limit:&nbsp;LengthPercentage)</code></td>
523      <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>
524    </tr>
525      <tr>
526      <td><code>fr(fraction:&nbsp;f32)</code></td>
527      <td>Generates a <code>Fraction</code> (<code>fr</code>) variant with the specified flex fraction </td>
528    </tr>
529    <tr>
530      <td rowspan="3"><code>NonRepeatingTrackSizingFunction</code></td>
531      <td colspan="2"><i>All helpers from <code>MaxTrackSizingFunction</code> and...</i></td>
532    </tr>
533    <tr>
534      <td><code>minmax(min: MinTrackSizingFunction, max: MaxTrackSizingFunction)</code></td>
535      <td>Equivalent to CSS <code>minmax()</code> function.</td>
536    </tr>
537    <tr>
538      <td><code>flex(fraction:&nbsp;f32)</code></td>
539      <td>Equivalent to CSS <code>minmax(0px, 1fr)</code>. This is likely what you want if you want evenly sized rows/columns.</td>
540    </tr>
541    <tr>
542      <td rowspan="2"><code>TrackSizingFunction</code></td>
543      <td colspan="2"><i>All helpers from <code>NonRepeatingTrackSizingFunction</code> and...</i></td>
544    </tr>
545    <tr>
546      <td><code>repeat(rep: GridTrackRepetition, tracks: Vec&lt;TrackSizingFunction&gt;)</code></td>
547      <td>Equivalent to css <code>repeat()</code> function.</td>
548    </tr>
549    <tr>
550      <td><code>Vec&lt;TrackSizingFunction&gt;</code></td>
551      <td><code>evenly_sized_tracks(count:&nbsp;u16)</code></td>
552      <td>Equivalent to CSS <code>repeat(count, minmax(0px, 1fr)</code></td>
553    </tr>
554    <tr>
555      <td rowspan="3"><code>AvailableSpace</code></td>
556      <td><code>auto()</code></td>
557      <td>Generates an <code>Auto</code> variant</td>
558    </tr>
559    <tr>
560      <td><code>min_content()</code></td>
561      <td>Generates an <code>MinContent</code> variant</td>
562    </tr>
563      <tr>
564      <td><code>max_content()</code></td>
565      <td>Generates an <code>MinContent</code> variant</td>
566    </tr>
567    <tr>
568      <td><code>Size&lt;T&gt;</code></td>
569      <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>
570    </tr>
571    <tr>
572      <td><code>Rect&lt;T&gt;</code></td>
573      <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>
574    </tr>
575  </tbody>
576</table>
577
578### Breaking API changes
579
580#### Changes to alignment style types
581
582- `AlignContent` and `JustifyContent` has been merged.
583  - `JustifyContent` is now an alias of `AlignContent` and contains the `Stretch` variant.
584  - This variant will be *ignored* (falling back to `Start`) when applied Flexbox containers. It is valid value for Grid containers.
585- `AlignItems` and `AlignSelf` have been merged.
586  - The `Auto` variant of `AlignSelf` has been removed. You should now use `Option::None` if you wish to specify `AlignSelf::Auto`.
587  - `AlignSelf` is now an alias of `AlignItems`.
588  - `JustifyItems` and `JustifySelf` aliases have been added. These properties have no affect on Flexbox containers, but apply to Grid containers.
589- `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.
590
591#### Strict style types
592
593- New types `LengthPercentage` and `LengthPercentageAuto` have been added.
594  - `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.
595  - `LengthPercentageAuto` is currently identical to `Dimension` but will allow us to expand dimension in future to support values like `MinContent`, `MaxContent` and `FitContent`.
596- 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).
597
598#### Position properties renamed
599
600- 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)
601- 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`.
602
603#### Changes to `LayoutTree`
604
605- Added generic associated type to `LayoutTree` for a `ChildIter`, an iterator on the children of a given node.
606- 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.
607- 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.
608- Added `is_childless` method to `LayoutTree` for querying whether a node has no children.
609
610#### `AvailableSpace` has been moved
611
612The `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.
613
614### Fixes
615
616- Flexbox nodes sized under a min-content constraint now size correctly (#291)
617- Aspect ratio is now applied correctly in many circumstances
618- Absolutely positioned items now apply margins correctly
619- Min/max size are now applied correctly
620- Inset applied incorrectly to relatively positioned flexbox children when both `top` and `bottom` or `left` and `right` were specified (#348)
621- 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)
622
623### Removed
624
625- 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.
626- 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.
627- 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.
628
629## 0.2.2
630
631### Fixes
632
633- Border or padding on the horizontal axis could, in some cases, increase the height of nodes.
634
635## 0.2.1
636
637### Fixes
638
639- 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`.
640- `taffy::compute_layout` has been made public allowing Taffy to be used with custom storage (#263)
641
642## 0.2.0
643
644### New features
645
646#### Flexbox "gap" and `AlignContent::SpaceEvenly`
647
648The [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.
649
650Additionally 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)
651
652#### Debug module and cargo feature
653
654Two debugging features have been added:
655
656- `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.
657- A cargo feature `debug`. This enabled debug logging of the layout computation process itself (this is probably mainly useful for those working taffy itself).
658
659### Performance improvements
660
661A number of performance improvements have landed since taffy 0.1:
662
663- 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%.
664- 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!
665
666#### Benchmarks vs. Taffy 0.1
667
668| Benchmark                                 | Taffy 0.1 | Taffy 0.2 | % change (0.1 -> 0.2) |
669| ---                                       | ---       | ---       | ---                   |
670| wide/1_000 nodes (2-level hierarchy)      | 699.18 µs | 445.01 µs | -36.279%              |
671| wide/10_000 nodes (2-level hierarchy)     | 8.8244 ms | 7.1313 ms | -16.352%              |
672| wide/100_000 nodes (2-level hierarchy)    | 204.48 ms | 242.93 ms | +18.803%              |
673| deep/4000 nodes (12-level hierarchy))     | 5.2320 s  | 2.7363 ms | -99.947%              |
674| deep/10_000 nodes (14-level hierarchy)    | 75.207 s  | 6.9415 ms | -99.991%              |
675| deep/100_000 nodes (17-level hierarchy)   | -         | 102.72 ms | -                     |
676| deep/1_000_000 nodes (20-level hierarchy) | -         | 799.35 ms | -                     |
677
678(note that the table above contains multiple different units (milliseconds vs. microseconds vs. nanoseconds))
679
680As 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.
681
682However, 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.
683
684#### Benchmarks vs. [Yoga](https://github.com/facebook/yoga)
685
686Yoga 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.
687
688| Benchmark | Yoga | Taffy 0.2 |
689| --- | --- | --- |
690| yoga/10 nodes (1-level hierarchy) | 45.1670 µs | 33.297 ns |
691| yoga/100 nodes (2-level hierarchy) | 134.1250 µs | 336.53 ns |
692| yoga/1_000 nodes (3-level hierarchy) | 1.2221 ms | 3.8928 µs |
693| yoga/10_000 nodes (4-level hierarchy) | 13.8672 ms | 36.162 µs |
694| yoga/100_000 nodes (5-level hierarchy) | 141.5307 ms | 1.6404 ms |
695
696(note that the table above contains multiple different units (milliseconds vs. microseconds vs. nanoseconds))
697
698While 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!
699
700### Breaking API changes
701
702#### Node creation changes
703
704- `taffy::Node` is now unique only to the Taffy instance from which it was created.
705- Renamed `Taffy.new_node(..)` -> `Taffy.new_with_children(..)`
706- Renamed `Taffy.new_leaf()` -> `Taffy.new_leaf_with_measure()`
707- Added `taffy::node::Taffy.new_leaf()` which allows the creation of new leaf-nodes without having to supply a measure function
708
709#### Error handling/representation improvements
710
711- Renamed `taffy::Error` -> `taffy::error::TaffyError`
712- Replaced `taffy::error::InvalidChild` with a new `InvalidChild` variant of `taffy::error::TaffyError`
713- Replaced `taffy::error::InvalidNode` with a new `InvalidNode` variant of `taffy::error::TaffyError`
714- The following method new return `Err(TaffyError::ChildIndexOutOfBounds)` instead of panicking:
715  - `taffy::Taffy::remove_child_at_index`
716  - `taffy::Taffy::replace_child_at_index`
717  - `taffy::Taffy::child_at_index`
718- `Taffy::remove` now returns a `Result<usize, Error>`, to indicate if the operation was successful (and if it was, which ID was invalidated).
719
720#### Some uses of `Option<f32>` replaced with a new `AvailableSpace` enum
721
722A new enum `Taffy::layout::AvailableSpace` has been added.
723
724The definition looks like this:
725
726```rust
727/// The amount of space available to a node in a given axis
728pub enum AvailableSpace {
729    /// The amount of space available is the specified number of pixels
730    Definite(f32),
731    /// The amount of space available is indefinite and the node should be laid out under a min-content constraint
732    MinContent,
733    /// The amount of space available is indefinite and the node should be laid out under a max-content constraint
734    MaxContent,
735}
736```
737
738This 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`).
739
740And 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..
741
742#### Builder methods are now `const` where possible
743
744- Several convenience constants have been defined: notably `Style::DEFAULT`
745- `Size<f32>.zero()` is now `Size::<f32>::ZERO`
746- `Point<f32>.zero()` is now  `Point::<f32>::ZERO`
747- `Size::undefined()` is now `Size::NONE`
748
749#### Removals
750
751- 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%).
752- Removed `taffy::number::Number`. Use `Option<f32>` is used instead
753  - the associated public `MinMax` and `OrElse` traits have also been removed; these should never have been public
754- 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).
755
756### Fixes
757
758- Miscellaneous correctness fixes which align our implementation with Chrome:
759
760  - Nodes can only ever have one parent
761  - Fixed rounding of fractional values to follow latest Chrome - values are now rounded the same regardless of their position
762  - Fixed computing free space when using both `flex-grow` and a minimum size
763  - 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)
764  - `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
765- Taffy can now be vendored using `cargo-vendor` (README.md is now included in package).
766
767## 0.1.0
768
769### 0.1.0 Changed
770
771- the `order` field of `Layout` is now public, and describes the relative z-ordering of nodes
772- renamed crate from `stretch2` to `taffy`
773- updated to the latest version of all dependencies to reduce upstream pain caused by duplicate dependencies
774- renamed `stretch::node::Stretch` -> `taffy::node::Taffy`
775
776### 0.1.0 Fixed
777
778- fixed feature strategy for `alloc` and `std`: these can now be compiled together, with `std`'s types taking priority
779
780### 0.1.0 Removed
781
782- removed Javascript / Kotlin / Swift bindings
783  - the maintainer team lacks expertise to keep these working
784  - more serious refactors are planned, and this will be challenging to keep working through that process
785  - if you are interested in helping us maintain bindings to other languages, [get in touch](https://github.com/DioxusLabs/taffy/discussions)!
786- 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)
787- removed the `Direction` and `Overflow` structs, and the corresponding `direction` and `overflow` fields from `Style`
788  - these had no effect in the current code base and were actively misleading
789
790## stretch2 0.4.3
791
792This is the final release of `stretch`: migrate to the crate named `taffy` for future fixes and features!
793
794These notes describe the differences between this release and `stretch` 0.3.2, the abandoned crate from which this library was forked.
795
796### Changed
797
798- updated [assorted dependencies](https://github.com/vislyhq/stretch/commit/a6491117379cea52dedc9584d892594a143e8cb0)
799
800### Fixed
801
802- fixed an exponential performance blow-up with deep nesting
803- fixed percent height values, which were using parent width
804- recomputing layout no longer moves children of non-zero-positioned parent
805- fixed broken Swift bindings