From d787f61090be283288553f5d9c4a2bfd27daf3f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rodrigo=20Gir=C3=A3o=20Serr=C3=A3o?= <5621605+rodrigogiraoserrao@users.noreply.github.com> Date: Mon, 27 Mar 2023 22:32:18 +0100 Subject: [PATCH] State version of widget addition in docs. (#2144) * State version of widget addition in docs. Related issues: #2133 * Fix ListX version info. * Retroactively update changelog. --- CHANGELOG.md | 3 +++ docs/widgets/_template.md | 2 ++ docs/widgets/checkbox.md | 2 ++ docs/widgets/content_switcher.md | 2 ++ docs/widgets/label.md | 2 ++ docs/widgets/list_item.md | 2 ++ docs/widgets/list_view.md | 2 ++ docs/widgets/loading_indicator.md | 2 ++ docs/widgets/markdown.md | 2 ++ docs/widgets/markdown_viewer.md | 2 ++ docs/widgets/placeholder.md | 1 + docs/widgets/radiobutton.md | 2 ++ docs/widgets/radioset.md | 2 ++ docs/widgets/tabbed_content.md | 2 ++ docs/widgets/tabs.md | 2 ++ docs/widgets/tree.md | 2 ++ 16 files changed, 32 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6ef87f856..7ba83ff7c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -422,11 +422,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [0.6.0] - 2022-12-11 +https://textual.textualize.io/blog/2022/12/11/version-060 + ### Added - Added "inherited bindings" -- BINDINGS classvar will be merged with base classes, unless inherit_bindings is set to False - Added `Tree` widget which replaces `TreeControl`. - Added widget `Placeholder` https://github.com/Textualize/textual/issues/1200. +- Added `ListView` and `ListItem` widgets https://github.com/Textualize/textual/pull/1143 ### Changed diff --git a/docs/widgets/_template.md b/docs/widgets/_template.md index c9e60413b..1a69a80df 100644 --- a/docs/widgets/_template.md +++ b/docs/widgets/_template.md @@ -1,5 +1,7 @@ # Widget +!!! tip "Added in version x.y.z" + Widget description. - [ ] Focusable diff --git a/docs/widgets/checkbox.md b/docs/widgets/checkbox.md index 809de2e66..ac4cb2887 100644 --- a/docs/widgets/checkbox.md +++ b/docs/widgets/checkbox.md @@ -1,5 +1,7 @@ # Checkbox +!!! tip "Added in version 0.13.0" + A simple checkbox widget which stores a boolean value. - [x] Focusable diff --git a/docs/widgets/content_switcher.md b/docs/widgets/content_switcher.md index b9369452b..b7b0fdbaf 100644 --- a/docs/widgets/content_switcher.md +++ b/docs/widgets/content_switcher.md @@ -1,5 +1,7 @@ # ContentSwitcher +!!! tip "Added in version 0.14.0" + A widget for containing and switching display between multiple child widgets. diff --git a/docs/widgets/label.md b/docs/widgets/label.md index 96a31bcc6..8445eaae3 100644 --- a/docs/widgets/label.md +++ b/docs/widgets/label.md @@ -1,5 +1,7 @@ # Label +!!! tip "Added in version 0.5.0" + A widget which displays static text, but which can also contain more complex Rich renderables. - [ ] Focusable diff --git a/docs/widgets/list_item.md b/docs/widgets/list_item.md index 7a33e29d2..4eaf0263a 100644 --- a/docs/widgets/list_item.md +++ b/docs/widgets/list_item.md @@ -1,5 +1,7 @@ # ListItem +!!! tip "Added in version 0.6.0" + `ListItem` is the type of the elements in a `ListView`. - [ ] Focusable diff --git a/docs/widgets/list_view.md b/docs/widgets/list_view.md index 2aa03cb10..8c38ea027 100644 --- a/docs/widgets/list_view.md +++ b/docs/widgets/list_view.md @@ -1,5 +1,7 @@ # ListView +!!! tip "Added in version 0.6.0" + Displays a vertical list of `ListItem`s which can be highlighted and selected. Supports keyboard navigation. diff --git a/docs/widgets/loading_indicator.md b/docs/widgets/loading_indicator.md index 805c662b3..087e98c31 100644 --- a/docs/widgets/loading_indicator.md +++ b/docs/widgets/loading_indicator.md @@ -1,5 +1,7 @@ # LoadingIndicator +!!! tip "Added in version 0.15.0" + Displays pulsating dots to indicate when data is being loaded. - [ ] Focusable diff --git a/docs/widgets/markdown.md b/docs/widgets/markdown.md index 2b259a457..f06c01ee8 100644 --- a/docs/widgets/markdown.md +++ b/docs/widgets/markdown.md @@ -1,5 +1,7 @@ # Markdown +!!! tip "Added in version 0.11.0" + A widget to display a Markdown document. - [x] Focusable diff --git a/docs/widgets/markdown_viewer.md b/docs/widgets/markdown_viewer.md index 0fc2f06e4..5a0dd2f2e 100644 --- a/docs/widgets/markdown_viewer.md +++ b/docs/widgets/markdown_viewer.md @@ -1,5 +1,7 @@ # MarkdownViewer +!!! tip "Added in version 0.11.0" + A Widget to display Markdown content with an optional Table of Contents. - [x] Focusable diff --git a/docs/widgets/placeholder.md b/docs/widgets/placeholder.md index 237573312..e9a07b28e 100644 --- a/docs/widgets/placeholder.md +++ b/docs/widgets/placeholder.md @@ -1,5 +1,6 @@ # Placeholder +!!! tip "Added in version 0.6.0" A widget that is meant to have no complex functionality. Use the placeholder widget when studying the layout of your app before having to develop your custom widgets. diff --git a/docs/widgets/radiobutton.md b/docs/widgets/radiobutton.md index 6eb698312..d3f93a7ef 100644 --- a/docs/widgets/radiobutton.md +++ b/docs/widgets/radiobutton.md @@ -1,5 +1,7 @@ # RadioButton +!!! tip "Added in version 0.13.0" + A simple radio button which stores a boolean value. - [x] Focusable diff --git a/docs/widgets/radioset.md b/docs/widgets/radioset.md index df348d278..414b35e36 100644 --- a/docs/widgets/radioset.md +++ b/docs/widgets/radioset.md @@ -1,5 +1,7 @@ # RadioSet +!!! tip "Added in version 0.13.0" + A container widget that groups [`RadioButton`](./radiobutton.md)s together. - [ ] Focusable diff --git a/docs/widgets/tabbed_content.md b/docs/widgets/tabbed_content.md index 8c0c2dbde..ab723c097 100644 --- a/docs/widgets/tabbed_content.md +++ b/docs/widgets/tabbed_content.md @@ -1,5 +1,7 @@ # TabbedContent +!!! tip "Added in version 0.16.0" + Switch between mutually exclusive content panes via a row of tabs. - [x] Focusable diff --git a/docs/widgets/tabs.md b/docs/widgets/tabs.md index be2b1428a..759fc3e76 100644 --- a/docs/widgets/tabs.md +++ b/docs/widgets/tabs.md @@ -1,5 +1,7 @@ # Tabs +!!! tip "Added in version 0.15.0" + Displays a number of tab headers which may be activated with a click or navigated with cursor keys. - [x] Focusable diff --git a/docs/widgets/tree.md b/docs/widgets/tree.md index ff7df3ed0..153fff4c3 100644 --- a/docs/widgets/tree.md +++ b/docs/widgets/tree.md @@ -1,5 +1,7 @@ # Tree +!!! tip "Added in version 0.6.0" + A tree control widget. - [x] Focusable