Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix formatting #780

Merged
merged 1 commit into from
Nov 30, 2024
Merged

Fix formatting #780

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 12 additions & 6 deletions src/content/docs/concepts/widgets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,25 @@ UIs, and can be easily customized to suit the needs of your application.
Ratatui provides a wide variety of built-in widgets that can be used to quickly create UIs. These
widgets include:

- [`Block`]|[`Example`](/examples/widgets/block): A basic Widget that draws a block with optional borders, titles, and styles.
- [`BarChart`]|[`Example`](/examples/widgets/barchart): Displays multiple datasets as bars with optional grouping.
- [`Block`]|[`Example`](/examples/widgets/block): A basic Widget that draws a block with optional
borders, titles, and styles.
- [`BarChart`]|[`Example`](/examples/widgets/barchart): Displays multiple datasets as bars with
optional grouping.
- [`Calendar`]|[`Example`](/examples/widgets/calendar): Displays a single month.
- [`Canvas`]|[`Example`](/examples/widgets/canvas): Draws arbitrary shapes using drawing characters.
- [`Chart`]|[`Example`](/examples/widgets/chart): Displays multiple datasets as a lines or scatter graph.
- [`Chart`]|[`Example`](/examples/widgets/chart): Displays multiple datasets as a lines or scatter
graph.
- [`Clear`]: Clears the area it occupies. Useful to render over previously drawn widgets.
- [`Gauge`]|[`Example`](/examples/widgets/gauge): Displays progress percentage using block characters.
- [`Gauge`]|[`Example`](/examples/widgets/gauge): Displays progress percentage using block
characters.
- [`LineGauge`]: Display progress as a line.
- [`List`]|[`Example`](list): Displays a list of items and allows selection.
- [`Paragraph`]|[`Example`](/examples/widgets/paragraph): Displays a paragraph of optionally styled and wrapped text.
- [`Paragraph`]|[`Example`](/examples/widgets/paragraph): Displays a paragraph of optionally styled
and wrapped text.
- [`Scrollbar`]|[`Example`](/examples/widgets/scrollbar): Displays a scrollbar.
- [`Sparkline`]|[`Example`](/examples/widgets/sparkline): Display a single data set as a sparkline.
- [`Table`]|[`Example`](/examples/widgets/table): Displays multiple rows and columns in a grid and allows selection.
- [`Table`]|[`Example`](/examples/widgets/table): Displays multiple rows and columns in a grid and
allows selection.
- [`Tabs`]|[`Example`](/examples/widgets/tabs): Displays a tab bar and allows selection.

Additionally, [`String`], [`&str`], [`Span`], [`Line`], and [`Text`] can be used as widgets (though
Expand Down