From 0df17fc8f09455ab409d74398afffb7254bdbff3 Mon Sep 17 00:00:00 2001 From: Dave Pearson Date: Wed, 1 Mar 2023 16:46:47 +0000 Subject: [PATCH] Tidy up some Button documentation Adds missing documentation for disabled to each of the button variant constructors, and also pulls in a couple more public-visible Button-related types into the docs. --- docs/api/button.md | 2 ++ src/textual/widgets/_button.py | 10 +++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/api/button.md b/docs/api/button.md index 26d6b63cf..09e9f40bf 100644 --- a/docs/api/button.md +++ b/docs/api/button.md @@ -1 +1,3 @@ ::: textual.widgets.Button +::: textual.widgets._button.ButtonVariant +::: textual.widgets._button.InvalidButtonVariant diff --git a/src/textual/widgets/_button.py b/src/textual/widgets/_button.py index f8b22a969..6b02ab271 100644 --- a/src/textual/widgets/_button.py +++ b/src/textual/widgets/_button.py @@ -14,11 +14,16 @@ from ..reactive import reactive from ..widgets import Static ButtonVariant = Literal["default", "primary", "success", "warning", "error"] +"""The names of the valid button variants. + +These are the variants that can be used with a [Button][textual.widgets.Button]. +""" + _VALID_BUTTON_VARIANTS = {"default", "primary", "success", "warning", "error"} class InvalidButtonVariant(Exception): - pass + """Exception raised if an invalid button variant is used.""" class Button(Static, can_focus=True): @@ -262,6 +267,7 @@ class Button(Static, can_focus=True): name: The name of the button. id: The ID of the button in the DOM. classes: The CSS classes of the button. + disabled: Whether the button is disabled or not. Returns: A Button widget of the 'success' variant. @@ -293,6 +299,7 @@ class Button(Static, can_focus=True): name: The name of the button. id: The ID of the button in the DOM. classes: The CSS classes of the button. + disabled: Whether the button is disabled or not. Returns: A Button widget of the 'warning' variant. @@ -324,6 +331,7 @@ class Button(Static, can_focus=True): name: The name of the button. id: The ID of the button in the DOM. classes: The CSS classes of the button. + disabled: Whether the button is disabled or not. Returns: A Button widget of the 'error' variant.