Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
phire22 committed Apr 29, 2024
1 parent 3186318 commit 1bc0f97
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
6 changes: 6 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
//! # A versatile widget list for Ratatui
//!
//!<div align="center">
//!
//! [![Continuous Integration](https://github.com/preiter93/tui-widget-list/actions/workflows/ci.yml/badge.svg)](https://github.com/preiter93/tui-widget-list/actions/workflows/ci.yml)
//!
//! </div>
//!
//! This crate provides a stateful widget [`List`] implementation for `Ratatui`, enabling listing
//! widgets that implement the [`ListableWidget`] trait. The associated [`ListState`], offers functionalities
//! such as navigating to the next and previous items.
Expand Down
4 changes: 3 additions & 1 deletion src/traits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ pub trait ListableWidget: Widget {
/// Callback invoked when rendering the widget.
///
/// This method is called during rendering to allow the widget to mutate itself based
/// on additional render info. It should return the main axis size of the widget.
/// on additional render info.
///
/// Return the main axis size of the widget.
fn on_render(&mut self, render_info: &RenderInfo) -> u16;
}

Expand Down

0 comments on commit 1bc0f97

Please sign in to comment.