mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-01-31 18:49:43 +08:00
Removed themeable-browser - unmaintained
This commit is contained in:
Max Lynch
parent
206602f7b9
commit
96cf7a99f4
@ -1,257 +0,0 @@
|
|||||||
import { Injectable } from '@angular/core';
|
|
||||||
import { CordovaInstance, InstanceCheck, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
|
||||||
import { Observable } from 'rxjs';
|
|
||||||
|
|
||||||
declare const cordova: any;
|
|
||||||
|
|
||||||
export interface ThemeableBrowserButton {
|
|
||||||
wwwImage?: string;
|
|
||||||
image?: string;
|
|
||||||
wwwImagePressed?: string;
|
|
||||||
imagePressed?: string;
|
|
||||||
wwwImageDensity?: number;
|
|
||||||
align?: string;
|
|
||||||
event?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ThemeableBrowserOptions {
|
|
||||||
statusbar?: {
|
|
||||||
color: string;
|
|
||||||
};
|
|
||||||
toolbar?: {
|
|
||||||
height?: number;
|
|
||||||
color?: string;
|
|
||||||
image?: string;
|
|
||||||
};
|
|
||||||
title?: {
|
|
||||||
color?: string;
|
|
||||||
staticText?: string;
|
|
||||||
showPageTitle?: boolean;
|
|
||||||
};
|
|
||||||
backButton?: ThemeableBrowserButton;
|
|
||||||
forwardButton?: ThemeableBrowserButton;
|
|
||||||
closeButton?: ThemeableBrowserButton;
|
|
||||||
customButtons?: ThemeableBrowserButton[];
|
|
||||||
menu?: {
|
|
||||||
image?: string;
|
|
||||||
imagePressed?: string;
|
|
||||||
title?: string;
|
|
||||||
cancel?: string;
|
|
||||||
align?: string;
|
|
||||||
items?: {
|
|
||||||
event: string;
|
|
||||||
label: string;
|
|
||||||
}[];
|
|
||||||
};
|
|
||||||
backButtonCanClose?: boolean;
|
|
||||||
disableAnimation?: boolean;
|
|
||||||
|
|
||||||
// inAppBrowser options
|
|
||||||
location?: string;
|
|
||||||
hidden?: boolean;
|
|
||||||
clearcache?: boolean;
|
|
||||||
clearsessioncache?: boolean;
|
|
||||||
zoom?: string;
|
|
||||||
hardwareback?: string;
|
|
||||||
mediaPlaybackRequiresUserAction?: string;
|
|
||||||
shouldPauseOnSuspsend?: string;
|
|
||||||
closebuttoncaption?: string;
|
|
||||||
disallowoverscroll?: string;
|
|
||||||
enableViewportScale?: string;
|
|
||||||
allowInlineMediaPlayback?: string;
|
|
||||||
keyboardDisplayRequiresUserAction?: string;
|
|
||||||
suppressesIncrementalRendering?: string;
|
|
||||||
presentationstyle?: string;
|
|
||||||
transitionstyle?: string;
|
|
||||||
toolbarposition?: string;
|
|
||||||
fullscreen?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @hidden
|
|
||||||
*/
|
|
||||||
export class ThemeableBrowserObject {
|
|
||||||
private _objectInstance: any;
|
|
||||||
|
|
||||||
constructor(url: string, target: string, styleOptions: ThemeableBrowserOptions) {
|
|
||||||
try {
|
|
||||||
this._objectInstance = cordova.ThemeableBrowser.open(url, target, styleOptions);
|
|
||||||
} catch (e) {
|
|
||||||
if (typeof window !== 'undefined') {
|
|
||||||
window.open(url);
|
|
||||||
}
|
|
||||||
console.warn(
|
|
||||||
'Native: ThemeableBrowser is not installed or you are running on a browser. Falling back to window.open.'
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Displays an browser window that was opened hidden. Calling this has no effect
|
|
||||||
* if the browser was already visible.
|
|
||||||
*/
|
|
||||||
@CordovaInstance({ sync: true })
|
|
||||||
show(): void {}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Closes the browser window.
|
|
||||||
*/
|
|
||||||
@CordovaInstance({ sync: true })
|
|
||||||
close(): void {}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Reloads the current page
|
|
||||||
*/
|
|
||||||
@CordovaInstance({ sync: true })
|
|
||||||
reload(): void {}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Injects JavaScript code into the browser window.
|
|
||||||
* @param script Details of the script to run, specifying either a file or code key.
|
|
||||||
* @returns {Promise<any>}
|
|
||||||
*/
|
|
||||||
@CordovaInstance()
|
|
||||||
executeScript(script: { file?: string; code?: string }): Promise<any> {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Injects CSS into the browser window.
|
|
||||||
* @param css Details of the script to run, specifying either a file or code key.
|
|
||||||
* @returns {Promise<any>}
|
|
||||||
*/
|
|
||||||
@CordovaInstance()
|
|
||||||
insertCss(css: { file?: string; code?: string }): Promise<any> {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A method that allows you to listen to events happening in the browser.
|
|
||||||
* Available events are: `ThemeableBrowserError`, `ThemeableBrowserWarning`, `critical`, `loadfail`, `unexpected`, `undefined`
|
|
||||||
* @param event Event name
|
|
||||||
* @returns {Observable<any>} Returns back an observable that will listen to the event on subscribe, and will stop listening to the event on unsubscribe.
|
|
||||||
*/
|
|
||||||
@InstanceCheck({ observable: true })
|
|
||||||
on(event: string): Observable<any> {
|
|
||||||
return new Observable<any>(observer => {
|
|
||||||
this._objectInstance.addEventListener(event, observer.next.bind(observer));
|
|
||||||
return () => this._objectInstance.removeEventListener(event, observer.next.bind(observer));
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @name Themeable Browser
|
|
||||||
* @description
|
|
||||||
* In-app browser that allows styling.
|
|
||||||
*
|
|
||||||
* @usage
|
|
||||||
* ```typescript
|
|
||||||
* import { ThemeableBrowser, ThemeableBrowserOptions, ThemeableBrowserObject } from '@ionic-native/themeable-browser/ngx';
|
|
||||||
*
|
|
||||||
* constructor(private themeableBrowser: ThemeableBrowser) { }
|
|
||||||
*
|
|
||||||
* ...
|
|
||||||
*
|
|
||||||
* // can add options from the original InAppBrowser in a JavaScript object form (not string)
|
|
||||||
* // This options object also takes additional parameters introduced by the ThemeableBrowser plugin
|
|
||||||
* // This example only shows the additional parameters for ThemeableBrowser
|
|
||||||
* // Note that that `image` and `imagePressed` values refer to resources that are stored in your app
|
|
||||||
* const options: ThemeableBrowserOptions = {
|
|
||||||
* statusbar: {
|
|
||||||
* color: '#ffffffff'
|
|
||||||
* },
|
|
||||||
* toolbar: {
|
|
||||||
* height: 44,
|
|
||||||
* color: '#f0f0f0ff'
|
|
||||||
* },
|
|
||||||
* title: {
|
|
||||||
* color: '#003264ff',
|
|
||||||
* showPageTitle: true
|
|
||||||
* },
|
|
||||||
* backButton: {
|
|
||||||
* image: 'back',
|
|
||||||
* imagePressed: 'back_pressed',
|
|
||||||
* align: 'left',
|
|
||||||
* event: 'backPressed'
|
|
||||||
* },
|
|
||||||
* forwardButton: {
|
|
||||||
* image: 'forward',
|
|
||||||
* imagePressed: 'forward_pressed',
|
|
||||||
* align: 'left',
|
|
||||||
* event: 'forwardPressed'
|
|
||||||
* },
|
|
||||||
* closeButton: {
|
|
||||||
* image: 'close',
|
|
||||||
* imagePressed: 'close_pressed',
|
|
||||||
* align: 'left',
|
|
||||||
* event: 'closePressed'
|
|
||||||
* },
|
|
||||||
* customButtons: [
|
|
||||||
* {
|
|
||||||
* image: 'share',
|
|
||||||
* imagePressed: 'share_pressed',
|
|
||||||
* align: 'right',
|
|
||||||
* event: 'sharePressed'
|
|
||||||
* }
|
|
||||||
* ],
|
|
||||||
* menu: {
|
|
||||||
* image: 'menu',
|
|
||||||
* imagePressed: 'menu_pressed',
|
|
||||||
* title: 'Test',
|
|
||||||
* cancel: 'Cancel',
|
|
||||||
* align: 'right',
|
|
||||||
* items: [
|
|
||||||
* {
|
|
||||||
* event: 'helloPressed',
|
|
||||||
* label: 'Hello World!'
|
|
||||||
* },
|
|
||||||
* {
|
|
||||||
* event: 'testPressed',
|
|
||||||
* label: 'Test!'
|
|
||||||
* }
|
|
||||||
* ]
|
|
||||||
* },
|
|
||||||
* backButtonCanClose: true
|
|
||||||
* }
|
|
||||||
*
|
|
||||||
* const browser: ThemeableBrowserObject = this.themeableBrowser.create('https://ionic.io', '_blank', options);
|
|
||||||
*
|
|
||||||
* ```
|
|
||||||
* We suggest that you refer to the plugin's repository for additional information on usage that may not be covered here.
|
|
||||||
* @classes
|
|
||||||
* ThemeableBrowserObject
|
|
||||||
* @interfaces
|
|
||||||
* ThemeableBrowserButton
|
|
||||||
* ThemeableBrowserOptions
|
|
||||||
*/
|
|
||||||
@Plugin({
|
|
||||||
pluginName: 'ThemeableBrowser',
|
|
||||||
plugin: 'cordova-plugin-themeablebrowser',
|
|
||||||
pluginRef: 'cordova.ThemeableBrowser',
|
|
||||||
repo: 'https://github.com/initialxy/cordova-plugin-themeablebrowser',
|
|
||||||
platforms: [
|
|
||||||
'Amazon Fire OS',
|
|
||||||
'Android',
|
|
||||||
'Blackberry 10',
|
|
||||||
'Browser',
|
|
||||||
'FirefoxOS',
|
|
||||||
'iOS',
|
|
||||||
'Ubuntu',
|
|
||||||
'Windows',
|
|
||||||
'Windows Phone',
|
|
||||||
],
|
|
||||||
})
|
|
||||||
@Injectable()
|
|
||||||
export class ThemeableBrowser extends IonicNativePlugin {
|
|
||||||
/**
|
|
||||||
* Creates a browser instance
|
|
||||||
* @param url {string} URL to open
|
|
||||||
* @param target {string} Target
|
|
||||||
* @param styleOptions {ThemeableBrowserOptions} Themeable browser options
|
|
||||||
* @returns {ThemeableBrowserObject}
|
|
||||||
*/
|
|
||||||
create(url: string, target: string, styleOptions: ThemeableBrowserOptions): ThemeableBrowserObject {
|
|
||||||
return new ThemeableBrowserObject(url, target, styleOptions);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Loading…
Reference in New Issue
Block a user