All Versions
33
Latest Version
Avg Release Cycle
56 days
Latest Release
116 days ago

Changelog History
Page 1

  • v0.19.0 Changes

    August 14, 2022

    πŸ”‹ Features

    • ⬆️ Bump crossterm to 0.25
  • v0.18.0 Changes

    April 24, 2022

    πŸ”‹ Features

    • ⚑️ Update crossterm to 0.23
  • v0.17.0 Changes

    January 22, 2022

    πŸ”‹ Features

    • βž• Add option to widgets::List to repeat the hightlight symbol for each line of multi-line items (#533).
    • βž• Add option to control the alignment of Axis labels in the Chart widget (#568).

    πŸ’₯ Breaking changes

    • πŸ‘ The minimum supported rust version is now 1.56.1.

    πŸ†• New default backend and consolidated backend options (#553)

    • 0️⃣ crossterm is now the default backend. If you are already using the crossterm backend, you can simplify your dependency specification in Cargo.toml: diff - tui = { version = "0.16", default-features = false, features = ["crossterm"] } + tui = "0.17" If you are using the termion backend, your Cargo is now a bit more verbose: diff - tui = "0.16" + tui = { version = "0.17", default-features = false, features = ["termion"] }

    crossterm has also been bumped to version 0.22.

    🚚 Because of their apparent low usage, curses and rustbox backends have been removed. If you are using one of them, you can import their last implementation in your own project:

    Canvas labels (#543)

    • Labels of the Canvas widget are now text::Spans. ⚑️ The signature of widgets::canvas::Context::print has thus been updated: diff - ctx.print(x, y, "Some text", Color::Yellow); + ctx.print(x, y, Span::styled("Some text", Style::default().fg(Color::Yellow)))
  • v0.16.0 Changes

    August 01, 2021

    πŸ”‹ Features

    • ⚑️ Update crossterm to 0.20.
    • βž• Add From<Cow<str>> implementation for text::Text (#471).
    • βž• Add option to right or center align the title of a widgets::Block (#462).

    πŸ›  Fixes

    • πŸ’… Apply label style in widgets::Gauge and avoid panics because of overflows with long labels (#494).
    • Avoid panics because of overflows with long axis labels in widgets::Chart (#512).
    • πŸ›  Fix computation of column widths in widgets::Table (#514).
    • πŸ›  Fix panics because of invalid offset when input changes between two frames in widgets::List and widgets::Chart (#516).
  • v0.15.0 Changes

    May 02, 2021

    πŸ”‹ Features

    • ⚑️ Update crossterm to 0.19.
    • ⚑️ Update rand to 0.8.
    • βž• Add a read-only view of the terminal state after the draw call (#440).

    πŸ›  Fixes

    • βœ‚ Remove compile warning in TestBackend::assert_buffer (#466).
  • v0.14.0 Changes

    January 01, 2021

    πŸ’₯ Breaking changes

    πŸ†• New API for the Table widget

    The Table widget got a lot of improvements that should make it easier to work with:

    • It should not longer panic when rendered on small areas.
    • πŸ’… Rows are now a collection of Cells, themselves wrapping a Text. This means you can style the entire Table, an entire Row, an entire Cell and rely on the styling capabilities of Text to get full control over the look of your Table.
    • Rows can have multiple lines.
    • The header is now optional and is just another Row always visible at the top.
    • Rows can have a bottom margin.
    • The header alignment is no longer off when an item is selected.

    πŸ’» Taking the example of the code in examples/demo/ui.rs, this is what you may have to change:

         let failure_style = Style::default()
             .fg(Color::Red)
             .add_modifier(Modifier::RAPID_BLINK | Modifier::CROSSED_OUT);
    -    let header = ["Server", "Location", "Status"];
         let rows = app.servers.iter().map(|s| {
             let style = if s.status == "Up" {
                 up_style
             } else {
                 failure_style
             };
    -        Row::StyledData(vec![s.name, s.location, s.status].into_iter(), style)
    +        Row::new(vec![s.name, s.location, s.status]).style(style)
         });
    -    let table = Table::new(header.iter(), rows)
    +    let table = Table::new(rows)
    +        .header(
    +            Row::new(vec!["Server", "Location", "Status"])
    +                .style(Style::default().fg(Color::Yellow))
    +                .bottom_margin(1),
    +        )
             .block(Block::default().title("Servers").borders(Borders::ALL))
    -        .header_style(Style::default().fg(Color::Yellow))
             .widths(&[
                 Constraint::Length(15),
                 Constraint::Length(15),
    

    Here, we had to:

    • πŸ”„ Change the way we construct Row which is no longer an enum but a struct. It accepts anything that can be converted to an iterator of things πŸ“„ that can be converted to a Cell
    • The header is no longer a required parameter so we use πŸ“„ Table::header to set it. πŸ’… Table::header_style has been removed since the style can be directly set using πŸ’… Row::style. In addition, we want to preserve the old margin between the header and the rest of the rows so we add a bottom margin to the header using πŸ“„ Row::bottom_margin.

    πŸ“š You may want to look at the documentation of the different types to get a better understanding:

    πŸ›  Fixes

    • πŸ›  Fix handling of Non Breaking Space (NBSP) in wrapped text in Paragraph widget.

    πŸ”‹ Features

    • βž• Add Style::reset to create a Style resetting all styling properties when applied.
    • βž• Add an option to render the Gauge widget with unicode blocks.
    • Manage common project tasks with cargo-make rather than make for easier on-boarding.
  • v0.13.0 Changes

    November 14, 2020

    πŸ”‹ Features

    • βž• Add LineGauge widget which is a more compact variant of the existing Gauge.
    • ⬆️ Bump crossterm to 0.18

    πŸ›  Fixes

    • Take into account the borders of the Table widget when the widths of columns is controlled by
      Percentage and Ratio constraints.
  • v0.12.0 Changes

    September 27, 2020

    πŸ”‹ Features

    • πŸ‘‰ Make it easier to work with string with multiple lines in Text (#361).

    πŸ›  Fixes

    • πŸ›  Fix a style leak in Graph so components drawn on top of the plotted data (i.e legend and axis
      πŸ’… titles) are not affected by the style of the Datasets (#388).
    • πŸ‘‰ Make sure BarChart shows bars with the max height only when the plotted data is actually equal
      to the max (#383).
  • v0.11.0 Changes

    September 20, 2020

    Β Features

    • βž• Add the dot character as a new type of canvas marker (#350).
    • πŸ‘Œ Support more style modifiers on Windows (#368).

    πŸ›  Fixes

    • πŸ’» Clearing the terminal through Terminal::clear will cause the whole UI to be redrawn (#380).
    • πŸ›  Fix incorrect output when the first diff to draw is on the second cell of the terminal (#347).
  • v0.10.0 Changes

    July 17, 2020

    πŸ’₯ Breaking changes

    Easier cursor management

    A new method has been added to Frame called set_cursor. It lets you specify where the cursor should be placed after the draw call. Furthermore like any other widgets, if you do not set a cursor position during a draw call, the cursor is automatically hidden.

    For example:

    fn draw_input(f: &mut Frame, app: &App) {
      if app.editing {
        let input_width = app.input.width() as u16;
        // The cursor will be placed just after the last character of the input
        f.set_cursor((input_width + 1, 0));
      } else {
        // We are no longer editing, the cursor does not have to be shown, set_cursor is not called and
        // thus automatically hidden.
      }
    }
    

    In order to make this possible, the draw closure takes in input &mut Frame instead of mut Frame.

    Advanced text styling

    It has been reported several times that the text styling capabilities were somewhat limited in many πŸš€ places of the crate. To solve the issue, this release includes a new set of text primitives that are now used by a majority of widgets to provide flexible text styling.

    Text is replaced by the following types:

    • πŸ’… Span: a string with a unique style.
    • πŸ’… Spans: a string with multiple styles.
    • πŸ’… Text: a multi-lines string with multiple styles.

    However, you do not always need this complexity so the crate provides From implementations to 0️⃣ let you use simple strings as a default and switch to the previous primitives when you need βž• additional styling capabilities.

    For example, the title of a Block can be set in the following ways:

    // A title with no styling
    Block::default().title("My title");
    // A yellow title
    Block::default().title(Span::styled("My title", Style::default().fg(Color::Yellow)));
    // A title where "My" is bold and "title" is a simple string
    Block::default().title(vec![
        Span::styled("My", Style::default().add_modifier(Modifier::BOLD)),
        Span::from("title")
    ]);
    
    • Buffer::set_spans and Buffer::set_span were added.
    • Paragraph::new expects an input that can be converted to a Text.
    • πŸ’… Block::title_style is deprecated.
    • Block::title expects a Spans.
    • Tabs expects a list of Spans.
    • Gauge custom label is now a Span.
    • Axis title and labels are Spans (as a consequence Chart no longer has generic bounds).

    Incremental styling

    πŸ’… Previously Style was used to represent an exhaustive set of style rules to be applied to an UI element. It implied that whenever you wanted to change even only one property you had to provide the πŸ’… complete style. For example, if you had a Block where you wanted to have a green background and a title in bold, you had to do the following:

    let style = Style::default().bg(Color::Green);
    Block::default()
      .style(style)
      .title("My title")
      // Here we reused the style otherwise the background color would have been reset
      .title_style(style.modifier(Modifier::BOLD));
    

    πŸš€ In this new release, you may now write this as:

    Block::default()
        .style(Style::default().bg(Color::Green))
        // The style is not overidden anymore, we simply add new style rule for the title.
        .title(Span::styled("My title", Style::default().add_modifier(Modifier::BOLD)))
    

    πŸ’… In addition, the crate now provides a method patch to combine two styles into a new set of style rules:

    let style = Style::default().modifer(Modifier::BOLD);
    let style = style.patch(Style::default().add_modifier(Modifier::ITALIC));
    // style.modifer == Modifier::BOLD | Modifier::ITALIC, the modifier has been enriched not overidden
    
    • πŸ’… Style::modifier has been removed in favor of Style::add_modifier and Style::remove_modifier.
    • πŸ’… Buffer::set_style has been added. Buffer::set_background is deprecated.
    • πŸ’… BarChart::style no longer set the style of the bars. Use BarChart::bar_style in replacement.
    • πŸ’… Gauge::style no longer set the style of the gauge. Use Gauge::gauge_style in replacement.

    List with item on multiple lines

    πŸ”¨ The List widget has been refactored once again to support items with variable heights and complex styling.

    • List::new expects an input that can be converted to a Vec<ListItem> where ListItem is a wrapper around the item content to provide additional styling capabilities. ListItem contains a Text.
    • 🚚 List::items has been removed.
    // Before
    let items = vec![
      "Item1",
      "Item2",
      "Item3"
    ];
    List::default().items(items.iters());
    
    // After
    let items = vec![
      ListItem::new("Item1"),
      ListItem::new("Item2"),
      ListItem::new("Item3"),
    ];
    List::new(items);
    

    πŸ‘€ See the examples for more advanced usages.

    More wrapping options

    Paragraph::wrap expects Wrap instead of bool to let users decided whether they want to trim whitespaces when the text is wrapped.

    // before
    Paragraph::new(text).wrap(true)
    // after
    Paragraph::new(text).wrap(Wrap { trim: true }) // to have the same behavior
    Paragraph::new(text).wrap(Wrap { trim: false }) // to use the new behavior
    

    Horizontal scrolling in paragraph

    You can now scroll horizontally in Paragraph. The argument of Paragraph::scroll has thus be πŸ”„ changed from u16 to (u16, u16).

    πŸ”‹ Features

    πŸ’… Serialization of style

    πŸ’… You can now serialize and de-serialize Style using the optional serde feature.