Cordova plugin for theme detection
Donation
If you like this plugin feel free to by me a beer 🍻. So I can maintain this and other plugins and projects.
Description
This plugin detects whether the dark mode is enabled on the device or not.
iOS 13+ must be installed on your device, to use this plugin.
For Android you can use it since Android 9 (Pie). The Browser platform requires window.matchMedia()
support.
Installation
Add the plugin with the following command:
cordova plugin add cordova-plugin-theme-detection
Usage
cordovapluginsThemeDetection;
Ionic Native
If you are using Ionic, use the Ionic Native Wrapper. Install it with npm install @ionic-native/theme-detection
.
Import the plugin in your app.module:
And import and use it in every of your components:
;
Methods
isAvailable
cordova.plugins.ThemeDetection.isAvailable()
Checks whether the device is running on iOS 13 or Android 9 or newer and returns an object with a boolean value and a message.
isDarkModeEnabled
cordova.plugins.ThemeDetection.isDarkModeEnabled()
Checks whether the dark mode is enabled on device and returns an object with a boolean value and a message.
Responses
ThemeDetectionResponse:
ThemeDetectionResponse value: boolean; message: string;
Common issues
UIUserInterfaceStyle
If you have set the following Property in your config.xml
file, the plugin will always return false:
Light
Please remove this property from config.xml
.
Changelog
- 1.3.0: Add browser platform support
- 1.2.1: Updated README
- 1.2.0: Bugfix for Android 10
- 1.1.3: Updated from beta
- 1.1.2: Fix in documentation
- 1.1.1: Updated documentation for Android
- 1.1.0: Addded Android support
- 1.0.3: Update README.md for Ionic Native Wrapper support.
- 1.0.1: iOS Version Info if Plugin is not available.
- 1.0.0: Initial version support for iOS.