Skip to content

Commit

Permalink
docs: document crossterm breaking change (#1281)
Browse files Browse the repository at this point in the history
  • Loading branch information
joshka authored Aug 4, 2024
1 parent 5eeb1cc commit 716c931
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions BREAKING-CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ GitHub with a [breaking change] label.
This is a quick summary of the sections below:

- [v0.28.0](#v0280) (unreleased)
- Ratatui now requires Crossterm 0.28.0
- `Layout::init_cache` no longer returns bool and takes a `NonZeroUsize` instead of `usize`
- `ratatui::terminal` module is now private
- `Axis::labels` now accepts `Vec<T: Into<Line>>`
Expand Down Expand Up @@ -62,6 +63,14 @@ This is a quick summary of the sections below:

## v0.28.0 (unreleased)

### Ratatui now requires Crossterm 0.28.0 ([#1278])

[#1278]: https://github.com/ratatui-org/ratatui/pull/1278

Crossterm is updated to version 0.28.0, which is a semver incompatible version with the previous
version (0.27.0). Ratatui re-exports the version of crossterm that it is compatible with under
`ratatui::crossterm`, which can be used to avoid incompatible versions in your dependency list.

### `Axis::labels()` now accepts `Vec<T: Into<Line>>` ([#1273])

[#1273]: https://github.com/ratatui-org/ratatui/pull/1173
Expand Down

0 comments on commit 716c931

Please sign in to comment.