github/apache-cordova-plugin-inappbrowser
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CB-8438 cordova-plugin-inappbrowser documentation translation: cordova-plugin-inappbrowser

Browse Source
This commit is contained in:
Victor Sosa
2015-02-27 12:51:38 -06:00
parent fb8574abde
commit 4a4164c6f6
8 changed files with 410 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/zh/index.md
+65 -38
View File
@@ -19,45 +19,72 @@
# org.apache.cordova.inappbrowser
這個外掛程式提供了一個 web 瀏覽器視圖，顯示在調用時`window.open()`.
這個外掛程式提供了一個 web 瀏覽器視圖，顯示在調用 `cordova.InAppBrowser.open()`.
var ref = window.open('http://apache.org', '_blank', 'location=yes');
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
**注**： InAppBrowser 視窗的行為像一個標準的 web 瀏覽器，並且無法訪問科爾多瓦的 Api。
`cordova.InAppBrowser.open()` 函數被定義為一個臨時替代 `window.open ()` 函數。 現有 `window.open ()` 調用，可以通過替換 window.open 使用 InAppBrowser 視窗：
window.open = cordova.InAppBrowser.open;
InAppBrowser 視窗像一個標準的 web 瀏覽器中，並且無法訪問科爾多瓦 Api。 為此，建議 InAppBrowser 如果您需要載入協力廠商 （不可信） 的內容，而不是載入，進入主要的科爾多瓦 web 視圖。 InAppBrowser 是不受白名單中，也不在系統瀏覽器中打開的連結。
InAppBrowser 預設情況下它自己的 GUI 控制項為使用者提供 （後退、 前進、 完成）。
為向後相容性，此外掛程式還鉤 `window.open`。 然而，`window.open` 外掛程式安裝鉤子可以有副作用 （尤其是如果這個外掛程式是只列為另一個外掛程式的依賴項）。 在未來的主要發行版本中，將刪除 `window.open` 鉤。 一直至從該外掛程式鉤子後，應用程式可以手動還原預設行為：
delete window.open // Reverts the call back to it's prototype's default
雖然 `window.open` 在全球範圍內，InAppBrowser 不可用直到 `deviceready` 事件之後。
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
console.log("window.open works well");
}
## 安裝
cordova plugin add org.apache.cordova.inappbrowser
## window.open
如果您希望所有頁面載入中您的應用程式要通過 InAppBrowser，你可以簡單地在初始化過程中鉤 `window.open`。舉個例子：
在一個新打開一個 URL `InAppBrowser` 實例，當前的瀏覽器實例或系統瀏覽器。
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
window.open = cordova.InAppBrowser.open;
}
var ref = window.open(url, target, options);
## cordova.InAppBrowser.open
在新的 `InAppBrowser` 實例，當前的瀏覽器實例或系統瀏覽器中打開的 URL。
var ref = cordova.InAppBrowser.open(url, target, options);
* **ref**： 參考 `InAppBrowser` 視窗。*() InAppBrowser*
* **url**： 要載入*（字串）*的 URL。調用 `encodeURI()` 這個如果 URL 包含 Unicode 字元。
* **目標**： 目標在其中載入的 URL，可選參數，預設值為 `_self` 。*（字串）*
* **target**： 目標在其中載入的 URL，可選參數，預設值為 `_self` 。*（字串）*
* `_self`： 打開在科爾多瓦 web 視圖如果 URL 是在白名單中，否則它在打開`InAppBrowser`.
* `_blank`： 在打開`InAppBrowser`.
* `_system`： 在該系統的 web 瀏覽器中打開。
* **選項**： 選項為 `InAppBrowser` 。可選，拖欠到： `location=yes` 。*（字串）*
* **options**： 選項為 `InAppBrowser` 。可選，拖欠到： `location=yes` 。*（字串）*
`options`字串必須不包含任何空白的空間，和必須用逗號分隔每個功能的名稱/值對。 功能名稱區分大小寫。 所有平臺都支援下面的值：
* **位置**： 設置為 `yes` 或 `no` ，打開 `InAppBrowser` 的位置欄打開或關閉。
* **location**： 設置為 `yes` 或 `no` ，打開 `InAppBrowser` 的位置欄打開或關閉。
Android 系統只有：
* **closebuttoncaption**: 設置為一個字串，以用作**做**按鈕的標題。
* **隱藏**： 將設置為 `yes` ，創建瀏覽器和載入頁面，但不是顯示它。 載入完成時，將觸發 loadstop 事件。 省略或設置為 `no` （預設值），有的瀏覽器打開，然後以正常方式載入。
* **hidden**： 將設置為 `yes` ，創建瀏覽器和載入頁面，但不是顯示它。 載入完成時，將觸發 loadstop 事件。 省略或設置為 `no` （預設值），有的瀏覽器打開，然後以正常方式載入。
* **clearcache**： 將設置為 `yes` 有瀏覽器的 cookie 清除緩存之前打開新視窗
* **clearsessioncache**： 將設置為 `yes` 有會話 cookie 緩存清除之前打開新視窗
@@ -65,10 +92,10 @@
* **closebuttoncaption**: 設置為一個字串，以用作**做**按鈕的標題。請注意您需要對此值進行當地語系化你自己。
* **disallowoverscroll**： 將設置為 `yes` 或 `no` （預設值是 `no` ）。打開/關閉的 UIWebViewBounce 屬性。
* **隱藏**： 將設置為 `yes` ，創建瀏覽器和載入頁面，但不是顯示它。 載入完成時，將觸發 loadstop 事件。 省略或設置為 `no` （預設值），有的瀏覽器打開，然後以正常方式載入。
* **hidden**： 將設置為 `yes` ，創建瀏覽器和載入頁面，但不是顯示它。 載入完成時，將觸發 loadstop 事件。 省略或設置為 `no` （預設值），有的瀏覽器打開，然後以正常方式載入。
* **clearcache**： 將設置為 `yes` 有瀏覽器的 cookie 清除緩存之前打開新視窗
* **clearsessioncache**： 將設置為 `yes` 有會話 cookie 緩存清除之前打開新視窗
* **工具列**： 設置為 `yes` 或 `no` ，為 InAppBrowser （預設為打開或關閉工具列`yes`)
* **toolbar**： 設置為 `yes` 或 `no` ，為 InAppBrowser （預設為打開或關閉工具列`yes`)
* **enableViewportScale**： 將設置為 `yes` 或 `no` ，防止通過 meta 標記 （預設為縮放的視區`no`).
* **mediaPlaybackRequiresUserAction**： 將設置為 `yes` 或 `no` ，防止 HTML5 音訊或視頻從 autoplaying （預設為`no`).
* **allowInlineMediaPlayback**： 將設置為 `yes` 或 `no` ，讓線在 HTML5 播放媒體，在瀏覽器視窗中，而不是特定于設備播放介面內顯示。 HTML 的 `video` 元素還必須包括 `webkit-playsinline` 屬性 （預設為`no`)
@@ -80,7 +107,7 @@
僅限 Windows：
* **隱藏**： 將設置為 `yes` ，創建瀏覽器並載入頁面，但不是顯示它。 載入完成時，將觸發 loadstop 事件。 省略或被設置為 `no` （預設值），有的瀏覽器打開，以正常方式載入。
* **hidden**： 將設置為 `yes` ，創建瀏覽器並載入頁面，但不是顯示它。 載入完成時，將觸發 loadstop 事件。 省略或被設置為 `no` （預設值），有的瀏覽器打開，以正常方式載入。
[1]: http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle
[2]: http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle
@@ -97,13 +124,13 @@
### 示例
var ref = window.open('http://apache.org', '_blank', 'location=yes');
var ref2 = window.open(encodeURI('http://ja.m.wikipedia.org/wiki/ハングル'), '_blank', 'location=yes');
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
var ref2 = cordova.InAppBrowser.open(encodeURI('http://ja.m.wikipedia.org/wiki/ハングル'), '_blank', 'location=yes');
### 火狐瀏覽器作業系統的怪癖
外掛程式不會執行任何的設計是需要添加一些 CSS 規則，如果打開的 `target='_blank'` 。規則 》 可能看起來像這些
外掛程式不會強制任何設計是需要添加一些 CSS 規則，如果打開與 `target=_blank`。規則 》 可能看起來像這些
css
.inAppBrowserWrap {
@@ -133,7 +160,7 @@
## InAppBrowser
從調用返回的物件`window.open`.
對 `科爾多瓦的調用返回的物件。InAppBrowser.open`.
### 方法
@@ -153,24 +180,24 @@
* **ref**： 參考 `InAppBrowser` 視窗*(InAppBrowser)*
* **事件名稱**： 事件偵聽*（字串）*
* **eventname**： 事件偵聽*（字串）*
* **loadstart**： 當觸發事件 `InAppBrowser` 開始載入一個 URL。
* **loadstop**： 當觸發事件 `InAppBrowser` 完成載入一個 URL。
* **loaderror**： 當觸發事件 `InAppBrowser` 載入 URL 時遇到錯誤。
* **退出**： 當觸發事件 `InAppBrowser` 關閉視窗。
* **exit**： 當觸發事件 `InAppBrowser` 關閉視窗。
* **回檔**： 執行時觸發該事件的函數。該函數通過 `InAppBrowserEvent` 物件作為參數。
* **callback**： 執行時觸發該事件的函數。該函數通過 `InAppBrowserEvent` 物件作為參數。
### InAppBrowserEvent 屬性
* **類型**： eventname，或者 `loadstart` ， `loadstop` ， `loaderror` ，或 `exit` 。*（字串）*
* **type**： eventname，或者 `loadstart` ， `loadstop` ， `loaderror` ，或 `exit` 。*（字串）*
* **url**: 已載入的 URL。*（字串）*
* **代碼**： 僅中的情況的錯誤代碼 `loaderror` 。*（人數）*
* **code**： 僅中的情況的錯誤代碼 `loaderror` 。*（人數）*
* **消息**： 該錯誤訊息，只有在的情況下 `loaderror` 。*（字串）*
* **message**： 該錯誤訊息，只有在的情況下 `loaderror` 。*（字串）*
### 支援的平臺
@@ -182,7 +209,7 @@
### 快速的示例
var ref = window.open('http://apache.org', '_blank', 'location=yes');
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
ref.addEventListener('loadstart', function(event) { alert(event.url); });
@@ -195,14 +222,14 @@
* **ref**： 參考 `InAppBrowser` 視窗。*() InAppBrowser*
* **事件名稱**： 要停止偵聽的事件。*（字串）*
* **eventname**： 要停止偵聽的事件。*（字串）*
* **loadstart**： 當觸發事件 `InAppBrowser` 開始載入一個 URL。
* **loadstop**： 當觸發事件 `InAppBrowser` 完成載入一個 URL。
* **loaderror**： 當觸發事件 `InAppBrowser` 遇到錯誤載入一個 URL。
* **退出**： 當觸發事件 `InAppBrowser` 關閉視窗。
* **exit**： 當觸發事件 `InAppBrowser` 關閉視窗。
* **回檔**: 要在事件觸發時執行的函數。該函數通過 `InAppBrowserEvent` 物件。
* **callback**: 要在事件觸發時執行的函數。該函數通過 `InAppBrowserEvent` 物件。
### 支援的平臺
@@ -214,7 +241,7 @@
### 快速的示例
var ref = window.open('http://apache.org', '_blank', 'location=yes');
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
var myCallback = function(event) { alert(event.url); }
ref.addEventListener('loadstart', myCallback);
ref.removeEventListener('loadstart', myCallback);
@@ -224,7 +251,7 @@
> 關閉 `InAppBrowser` 視窗。
ref.close() ；
ref.close();
* **ref**： 參考 `InAppBrowser` 視窗*(InAppBrowser)*
@@ -240,7 +267,7 @@
### 快速的示例
var ref = window.open('http://apache.org', '_blank', 'location=yes');
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
ref.close();
@@ -248,7 +275,7 @@
> 顯示打開了隱藏的 InAppBrowser 視窗。調用這沒有任何影響，如果 InAppBrowser 是已經可見。
ref.show() ；
ref.show();
* **ref**： InAppBrowser 視窗 (參考`InAppBrowser`)
@@ -262,7 +289,7 @@
### 快速的示例
var ref = window.open('http://apache.org', '_blank', 'hidden=yes');
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'hidden=yes');
// some time later...
ref.show();
@@ -294,7 +321,7 @@
### 快速的示例
var ref = window.open('http://apache.org', '_blank', 'location=yes');
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
ref.addEventListener('loadstop', function() {
ref.executeScript({file: "myscript.js"});
});
@@ -311,10 +338,10 @@
* **injectDetails**: 要運行的腳本的詳細資訊或指定 `file` 或 `code` 的關鍵。*（物件）*
* **檔**： 樣式表的 URL 來注入。
* **代碼**： 文本樣式表的注入。
* **file**： 樣式表的 URL 來注入。
* **code**： 文本樣式表的注入。
* **回檔**： 在 CSS 注射後執行的函數。
* **callback**： 在 CSS 注射後執行的函數。
### 支援的平臺
@@ -324,7 +351,7 @@
### 快速的示例
var ref = window.open('http://apache.org', '_blank', 'location=yes');
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
ref.addEventListener('loadstop', function() {
ref.insertCSS({file: "mystyles.css"});
});