🔀 Merge pull request #26 from davep/button-labels

Make dialog button labels configurable

Author: davep

ChangeLog.md

@@ -1,5 +1,12 @@
 # ChangeLog
 
+## Unreleased
+
+**Released: WiP**
+
+- Added the ability to configure any button label of any dialog.
+  ([#26](https://github.com/davep/textual-fspicker/pull/26))
+
 ## v0.3.0
 
 **Released: 2025-02-19**

src/textual_fspicker/base_dialog.py

@@ -8,6 +8,7 @@
 # Python imports.
 import sys
 from pathlib import Path
+from typing import Callable, TypeAlias
 
 ##############################################################################
 # Textual imports.
@@ -33,6 +34,11 @@ class InputBar(Horizontal):
     """The input bar area of the dialog."""
 
 
+##############################################################################
+ButtonLabel: TypeAlias = str | Callable[[str], str]
+"""The type for a button label value."""
+
+
 ##############################################################################
 class FileSystemPickerScreen(ModalScreen[Path | None]):
     """Base screen for the dialogs in this library."""
@@ -78,27 +84,49 @@ class FileSystemPickerScreen(ModalScreen[Path | None]):
     """The bindings for the dialog."""
 
     def __init__(
-        self, location: str | Path = ".", title: str = "", select_button: str = ""
+        self,
+        location: str | Path = ".",
+        title: str = "",
+        select_button: ButtonLabel = "",
+        cancel_button: ButtonLabel = "",
     ) -> None:
         """Initialise the dialog.
 
         Args:
             location: Optional starting location.
             title: Optional title.
-            select_button: Label for the select button.
+            select_button: Label or format function for the select button.
+            cancel_button: Label or format function for the cancel button.
         """
         super().__init__()
         self._location = location
         """The starting location."""
         self._title = title
         """The title for the dialog."""
-        self._select_button = select_button or "Select"
-        """The text prompt for the select button."""
+        self._select_button = select_button
+        """The text prompt for the select button, or a function to format it."""
+        self._cancel_button = cancel_button
+        """The text prompt for the cancel button, or a function to format it."""
 
     def _input_bar(self) -> ComposeResult:
         """Provide any widgets for the input bar, before the buttons."""
         yield from ()
 
+    @staticmethod
+    def _label(label: ButtonLabel, default: str) -> str:
+        """Create a label for use with a button.
+
+        Args:
+            label: The label value for the button.
+            default: The default label for the button.
+
+        Returns:
+            The formatted label.
+        """
+        # If the label is callable, then call it with the default as a
+        # parameter; otherwise use it as-is as it'll be a string.
+        return label(default) if callable(label) else label or default
+
     def compose(self) -> ComposeResult:
         """Compose the child widgets.
 
@@ -113,8 +141,8 @@ def compose(self) -> ComposeResult:
                 yield DirectoryNavigation(self._location)
             with InputBar():
                 yield from self._input_bar()
-                yield Button(self._select_button, id="select")
-                yield Button("Cancel", id="cancel")
+                yield Button(self._label(self._select_button, "Select"), id="select")
+                yield Button(self._label(self._cancel_button, "Cancel"), id="cancel")
 
     def on_mount(self) -> None:
         """Focus directory widget on mount."""

src/textual_fspicker/file_dialog.py

@@ -18,7 +18,7 @@
 
 ##############################################################################
 # Local imports.
-from .base_dialog import FileSystemPickerScreen
+from .base_dialog import ButtonLabel, FileSystemPickerScreen
 from .parts import DirectoryNavigation, DriveNavigation
 from .path_filters import Filters
 from .path_maker import MakePath
@@ -48,7 +48,8 @@ def __init__(
         self,
         location: str | Path = ".",
         title: str = "Open",
-        select_button: str = "",
+        select_button: ButtonLabel = "",
+        cancel_button: ButtonLabel = "",
         *,
         filters: Filters | None = None,
         default_file: str | Path | None = None,
@@ -58,11 +59,14 @@ def __init__(
         Args:
             location: Optional starting location.
             title: Optional title.
-            select_button: The label for the selection button.
+            select_button: The label for the select button.
+            cancel_button: The label for the cancel button.
             filters: Optional filters to show in the dialog.
             default_file: The default filename to place in the input.
         """
-        super().__init__(location, title, select_button=select_button)
+        super().__init__(
+            location, title, select_button=select_button, cancel_button=cancel_button
+        )
         self._filters = filters
         """The filters for the dialog."""
         self._default_file = default_file

src/textual_fspicker/file_open.py

@@ -10,6 +10,7 @@
 
 ##############################################################################
 # Local imports.
+from .base_dialog import ButtonLabel
 from .file_dialog import BaseFileDialog
 from .path_filters import Filters
 
@@ -23,6 +24,8 @@ def __init__(
         location: str | Path = ".",
         title: str = "Open",
         *,
+        open_button: ButtonLabel = "",
+        cancel_button: ButtonLabel = "",
         filters: Filters | None = None,
         must_exist: bool = True,
         default_file: str | Path | None = None,
@@ -32,14 +35,22 @@ def __init__(
         Args:
             location: Optional starting location.
             title: Optional title.
+            open_button: The label for the open button.
+            cancel_button: The label for the cancel button.
             filters: Optional filters to show in the dialog.
             must_exist: Flag to say if the file must exist.
             default_file: The default filename to place in the input.
+
+        Notes:
+            `open_button` and `cancel_button` can either be strings that
+            set the button label, or they can be functions that take the
+            default button label as a parameter and return the label to use.
         """
         super().__init__(
             location,
             title,
-            select_button="Open",
+            select_button=self._label(open_button, "Open"),
+            cancel_button=cancel_button,
             filters=filters,
             default_file=default_file,
         )

src/textual_fspicker/file_save.py

@@ -10,6 +10,7 @@
 
 ##############################################################################
 # Local imports.
+from .base_dialog import ButtonLabel
 from .file_dialog import BaseFileDialog
 from .path_filters import Filters
 
@@ -23,6 +24,8 @@ def __init__(
         location: str | Path = ".",
         title: str = "Save as",
         *,
+        save_button: ButtonLabel = "",
+        cancel_button: ButtonLabel = "",
         filters: Filters | None = None,
         can_overwrite: bool = True,
         default_file: str | Path | None = None,
@@ -32,14 +35,22 @@ def __init__(
         Args:
             location: Optional starting location.
             title: Optional title.
+            save_button: The label for the save button.
+            cancel_button: The label for the cancel button.
             filters: Optional filters to show in the dialog.
             can_overwrite: Flag to say if an existing file can be overwritten.
             default_file: The default filename to place in the input.
+
+        Notes:
+            `open_button` and `cancel_button` can either be strings that
+            set the button label, or they can be functions that take the
+            default button label as a parameter and return the label to use.
         """
         super().__init__(
             location,
             title,
-            select_button="Save",
+            select_button=self._label(save_button, "Save"),
+            cancel_button=cancel_button,
             filters=filters,
             default_file=default_file,
         )

src/textual_fspicker/select_directory.py

@@ -17,7 +17,7 @@
 
 ##############################################################################
 # Local imports.
-from .base_dialog import FileSystemPickerScreen
+from .base_dialog import ButtonLabel, FileSystemPickerScreen
 from .parts import DirectoryNavigation
 
 
@@ -60,15 +60,29 @@ class SelectDirectory(FileSystemPickerScreen):
     """A directory selection dialog."""
 
     def __init__(
-        self, location: str | Path = ".", title: str = "Select directory"
+        self,
+        location: str | Path = ".",
+        title: str = "Select directory",
+        *,
+        select_button: ButtonLabel = "",
+        cancel_button: ButtonLabel = "",
     ) -> None:
         """Initialise the dialog.
 
         Args:
             location: Optional starting location.
             title: Optional title.
+            select_button: The label for the select button.
+            cancel_button: The label for the cancel button.
+
+        Notes:
+            `select_button` and `cancel_button` can either be strings that
+            set the button label, or they can be functions that take the
+            default button label as a parameter and return the label to use.
         """
-        super().__init__(location, title)
+        super().__init__(
+            location, title, select_button=select_button, cancel_button=cancel_button
+        )
 
     def on_mount(self) -> None:
         """Configure the dialog once the DOM is ready."""