mirror of
https://github.com/ratatui-org/ratatui
synced 2024-11-22 04:33:13 +00:00
refactor!: remove items deprecated since 0.10 (#691)
Remove `Axis::title_style` and `Buffer::set_background` which are deprecated since 0.10
This commit is contained in:
parent
b8f71c0d6e
commit
b282a06932
3 changed files with 9 additions and 45 deletions
|
@ -11,7 +11,7 @@ github with a [breaking change] label.
|
|||
This is a quick summary of the sections below:
|
||||
|
||||
- Unreleased (0.24.1)
|
||||
- `List::start_corner` is renamed to `List::direction`
|
||||
- Removed `Axis::title_style` and `Buffer::set_background`
|
||||
- `List::new()` now accepts `IntoIterator<Item = Into<ListItem<'a>>>`
|
||||
- `Table::new()` now requires specifying the widths
|
||||
- `Table::widths()` now accepts `IntoIterator<Item = AsRef<Constraint>>`
|
||||
|
@ -42,28 +42,17 @@ This is a quick summary of the sections below:
|
|||
|
||||
## Unreleased (v0.24.1)
|
||||
|
||||
### `List::start_corner` is renamed to `List::direction` ([#673])
|
||||
### Removed `Axis::title_style` and `Buffer::set_background`
|
||||
|
||||
[#673]: https://github.com/ratatui-org/ratatui/pull/673
|
||||
These items were deprecated since 0.10.
|
||||
|
||||
Previously `List::start_corner` didn't communicate the intent of the method. It also used an
|
||||
inadequate `Corner` enum. The method is now renamed `direction` and a new enum
|
||||
`ListDirection` has been added.
|
||||
- You should use styling capabilities of [`text::Line`] given as argument of [`Axis::title`]
|
||||
instead of `Axis::title_style`
|
||||
- You should use styling capabilities of [`Buffer::set_style`] instead of `Buffer::set_background`
|
||||
|
||||
```diff
|
||||
- List::new(/* items */).start_corner(Corner::TopLeft);
|
||||
- List::new(/* items */).start_corner(Corner::TopRight);
|
||||
// This is not an error, BottomRight rendered top to bottom previously
|
||||
- List::new(/* items */).start_corner(Corner::BottomRight);
|
||||
// all becomes
|
||||
+ List::new(/* items */).direction(ListDirection::TopToBottom);
|
||||
```
|
||||
|
||||
```diff
|
||||
- List::new(/* items */).start_corner(Corner::BottomLeft);
|
||||
// becomes
|
||||
+ List::new(/* items */).direction(ListDirection::BottomToTop);
|
||||
```
|
||||
[`text::Line`]: https://docs.rs/ratatui/latest/ratatui/text/struct.Line.html
|
||||
[`Axis::title`]: https://docs.rs/ratatui/latest/ratatui/widgets/struct.Axis.html#method.title
|
||||
[`Buffer::set_style`]: https://docs.rs/ratatui/latest/ratatui/buffer/struct.Buffer.html#method.set_style
|
||||
|
||||
### `List::new()` now accepts `IntoIterator<Item = Into<ListItem<'a>>>` ([#672])
|
||||
|
||||
|
|
|
@ -367,18 +367,6 @@ impl Buffer {
|
|||
self.set_stringn(x, y, span.content.as_ref(), width as usize, span.style)
|
||||
}
|
||||
|
||||
#[deprecated(
|
||||
since = "0.10.0",
|
||||
note = "You should use styling capabilities of `Buffer::set_style`"
|
||||
)]
|
||||
pub fn set_background(&mut self, area: Rect, color: Color) {
|
||||
for y in area.top()..area.bottom() {
|
||||
for x in area.left()..area.right() {
|
||||
self.get_mut(x, y).set_bg(color);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub fn set_style(&mut self, area: Rect, style: Style) {
|
||||
for y in area.top()..area.bottom() {
|
||||
for x in area.left()..area.right() {
|
||||
|
|
|
@ -39,19 +39,6 @@ impl<'a> Axis<'a> {
|
|||
self
|
||||
}
|
||||
|
||||
#[deprecated(
|
||||
since = "0.10.0",
|
||||
note = "You should use styling capabilities of `text::Line` given as argument of the `title` method to apply styling to the title."
|
||||
)]
|
||||
#[must_use = "method moves the value of self and returns the modified value"]
|
||||
pub fn title_style(mut self, style: Style) -> Axis<'a> {
|
||||
if let Some(t) = self.title {
|
||||
let title = String::from(t);
|
||||
self.title = Some(TextLine::from(Span::styled(title, style)));
|
||||
}
|
||||
self
|
||||
}
|
||||
|
||||
#[must_use = "method moves the value of self and returns the modified value"]
|
||||
pub fn bounds(mut self, bounds: [f64; 2]) -> Axis<'a> {
|
||||
self.bounds = bounds;
|
||||
|
|
Loading…
Reference in a new issue