ratatui/ratatui v0.23.1-alpha.1

on GitHub

v0.23.1-alpha.1 - 2023-09-09

Features

• d077903
  (backend) Backend provides window_size, add Size struct (#276)

  For image (sixel, iTerm2, Kitty...) support that handles graphics in
  terms of `Rect` so that the image area can be included in layouts.
  
  For example: an image is loaded with a known pixel-size, and drawn, but
  the image protocol has no mechanism of knowing the actual cell/character
  area that been drawn on. It is then impossible to skip overdrawing the
  area.
  
  Returning the window size in pixel-width / pixel-height, together with
  colums / rows, it can be possible to account the pixel size of each cell
  / character, and then known the `Rect` of a given image, and also resize
  the image so that it fits exactly in a `Rect`.
  
  Crossterm and termwiz also both return both sizes from one syscall,
  while termion does two.
  
  Add a `Size` struct for the cases where a `Rect`'s `x`/`y` is unused
  (always zero).
  
  `Size` is not "clipped" for `area < u16::max_value()` like `Rect`. This
  is why there are `From` implementations between the two.
  

Bug Fixes

• c8ab2d5
  (chart) Use graph style for top line (#462)

  A bug in the rendering caused the top line of the chart to be rendered
  using the style of the chart, instead of the dataset style. This is
  fixed by only setting the style for the width of the text, and not the
  entire row.
  

Documentation

• 0c68ebe
  (Block) Add documentation to Block (#469)

• e098731
  (barchart) Add documentation to BarChart (#449)

  Add documentation to the `BarChart` widgets and its sub-modules.
  

• 5c785b2
  (examples) Move example gifs to github (#460)

  - A new orphan branch named "images" is created to store the example
    images
  

• ca9bcd3
  (examples) Add descriptions and update theme (#460)

  - Use the OceanicMaterial consistently in examples
  

• 080a05b
  (paragraph) Add docs for alignment fn (#467)

• 232be80
  (table) Add documentation for Table::new() (#471)

• 28e7fd4
  (terminal) Fix doc comment (#452)

• 51fdcbe
  (title) Add documentation to title (#443)

  This adds documentation for Title and Position
  

• 927a5d8
  (uncategorized) Fix documentation lint warnings (#450)

• eda2fb7
  (uncategorized) Use ratatui 📚 (#446)

Testing

• ea70bff
  (barchart) Add benchmarks (#455)

Miscellaneous Tasks

• 82b40be
  (ci) Improve checking the PR title (#464)

  - Use [`action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request)
  - Allow only reading the PR contents
  - Enable merge group
  

• 5f6aa30
  (uncategorized) Check documentation lint (#454)

• 47ae602
  (uncategorized) Check that PR title matches conventional commit guidelines ♻️ (#459)

• 28c6157
  (uncategorized) Add documentation guidelines (#447)

Continuous Integration

• 343c6cd
  (lint) Move formatting and doc checks first (#465)

  Putting the formatting and doc checks first to ensure that more critical
  errors are caught first (e.g. a conventional commit error or typo should
  not prevent the formatting and doc checks from running).
  

• c95a75c
  (makefile) Remove termion dependency from doc lint (#470)

  Only build termion on non-windows targets
  

• b996102
  (makefile) Add format target (#468)

  - add format target to Makefile.toml that actually fixes the formatting
  - rename fmt target to lint-format
  - rename style-check target to lint-style
  - rename typos target to lint-typos
  - rename check-docs target to lint-docs
  - add section to CONTRIBUTING.md about formatting
  

• 572df75
  (uncategorized) Put commit id first in changelog (#463)

• 878b6fc
  (uncategorized) Ignore benches from code coverage (#461)