tawasuyu

tawasuyu/taffy

A high performance rust-powered UI layout library

Rust 788HTML 740Markdown 12TOML 62536 Definitions

⎇ 6fc374ff95716cede531bc188aeb69ef0111892f RELEASES.md Markdown · 502 lines · 27.1 KB History raw

Update 0.3.x for 0.3.11 (#455) 1cc940684 · Nico Burns ·

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

RELEASES.md

Release Notes

0.3.11

Fixes

0.3.10

Fixes

0.3.9

Fixes

0.3.8

Fixes

0.3.7

Fixes

0.3.6

Fixes

0.3.5

Fixes

0.3.4

Fixes

0.3.3

Added

Fixes

0.3.2

Fixes

0.3.1

Fixes

0.3.0

Highlights

See below for details of breaking changes.

New Feature: CSS Grid

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

Learning Resources

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

Supported Features & Properties

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

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

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

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

The following properties and features are not currently supported:

Example

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

cargo run --example grid_holy_grail --features grid

New Feature: Style Helpers

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

For example, instead of:

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

you can now write

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

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

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

Available style helpers:

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

Breaking API changes

Changes to alignment style types

Strict style types

Position properties renamed

Changes to LayoutTree

AvailableSpace has been moved

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

Fixes

Removed

0.2.2

Fixes

0.2.1

Fixes

0.2.0

New features

Flexbox "gap" and AlignContent::SpaceEvenly

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

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

Debug module and cargo feature

Two debugging features have been added:

Performance improvements

A number of performance improvements have landed since taffy 0.1:

Benchmarks vs. Taffy 0.1

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

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

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

However, in the "deep" benchmarks we see dramatic improvements. The previous version of Taffy suffered from exponential blowup in the case of deeply nested 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.

Benchmarks vs. Yoga

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

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

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

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

Breaking API changes

Node creation changes

Error handling/representation improvements

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

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

The definition looks like this:

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

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

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

Builder methods are now const where possible

Removals

Fixes

0.1.0

0.1.0 Changed

0.1.0 Fixed

0.1.0 Removed

stretch2 0.4.3

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

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

Changed

Fixed