feat: Toasts #2111
Open
feat: Toasts #2111
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implements toast(), toast_header(), show_toast(), and hide_toast() functions to create temporary, non-intrusive notification messages. Key features: - Multiple semantic types (success, warning, error, info, etc.) - Flexible positioning (9 positions: top/middle/bottom × left/center/right) - Auto-hide with configurable duration or persistent display - Optional headers with icons and status text - Programmatic show/hide control - Full type safety with proper type hints This implementation: - Adds shiny/ui/_toast.py with core functionality - Exports functions from shiny.ui and shiny.express.ui - Uses existing vendored bslib JavaScript handlers - Follows py-shiny patterns from notification and modal systems 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
API Examples: - Created app-core.py demonstrating all toast features - Created app-express.py with express syntax examples - Examples cover: basic toasts, types, positions, duration control Unit Tests (31 tests, all passing): - Position normalization tests (11 tests) - Toast constructor tests (7 tests) - Toast rendering tests (6 tests) - ToastHeader tests (4 tests) - Integration tests (3 tests) All tests validate: - Position handling (kebab-case, space-separated, lists, case-insensitive) - Type validation and error alias - Autohide and closable combinations - HTML structure and accessibility attributes - Header rendering with icons and status 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Playwright Controller: - Created Toast controller in shiny/playwright/controller/_toast.py - Methods for checking visibility, text content, type, position, autohide - Exports Toast from controller __init__.py End-to-End Tests (8 tests): - test_toast_basic: Basic display and auto-hide - test_toast_types: Success, warning, error type styling - test_toast_header: Structured header with icons - test_toast_positions: Top-left and bottom-right positioning - test_toast_persistent: Non-auto-hiding toasts - test_toast_hide: Programmatic hide_toast() functionality - test_toast_multiple: Multiple simultaneous toasts Test app provides comprehensive coverage of toast features: - Different types and positions - Headers with icons - Persistent toasts - Programmatic control 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
CHANGELOG: - Added entry under New features for toast notification system - Describes key capabilities: types, positions, auto-hide, headers, programmatic control Quartodoc configs: - Added toast functions to _quartodoc-core.yml under "Display messages" - ui.toast, ui.toast_header, ui.show_toast, ui.hide_toast - Added express functions to _quartodoc-express.yml - express.ui.show_toast, express.ui.hide_toast - Added Toast controller to _quartodoc-testing.yml - playwright.controller.Toast 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Fixed test_toast_additional_attributes to use proper keyword arguments instead of unpacking a dict, which was causing type errors. Also applied isort formatting fix to test_toast.py. All checks passing: - Type check: 0 errors - Unit tests: 31 tests passed - Formatting: All files formatted correctly 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Updated both app-core.py and app-express.py to provide a comprehensive toast notification demo similar to the R bslib example. Features include: - Interactive toast builder with full customization options - Type and position selection - Duration control with slider - Header options with Font Awesome icons (via faicons) - Advanced features (persistent, long duration, no close button) - Interactive toasts with action buttons - Multiple toast demonstrations - Position testing across all 9 positions - Dynamic content toast with matplotlib plot (core only) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Includes new make target: `make test-update-snapshots`
cpsievert
reviewed
Nov 5, 2025
cpsievert
reviewed
Nov 5, 2025
cpsievert
reviewed
Nov 5, 2025
| @@ -1,5 +1,5 @@ | |||
| list( | |||
| bslib = "rstudio/bslib@main", | |||
| bslib = "rstudio/bslib@feat/toasts", | |||
Collaborator
There was a problem hiding this comment.
Just a reminder before we merge
Suggested change
| bslib = "rstudio/bslib@feat/toasts", | |
| bslib = "rstudio/bslib@main", |
cpsievert
reviewed
Nov 5, 2025
cpsievert
reviewed
Nov 5, 2025
cpsievert
reviewed
Nov 5, 2025
Comment on lines
+213
to
+224
| toast_obj = ui.toast( | ||
| input.body(), | ||
| header=header, | ||
| icon=body_icon, | ||
| type=input.type() if input.type() else None, | ||
| duration_s=input.duration() if input.duration() > 0 else None, | ||
| position=input.position(), | ||
| closable=input.closable(), | ||
| ) | ||
|
|
||
| # Show and store ID | ||
| id = ui.show_toast(toast_obj) |
Collaborator
There was a problem hiding this comment.
Do you feel like the ui.modal() API should also look like this (i.e., not be context manager based)?
Collaborator
Author
There was a problem hiding this comment.
Ugh, sorry, I was threading this work between other things and forgot that I intended to update those to use use context managers like modal
Collaborator
Author
There was a problem hiding this comment.
No wait, I was right. ui.modal() looks like this currently and is not a context manager. I kind of think it should be a context manager, but we decided in our conversation earlier this week not to take that on quite yet.
Related: #2108
cpsievert
reviewed
Nov 5, 2025
| @@ -0,0 +1,585 @@ | |||
| from __future__ import annotations | |||
|
|
|||
| __all__ = ("toast", "toast_header", "show_toast", "hide_toast") | |||
Collaborator
There was a problem hiding this comment.
I believe it's more common to place __all__ after imports
Collaborator
Author
There was a problem hiding this comment.
After a quick scan, we don't have any internal consistency about this, we're about equally likely to put __all__ above or below imports and sometimes we put __all__ at the bottom of the file.
Personally, I'd rather __all__ appear above imports, since it serves as a sort of table of contents for the most important functions in this file and I feel it gets lost below imports. It turns out PEP8 agrees with this:
According to PEP 8, the official Python style guide,
__all__should be placed after the module docstring but before any import statements (except forfrom __future__imports, which must come first).
cpsievert
reviewed
Nov 5, 2025
shiny/ui/_toast.py
Outdated
Comment on lines
60
to
64
| def _normalize_type(self, type: Optional[str]) -> Optional[str]: | ||
| """Normalize type, handling 'error' -> 'danger' alias.""" | ||
| if type == "error": | ||
| return "danger" | ||
| return type |
Collaborator
There was a problem hiding this comment.
This abstraction doesn't feel worth it to me
Collaborator
Author
There was a problem hiding this comment.
Actually, I changed my mind and went the other way with this. I moved this into a helper function (a5b5c67):
- that follows the pattern of
_normalize_toast_position(); - is used in
Toastand in the toast pytest controller; - can serve as a place for changes in the future if we add validation or other states.
cpsievert
reviewed
Nov 5, 2025
cpsievert
reviewed
Nov 5, 2025
cpsievert
reviewed
Nov 6, 2025
cpsievert
reviewed
Nov 6, 2025
Co-authored-by: Carson Sievert <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ports rstudio/bslib#1246 to Shiny for Python