tawasuyu

tawasuyu/taffy

A high performance rust-powered UI layout library

HTML 5544Rust 88Markdown 11TOML 91926 Definiciones

⎇ devin/1784876938-clearance-margin-collapsing CHANGELOG.md Markdown · 1082 líneas · 50.9 KB Historia crudo

Fix clearance calculation and its interaction with margin collapsing df46fcf36 · Nico Burns ·

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

CHANGELOG.md

Changelog

Unreleased

Changed

Fixed

0.12.2

Fixed

0.12.1

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

Fixed

0.12.0

The MSRV for this release is 1.71.

Block: support for align-content (#959)

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

More correct caching logic

Fixed

0.11.0

The MSRV for this release is 1.71.

Implemented safe alignment keywords (#952)

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

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

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

Fixed

0.10.1

Fixed

0.10.0

The MSRV for this release is 1.71.

Support for direction

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

Support for floats

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

Float support is feature flagged by the float_layout feature.

Support for parsing styles from CSS string (#929)

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

CSS parsing is feature flagged by the parse feature.

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

Changed

Fixed

0.9.3

Added

0.9.2

Fixed

Changed

0.9.1

Fixed

0.9.0

The MSRV for this release is 1.65.

Support for named grid lines and grid areas

Taffy now supports named grid lines and areas.

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

Changed

Added

0.8.3

Fixed

0.8.2

Fixed

0.8.1

Added

0.8.0

Highlights

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

To use this API:

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

Changed

Added

Fixed

0.7.7

Fixed

0.7.6

Fixed

0.7.5

Fixed

0.7.4

Fixed

0.7.3

Fixed

0.7.2

Added

0.7.1

Fixed

Added

Removed

0.7.0

Changed

Added

0.6.3

Fixes

0.6.2

Fixes

0.6.1

Fixes

0.6.0

Highlights

Fixes

Added

0.5.2

0.5.1

0.5.0

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

0.4.4

Fixes

0.4.3

Fixes

0.4.2

0.4.1

0.4.0

Highlights

Block layout

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

Overflow property

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

Measure function changes

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

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

let mut tree = Taffy::new();

to

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

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

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

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

Should become something like the following with Taffy 0.4:

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

Note that:

Low-level API (LayoutTree trait) refactor

The low-level API has been completely reworked:

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

Module hierarchy changes

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

Specific changes:

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

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

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

Example usage change:

 use taffy::prelude::*;

 // …

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

Other Changes

0.3.19

Fixes

0.3.18

Fixes

0.3.17

Added

0.3.16

Fixes

0.3.15

Fixes

0.3.14

Fixes

0.3.13

Fixes

Dependencies

0.3.12

Fixes

0.3.11

Fixes

0.3.10

Fixes

0.3.9

Fixes

0.3.8

Fixes

0.3.7

Fixes

0.3.6

Fixes

0.3.5

Fixes

0.3.4

Fixes

0.3.3

Added

Fixes

0.3.2

Fixes

0.3.1

Fixes

0.3.0

Highlights

See below for details of breaking changes.

New Feature: CSS Grid

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

Learning Resources

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

Supported Features & Properties

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

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

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

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

The following properties and features are not currently supported:

Example

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

cargo run --example grid_holy_grail --features grid

New Feature: Style Helpers

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

For example, instead of:

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

you can now write

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

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

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

Available style helpers:

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

Breaking API changes

Changes to alignment style types

Strict style types

Position properties renamed

Changes to LayoutTree

AvailableSpace has been moved

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

Fixes

Removed

0.2.2

Fixes

0.2.1

Fixes

0.2.0

New features

Flexbox "gap" and AlignContent::SpaceEvenly

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

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

Debug module and cargo feature

Two debugging features have been added:

Performance improvements

A number of performance improvements have landed since taffy 0.1:

Benchmarks vs. Taffy 0.1

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

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

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

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

Benchmarks vs. Yoga

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

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

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

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

Breaking API changes

Node creation changes

Error handling/representation improvements

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

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

The definition looks like this:

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

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

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

Builder methods are now const where possible

Removals

Fixes

0.1.0

0.1.0 Changed

0.1.0 Fixed

0.1.0 Removed

stretch2 0.4.3

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

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

Changed

Fixed