electron/docs/api
trop[bot] 592d0155f1
feat: expose nativeTheme.shouldUseDarkColorsForSystemIntegratedUI (#46599)
feat: expose shouldUseDarkColorsForSystemIntegratedUI

Closes https://github.com/electron/electron/issues/46429.
Refs https://github.com/electron/electron/pull/19735.

This PR adds a new API `shouldUseDarkColorsForSystemIntegratedUI` to the
`nativeTheme` module. This API returns a boolean indicating whether the
system is using dark colors for system integrated UI elements. This is
useful for applications that want to adapt their UI to match the system
theme, especially for those that use system integrated UI elements like
the shell theme or taskbar appearance.

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>
2025-04-16 19:40:51 +02:00
..
structures docs: note that titleBarOverlay.symbolColor is supported on Linux (#46535) 2025-04-07 14:11:47 +02:00
accelerator.md docs: note accelerator case insensitivity (#40783) 2024-01-04 10:06:12 -05:00
app.md docs: fix types of app.dock (#46102) 2025-03-18 13:24:40 +01:00
auto-updater.md docs: fix wording in auto-updater.md (#44787) 2024-11-24 13:00:42 -08:00
base-window.md feat: add query-session-end and improve session-end events on Windows (#44598) 2024-11-22 11:47:36 -08:00
browser-view.md docs: api history (#42982) 2024-08-19 11:17:10 -07:00
browser-window.md feat: add query-session-end and improve session-end events on Windows (#44598) 2024-11-22 11:47:36 -08:00
client-request.md build: update some build dependencies (#43882) 2024-09-26 00:12:11 -07:00
clipboard.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
command-line-switches.md fix: support for v8.setHeapSnapshotNearHeapLimit api (#45632) 2025-02-17 13:23:38 +09:00
command-line.md fix: hard crash on invalid command line switches (#46631) 2025-04-14 23:46:24 -05:00
content-tracing.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
context-bridge.md feat: contextBridge.executeInMainWorld (#45330) 2025-01-31 09:50:44 -05:00
cookies.md refactor: revert url::DomainIs() for cookie domains (#44153) 2024-10-08 18:39:37 -07:00
crash-reporter.md docs: backslash escape parametrized TypeScript types (#41575) 2024-03-25 11:19:44 +01:00
debugger.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
desktop-capturer.md feat: add support for system picker in setDisplayMediaRequestHandler (#43581) 2024-09-10 16:05:57 -07:00
dialog.md docs: update security scoped bookmarks info (#44968) 2024-12-09 10:44:43 -08:00
dock.md docs: use optional chaining for app.dock (#46139) 2025-03-19 18:50:05 -05:00
download-item.md feat: add getPercentComplete / getCurrentBytesPerSecond / getEndTime to DownloadItem (#42805) 2024-07-15 19:32:44 -04:00
environment-variables.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
extensions.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
global-shortcut.md feat: support global shortcuts via GlobalShortcutsPortal feature with ozone/wayland (#45297) 2025-02-27 11:33:12 +01:00
in-app-purchase.md docs: transactions-updated event type (#45542) 2025-02-10 10:22:21 -05:00
incoming-message.md build: update some build dependencies (#43882) 2024-09-26 00:12:11 -07:00
ipc-main-service-worker.md feat: service worker preload scripts for improved extensions support … (#45408) 2025-02-05 14:18:24 -05:00
ipc-main.md docs: Make ipcRenderer and ipcMain listener API docs consistent (#44651) 2024-11-18 14:44:30 -08:00
ipc-renderer.md docs: reference security guide in ipcRenderer.on docs (#45371) 2025-01-29 15:44:07 -05:00
menu-item.md fix: menu should allow focused BaseWindow where possible (#43404) 2024-08-22 14:13:30 -04:00
menu.md fix: context-menu event with BaseWindows (#44940) 2024-12-04 13:35:28 -08:00
message-channel-main.md chore: type check JS in docs (#38423) 2023-06-05 16:26:26 +09:00
message-port-main.md docs: fix broken links (#36519) 2022-12-05 13:18:57 -05:00
native-image.md docs: api history (#42982) 2024-08-19 11:17:10 -07:00
native-theme.md feat: expose nativeTheme.shouldUseDarkColorsForSystemIntegratedUI (#46599) 2025-04-16 19:40:51 +02:00
navigation-history.md docs: clarify navigationhistory offsets (#45766) 2025-02-21 18:13:38 -06:00
net-log.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
net.md docs - Update net.md (#42691) 2024-07-01 14:45:49 -04:00
notification.md docs: clarify icon value in Notification (#43377) 2024-08-21 19:38:06 -05:00
parent-port.md docs: fix broken links (#36519) 2022-12-05 13:18:57 -05:00
power-monitor.md docs: fix powerMonitor event types (#45543) 2025-02-10 10:21:56 -05:00
power-save-blocker.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
process.md feat: service worker preload scripts for improved extensions support … (#45408) 2025-02-05 14:18:24 -05:00
protocol.md docs: api history (#42982) 2024-08-19 11:17:10 -07:00
push-notifications.md fix: APNS token ids are lowercase ASCII (#46148) 2025-03-20 19:31:20 -05:00
safe-storage.md docs: clarify security semantics of safeStorage (#42666) 2024-06-26 13:24:06 -07:00
screen.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
service-worker-main.md feat: service worker preload scripts for improved extensions support … (#45408) 2025-02-05 14:18:24 -05:00
service-workers.md feat: service worker preload scripts for improved extensions support … (#45408) 2025-02-05 14:18:24 -05:00
session.md feat: route deprecated sync clipboard read through permission checks (#45471) 2025-02-05 14:10:43 -05:00
share-menu.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
shell.md docs: capitalize POSIX and Windows correctly (#44546) 2024-11-04 13:12:23 -08:00
system-preferences.md chore: deprecate systemPreferences.isAeroGlassEnabled() (#45554) 2025-02-18 16:29:41 -05:00
touch-bar-button.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-color-picker.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-group.md fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
touch-bar-label.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-other-items-proxy.md fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
touch-bar-popover.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-scrubber.md fix: documentation spelling errors (#43366) 2024-08-22 15:44:55 +02:00
touch-bar-segmented-control.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-slider.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-spacer.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
tray.md docs: nativeImage api cleanup (#41519) 2024-03-12 12:33:56 -04:00
utility-process.md fix: UtilityProcess.fork crash before app ready (#46403) 2025-04-01 14:09:16 -04:00
view.md feat: view.getVisible() (#45409) 2025-02-05 15:50:00 -05:00
web-contents-view.md feat: Allow WebContentsView to accept webContents object. (#42086) 2024-05-30 12:45:35 -07:00
web-contents.md docs: webContents.opener can be null (#46579) 2025-04-15 12:56:03 +02:00
web-frame-main.md feat: WebFrameMain.collectJavaScriptCallStack() (#44204) 2024-12-03 13:32:24 +09:00
web-frame.md docs: fix apostrophe typo "Electrons" -> "Electron's" (#44516) 2024-11-02 15:52:22 -05:00
web-request.md feat: add excludeUrls and modify urls in WebRequestFilter for better URL filtering (#45678) 2025-02-20 15:54:58 -05:00
web-utils.md fix: documentation spelling errors (#43366) 2024-08-22 15:44:55 +02:00
webview-tag.md fix: fixed the type of WebviewTag.webpreferences (#42275) 2024-05-25 22:06:06 -07:00
window-open.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00