2
2
3
3
This document contains a list of breaking changes in each version and some notes to help migrate
4
4
between versions. It is compiled manually from the commit history and changelog. We also tag PRs on
5
- github with a [ breaking change] label.
5
+ GitHub with a [ breaking change] label.
6
6
7
7
[ breaking change ] : (https://github.com/ratatui-org/ratatui/issues?q=label%3A%22breaking+change%22)
8
8
@@ -37,7 +37,7 @@ This is a quick summary of the sections below:
37
37
- ` Scrollbar ` : symbols moved to ` symbols ` module
38
38
- MSRV is now 1.67.0
39
39
- [ v0.22.0] ( #v0220 )
40
- - serde representation of ` Borders ` and ` Modifiers ` has changed
40
+ - ` serde ` representation of ` Borders ` and ` Modifiers ` has changed
41
41
- [ v0.21.0] ( #v0210 )
42
42
- MSRV is now 1.65.0
43
43
- ` terminal::ViewPort ` is now an enum
@@ -49,14 +49,14 @@ This is a quick summary of the sections below:
49
49
50
50
## [ v0.26.0] ( https://github.com/ratatui-org/ratatui/releases/tag/v0.26.0 )
51
51
52
- ### ` Flex::Start ` is the new default flex mode for ` Layout `
52
+ ### ` Flex::Start ` is the new default flex mode for ` Layout ` ( [ # 881 ] )
53
53
54
54
[ #881 ] : https://github.com/ratatui-org/ratatui/pull/881
55
55
56
56
Previously, constraints would stretch to fill all available space, violating constraints if
57
57
necessary.
58
58
59
- With v0.26.0, ` Flex ` modes are introduced and the default is ` Flex::Start ` , which will align
59
+ With v0.26.0, ` Flex ` modes are introduced, and the default is ` Flex::Start ` , which will align
60
60
areas associated with constraints to be beginning of the area. With v0.26.0, additionally,
61
61
` Min ` constraints grow to fill excess space. These changes will allow users to build layouts
62
62
more easily.
@@ -108,7 +108,7 @@ by removing the call to `.collect()`.
108
108
[ #751 ] : https://github.com/ratatui-org/ratatui/pull/751
109
109
110
110
The default() implementation of Table now sets the column_spacing field to 1 and the segment_size
111
- field to SegmentSize::None. This will affect the rendering of a small amount of apps.
111
+ field to ` SegmentSize::None ` . This will affect the rendering of a small amount of apps.
112
112
113
113
To use the previous default values, call ` table.segment_size(Default::default()) ` and
114
114
` table.column_spacing(0) ` .
@@ -222,8 +222,8 @@ widget in the default configuration would not show any indication of the selecte
222
222
223
223
[ #664 ] : https://github.com/ratatui-org/ratatui/pull/664
224
224
225
- Previously ` Table ` s could be constructed without widths. In almost all cases this is an error.
226
- A new widths parameter is now mandatory on ` Table::new() ` . Existing code of the form:
225
+ Previously ` Table ` s could be constructed without ` widths ` . In almost all cases this is an error.
226
+ A new ` widths ` parameter is now mandatory on ` Table::new() ` . Existing code of the form:
227
227
228
228
``` diff
229
229
- Table::new(rows).widths(widths)
@@ -281,7 +281,7 @@ let layout = layout::new(Direction::Vertical, [Constraint::Min(1), Constraint::M
281
281
282
282
## [ v0.24.0] ( https://github.com/ratatui-org/ratatui/releases/tag/v0.24.0 )
283
283
284
- ### ScrollbarState field type changed from ` u16 ` to ` usize ` ([ #456 ] )
284
+ ### ` ScrollbarState ` field type changed from ` u16 ` to ` usize ` ([ #456 ] )
285
285
286
286
[ #456 ] : https://github.com/ratatui-org/ratatui/pull/456
287
287
@@ -385,12 +385,12 @@ The MSRV of ratatui is now 1.67 due to an MSRV update in a dependency (`time`).
385
385
386
386
## [ v0.22.0] ( https://github.com/ratatui-org/ratatui/releases/tag/v0.22.0 )
387
387
388
- ### bitflags updated to 2.3 ([ #205 ] )
388
+ ### ` bitflags ` updated to 2.3 ([ #205 ] )
389
389
390
390
[ #205 ] : https://github.com/ratatui-org/ratatui/issues/205
391
391
392
- The serde representation of bitflags has changed. Any existing serialized types that have Borders or
393
- Modifiers will need to be re-serialized. This is documented in the [ bitflags
392
+ The ` serde ` representation of ` bitflags ` has changed. Any existing serialized types that have Borders or
393
+ Modifiers will need to be re-serialized. This is documented in the [ ` bitflags `
394
394
changelog] ( https://github.com/bitflags/bitflags/blob/main/CHANGELOG.md#200-rc2 ) ..
395
395
396
396
## [ v0.21.0] ( https://github.com/ratatui-org/ratatui/releases/tag/v0.21.0 )
@@ -422,9 +422,9 @@ let terminal = Terminal::with_options(backend, TerminalOptions {
422
422
423
423
[ #168 ] : https://github.com/ratatui-org/ratatui/issues/168
424
424
425
- A new type ` Masked ` was introduced that implements ` From<Text<'a>> ` . This causes any code that did
425
+ A new type ` Masked ` was introduced that implements ` From<Text<'a>> ` . This causes any code that
426
426
previously did not need to use type annotations to fail to compile. To fix this, annotate or call
427
- to_string() / to_owned() / as_str() on the value. E.g.:
427
+ ` to_string() ` / ` to_owned() ` / ` as_str() ` on the value. E.g.:
428
428
429
429
``` diff
430
430
- let paragraph = Paragraph::new("".as_ref());
0 commit comments