Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions BREAKING-CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ This document lists all breaking changes along with tips to help you migrate smo
## Summary

- [unreleased](#unreleased)
- `underline-color` feature is now opt-in
- [v0.4.0](#v040)
- `framebuffer` module is no longer part of the public API
- [v0.3.0](#v030)
Expand All @@ -25,6 +26,26 @@ This document lists all breaking changes along with tips to help you migrate smo

## Unreleased

### `underline-color` feature is now opt-in ([#166])

[#166]: https://github.com/ratatui/mousefood/pull/166

The `underline-color` feature was previously enabled by default. It is now opt-in to save 8 bytes
per terminal cell (4 bytes per cell in ratatui's two `Vec<Cell>` buffers), which also reduces
bandwidth on memory-constrained embedded hardware.

**Migration guide:**

If you use per-cell underline colors, enable the feature explicitly:

```diff
[dependencies]
- mousefood = "0.4.0"
+ mousefood = { version = "0.5.0", features = ["underline-color"] }
```

If you don't use underline colors, no changes are needed.

## [v0.4.0](https://github.com/ratatui/mousefood/releases/tag/0.4.0)

### `framebuffer` module is no longer part of the public API ([#149])
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ opt-level = 's'
overflow-checks = false

[workspace.dependencies]
ratatui-core = { version = "0.1.0", features = ["underline-color"] }
ratatui-core = "0.1.0"
thiserror = { version = "2.0.18", default-features = false }
embedded-graphics = "0.8.1"
embedded-graphics-simulator = "0.8.0"
Expand Down
1 change: 1 addition & 0 deletions mousefood/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ fonts = ["dep:embedded-graphics-unicodefonts"]
epd-weact = ["dep:weact-studio-epd"]
epd-waveshare = ["dep:epd-waveshare"]
framebuffer = []
underline-color = ["ratatui-core/underline-color"]

[lints]
workspace = true
1 change: 1 addition & 0 deletions mousefood/src/backend.rs
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,7 @@ where
}
}

#[cfg(feature = "underline-color")]
if cell.underline_color != style::Color::Reset {
style_builder = style_builder.underline_with_color(
TermColor::new(
Expand Down