mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
Merge pull request #2345 from davep/button-docs-tweakage
Some more Button docs tidying
This commit is contained in:
@@ -16,7 +16,7 @@ from ..widgets import Static
|
|||||||
ButtonVariant = Literal["default", "primary", "success", "warning", "error"]
|
ButtonVariant = Literal["default", "primary", "success", "warning", "error"]
|
||||||
"""The names of the valid button variants.
|
"""The names of the valid button variants.
|
||||||
|
|
||||||
These are the variants that can be used with a [Button][textual.widgets.Button].
|
These are the variants that can be used with a [`Button`][textual.widgets.Button].
|
||||||
"""
|
"""
|
||||||
|
|
||||||
_VALID_BUTTON_VARIANTS = {"default", "primary", "success", "warning", "error"}
|
_VALID_BUTTON_VARIANTS = {"default", "primary", "success", "warning", "error"}
|
||||||
@@ -281,7 +281,8 @@ class Button(Static, can_focus=True):
|
|||||||
disabled: Whether the button is disabled or not.
|
disabled: Whether the button is disabled or not.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
A Button widget of the 'success' variant.
|
A [`Button`][textual.widgets.Button] widget of the 'success'
|
||||||
|
[variant][textual.widgets.button.ButtonVariant].
|
||||||
"""
|
"""
|
||||||
return Button(
|
return Button(
|
||||||
label=label,
|
label=label,
|
||||||
@@ -313,7 +314,8 @@ class Button(Static, can_focus=True):
|
|||||||
disabled: Whether the button is disabled or not.
|
disabled: Whether the button is disabled or not.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
A Button widget of the 'warning' variant.
|
A [`Button`][textual.widgets.Button] widget of the 'warning'
|
||||||
|
[variant][textual.widgets.button.ButtonVariant].
|
||||||
"""
|
"""
|
||||||
return Button(
|
return Button(
|
||||||
label=label,
|
label=label,
|
||||||
@@ -345,7 +347,8 @@ class Button(Static, can_focus=True):
|
|||||||
disabled: Whether the button is disabled or not.
|
disabled: Whether the button is disabled or not.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
A Button widget of the 'error' variant.
|
A [`Button`][textual.widgets.Button] widget of the 'error'
|
||||||
|
[variant][textual.widgets.button.ButtonVariant].
|
||||||
"""
|
"""
|
||||||
return Button(
|
return Button(
|
||||||
label=label,
|
label=label,
|
||||||
|
|||||||
Reference in New Issue
Block a user