Added a dark mode property on App. #2992
Conversation
rtpg
force-pushed
the
dark-mode
branch
5 times, most recently
from
fefbee8
to
793bcd6
Compare
There was a problem hiding this comment.
The implementation looks great, and the testbed test is great (just needs to be moved to a different location).
The only piece that looks to be missing has been picked up by CI - there's a test coverage failure because there's no core test for this API. That means implementing the "dark mode" API for the dummy backend, and adding a unit test to the core test suite to exercise the core part of the API.
android/src/toga_android/app.py
Outdated
| def get_dark_mode_state(self): | ||
| raise NotImplementedError() |
There was a problem hiding this comment.
It would be more consistent to use self.factory.not_implemented("dark mode state"), and return None directly (and similar for the other not-implemented backends)
changes/2841.feature.txt
Outdated
| @@ -0,0 +1 @@ | |||
| ``toga.App`` now has a ``dark_mode`` read-only property, to read the user's OS-level dark mode preferences. Support is currently limited to Cocoa, anod other backends will use ``None`` to indicate that the dark mode preference cannot be detected. | |||
There was a problem hiding this comment.
We don't need to fully document the feature in the changenote; we're just advertising that it exists. The API docs become the "full" documentation.
| ``toga.App`` now has a ``dark_mode`` read-only property, to read the user's OS-level dark mode preferences. Support is currently limited to Cocoa, anod other backends will use ``None`` to indicate that the dark mode preference cannot be detected. | |
| Apps can now interrogate whether they are in dark mode on some platforms. |
core/src/toga/app.py
Outdated
| try: | ||
| return self._impl.get_dark_mode_state() | ||
| except NotImplementedError: | ||
| return None |
There was a problem hiding this comment.
If the underlying dark mode implementations use factory.not_implemented(), this can be simplified to a direct self._impl.get_dark_mode_state()
core/src/toga/app.py
Outdated
| def dark_mode(self) -> bool | None: | ||
| """Whether the user has dark mode enabled in their environment (read-only). | ||
|
|
||
| Returns None if we cannot determine dark mode settings.""" |
There was a problem hiding this comment.
We can use specific markup for the return value.
| Returns None if we cannot determine dark mode settings.""" | |
| :returns: A boolean describing if the app is in dark mode; ``None`` if Toga | |
| cannot determine if the app is in dark mode. | |
| """ |
testbed/tests/test_styling.py
Outdated
| from types import NoneType | ||
|
|
||
|
|
||
| async def test_dark_mode_state_read(app): |
There was a problem hiding this comment.
This should be part of test_app.py, not a standalone test file for a single property.
| ###################################################################### | ||
|
|
||
| def get_dark_mode_state(self): | ||
| return None |
There was a problem hiding this comment.
Textual has the ability to differentiate between light and dark themes, so this should probably be handled the same as other platforms.
Fixes #2841
This only adds support for Cocoa as that was the only platform I could get working today, but there are now entrypooints for others to add support directly.
PR Checklist: