-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(theme-detection): add plugin (#3082)
- Loading branch information
1 parent
2b684fa
commit e9fa3ee
Showing
1 changed file
with
72 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
import { Injectable } from '@angular/core'; | ||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core'; | ||
|
||
export interface ThemeDetectionResponse { | ||
// Boolean value about the status of the request | ||
value: boolean; | ||
|
||
// Message for readable usage | ||
message: string; | ||
} | ||
|
||
/** | ||
* @beta | ||
* @name Theme Detection | ||
* @description | ||
* Cordova plugin to detect whether dark mode is enabled or not | ||
* | ||
* @usage | ||
* ```typescript | ||
* import { ThemeDetection } from '@ionic-native/theme-detection'; | ||
* | ||
* | ||
* constructor(private themeDetection: ThemeDetection) { } | ||
* | ||
* ... | ||
* | ||
* this.themeDetection.isAvailable() | ||
* .then((res: ThemeDetectionResponse) => { | ||
* if(res.value) { | ||
* this.themeDetection.isDarkModeEnabled().then((res: ThemeDetectionResponse) => { | ||
* console.log(res); | ||
* }) | ||
* .catch((error: any) => console.error(error)); | ||
* } | ||
* }) | ||
* .catch((error: any) => console.error(error)); | ||
* | ||
* ``` | ||
*/ | ||
@Plugin({ | ||
pluginName: 'ThemeDetection', | ||
plugin: 'cordova-plugin-theme-detection', | ||
pluginRef: 'cordova.plugins.ThemeDetection', | ||
repo: 'https://github.com/mariusbackes/cordova-plugin-theme-detection', | ||
install: 'cordova plugin add cordova-plugin-theme-detection', | ||
installVariables: [], | ||
platforms: ['iOS'] | ||
}) | ||
@Injectable() | ||
export class ThemeDetection extends IonicNativePlugin { | ||
|
||
/** | ||
* | ||
* @return {Promise<ThemeDetectionResponse>} | ||
* Returns a promise with an object that has a boolean property which gives information if the detection is available or not | ||
*/ | ||
@Cordova() | ||
isAvailable(): Promise<ThemeDetectionResponse> { | ||
return; | ||
} | ||
|
||
/** | ||
* | ||
* @return {Promise<ThemeDetectionResponse>} | ||
* Returns a promise with an object that has a boolean property which gives information if dark mode is enabled or not | ||
*/ | ||
@Cordova() | ||
isDarkModeEnabled(): Promise<ThemeDetectionResponse> { | ||
return; | ||
} | ||
|
||
} |