Notifications

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 
 - Added `DataTable.remove_column` method https://github.com/Textualize/textual/pull/2899
+- Added notifications https://github.com/Textualize/textual/pull/2866
 
 ### Fixed
 
@@ -26,9 +27,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 
 - Updated `DataTable.get_cell` type hints to accept string keys https://github.com/Textualize/textual/issues/2586
-- Added `DataTable.get_cell_coordinate` method 
+- Added `DataTable.get_cell_coordinate` method
 - Added `DataTable.get_row_index` method https://github.com/Textualize/textual/issues/2587
-- Added `DataTable.get_column_index` method   
+- Added `DataTable.get_column_index` method
 - Added can-focus pseudo-class to target widgets that may receive focus
 - Make `Markdown.update` optionally awaitable https://github.com/Textualize/textual/pull/2838
 - Added `default` parameter to `DataTable.add_column` for populating existing rows https://github.com/Textualize/textual/pull/2836

docs/examples/widgets/toast.py

@@ -0,0 +1,26 @@
+from textual.app import App
+
+
+class ToastApp(App[None]):
+    def on_mount(self) -> None:
+        # Show an information notification.
+        self.notify("It's an older code, sir, but it checks out.")
+
+        # Show a warning. Note that Textual's notification system allows
+        # for the use of Rich console markup.
+        self.notify(
+            "Now witness the firepower of this fully "
+            "[b]ARMED[/b] and [i][b]OPERATIONAL[/b][/i] battle station!",
+            title="Possible trap detected",
+            severity="warning",
+        )
+
+        # Show an error. Set a longer timeout so it's noticed.
+        self.notify("It's a trap!", severity="error", timeout=10)
+
+        # Show an information notification, but without any sort of title.
+        self.notify("It's against my programming to impersonate a deity.", title="")
+
+
+if __name__ == "__main__":
+    ToastApp().run()

docs/widgets/toast.md

@@ -0,0 +1,79 @@
+# Toast
+
+!!! tip "Added in version 0.30.0"
+
+A widget which displays a notification message.
+
+- [ ] Focusable
+- [ ] Container
+
+Note that `Toast` isn't designed to be used directly in your applications,
+but it is instead used by [`notify`][textual.app.App.notify] to
+display a message when using Textual's built-in notification system.
+
+## Styling
+
+You can customize the style of Toasts by targeting the `Toast` [CSS type](/guide/CSS/#type-selector).
+For example:
+
+
+```scss
+Toast {
+    padding: 3;
+}
+```
+
+The three severity levels also have corresponding
+[classes](/guide/CSS/#class-name-selector), allowing you to target the
+different styles of notification. They are:
+
+- `-information`
+- `-warning`
+- `-error`
+
+If you wish to tailor the notifications for your application you can add
+rules to your CSS like this:
+
+```scss
+Toast.-information {
+    /* Styling here. */
+}
+
+Toast.-warning {
+    /* Styling here. */
+}
+
+Toast.-error {
+    /* Styling here. */
+}
+```
+
+You can customize just the title wih the `toast--title` class.
+The following would make the title italic for an information toast:
+
+```scss
+Toast.-information .toast--title {
+    text-style: italic;
+}
+
+```
+
+## Example
+
+=== "Output"
+
+    ```{.textual path="docs/examples/widgets/toast.py"}
+    ```
+
+=== "toast.py"
+
+    ```python
+    --8<-- "docs/examples/widgets/toast.py"
+    ```
+
+---
+
+::: textual.widgets._toast
+    options:
+      show_root_heading: true
+      show_root_toc_entry: true