Onsen UIで利用できるグローバルなオブジェクトです。
| シグネチャ | 概要 |
|---|---|
| isReady() | Onsen UIがすでに初期化されているかどうかを返すメソッドです。 |
| isWebView() | Cordovaで実行されているかどうかを返すメソッドです。 |
| ready(callback) | アプリの初期化に利用するメソッドです。渡された関数は、Onsen UIの初期化が終了している時点で必ず呼ばれます。 |
| setDefaultDeviceBackButtonListener(listener) | デバイスのバックボタンのためのデフォルトのハンドラを設定します。 |
| disableDeviceBackButtonHandler() | デバイスのバックボタンのイベントを受け付けないようにします。 |
| enableDeviceBackButtonHandler() | デバイスのバックボタンのイベントを受け付けるようにします。 |
| enableAutoStatusBarFill() | iOS7以上（iPhone Xは除く）で、ステータスバー部分の高さを自動的に埋める処理を有効にします。 |
| disableAutoStatusBarFill() | iOS7以上（iPhone Xは除く）で、ステータスバー部分の高さを自動的に埋める処理を無効にします。 |
| mockStatusBar() |
Creates a static element similar to iOS status bar. Only useful for browser testing. Must be called before ons.ready.
（翻訳中）
|
| disableAnimations() | アニメーションを全て無効にします。テストの際に便利です。 |
| enableAnimations() | アニメーションを有効にします。 |
| disableAutoStyling() | Disable automatic styling. （翻訳中） |
| enableAutoStyling() | Enable automatic styling based on OS (default). （翻訳中） |
| disableIconAutoPrefix() |
Disable adding fa- prefix automatically to ons-icon classes. Useful when including custom icon packs.
（翻訳中）
|
| forcePlatformStyling(platform) |
Refresh styling for the given platform. Only useful for demos. Use ons.platform.select(...) instead for development and production.
（翻訳中）
|
| preload(templatePaths) | Separated files need to be requested on demand and this can slightly delay pushing new pages. This method requests and caches templates for later use. （翻訳中） |
| createElement(template, options) | Create a new element from a template. Both inline HTML and external files are supported although the return value differs. （翻訳中） |
| createPopover(page, [options]) | テンプレートからポップオーバーのインスタンスを生成します。 |
| createDialog(page, [options]) | テンプレートからダイアログのインスタンスを生成します。 |
| createAlertDialog(page, [options]) | テンプレートからアラートダイアログのインスタンスを生成します。 |
| openActionSheet(options) | Shows an instant Action Sheet and lets the user choose an action. （翻訳中） |
| resolveLoadingPlaceholder(page) | ons-loading-placeholderの属性値としてページが指定されていない場合は、ページロード前に呼ばれるons.resolveLoadingPlaceholder処理が行われるまで表示されません。 |
| getScriptPage() |
Access the last created page from the current script scope. Only works inside <script></script> tags that are direct children of ons-page element. Use this to add lifecycle hooks to a page.
（翻訳中）
|
| bootstrap([moduleName, [dependencies]]) | Onsen UIの初期化を行います。Angular.jsのng-app属性を利用すること無しにOnsen UIを読み込んで初期化してくれます。 |
| findParentComponentUntil(name, [dom]) | 指定されたdom引数の親要素をたどってコンポーネントを検索します。 |
| findComponent(selector, [dom]) | CSSセレクタを使ってコンポーネントのオブジェクトを検索します。 |
| compile(dom) | 通常のHTMLの要素をOnsen UIのコンポーネントにコンパイルします。 |
| createElement(template, [options]) |
Create a new element from a template. Both inline HTML and external files are supported although the return value differs. If the element is appended it will also be compiled by AngularJS (otherwise, ons.compile should be manually used).
（翻訳中）
|
| createAlertDialog(page, [options]) | テンプレートからアラートダイアログのインスタンスを生成します。 |
| createDialog(page, [options]) | テンプレートからダイアログのインスタンスを生成します。 |
| createPopover(page, [options]) | テンプレートからポップオーバーのインスタンスを生成します。 |
Onsen UIがすでに初期化されているかどうかを返すメソッドです。
返り値: 初期化されているかどうかを返します。
Cordovaで実行されているかどうかを返すメソッドです。
返り値: Cordovaで実行されている場合にtrueになります。
アプリの初期化に利用するメソッドです。渡された関数は、Onsen UIの初期化が終了している時点で必ず呼ばれます。
| 名前 | 型 | 概要 |
|---|---|---|
| callback | Function | Onsen UIが初期化が完了した後に呼び出される関数オブジェクトを指定します。 |
デバイスのバックボタンのためのデフォルトのハンドラを設定します。
| 名前 | 型 | 概要 |
|---|---|---|
| listener | Function | デバイスのバックボタンが押された時に実行される関数オブジェクトを指定します。 |
デバイスのバックボタンのイベントを受け付けないようにします。
デバイスのバックボタンのイベントを受け付けるようにします。
iOS7以上（iPhone Xは除く）で、ステータスバー部分の高さを自動的に埋める処理を有効にします。
iOS7以上（iPhone Xは除く）で、ステータスバー部分の高さを自動的に埋める処理を無効にします。
Creates a static element similar to iOS status bar. Only useful for browser testing. Must be called before ons.ready.
（翻訳中）
アニメーションを全て無効にします。テストの際に便利です。
アニメーションを有効にします。
Disable automatic styling. （翻訳中）
Enable automatic styling based on OS (default). （翻訳中）
Disable adding fa- prefix automatically to ons-icon classes. Useful when including custom icon packs.
（翻訳中）
Refresh styling for the given platform. Only useful for demos. Use ons.platform.select(...) instead for development and production.
（翻訳中）
| 名前 | 型 | 概要 |
|---|---|---|
| platform | string | New platform to style the elements. |
Separated files need to be requested on demand and this can slightly delay pushing new pages. This method requests and caches templates for later use. （翻訳中）
返り値:
| 名前 | 型 | 概要 |
|---|---|---|
| templatePaths | String|Array | Set of HTML file paths containing ‘ons-page’ elements. （翻訳中） |
Create a new element from a template. Both inline HTML and external files are supported although the return value differs. （翻訳中）
返り値:
| 名前 | 型 | 概要 |
|---|---|---|
| template | String |
Either an HTML file path, a <template> id or an HTML string such as '<div id="foo">hoge</div>'.
（翻訳中）
|
| options | Object | オプションを指定するオブジェクト。 |
| options.append | Boolean|HTMLElement |
Whether or not the element should be automatically appended to the DOM. Defaults to false. If true value is given, document.body will be used as the target.
（翻訳中）
|
| options.insertBefore | HTMLElement |
Reference node that becomes the next sibling of the new node (options.append element).
（翻訳中）
|
テンプレートからポップオーバーのインスタンスを生成します。
返り値: ポップオーバーのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。
| 名前 | 型 | 概要 |
|---|---|---|
| page | String |
pageのURLか、もしくは<template>で宣言したテンプレートのid属性の値を指定できます。
|
| options | Object | オプションを指定するオブジェクト。 |
| options.parentScope | Object | ダイアログ内で利用する親スコープを指定します。ダイアログからモデルやスコープのメソッドにアクセスするのに使います。このパラメータはAngularJSバインディングでのみ利用できます。 |
テンプレートからダイアログのインスタンスを生成します。
返り値: ダイアログのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。
| 名前 | 型 | 概要 |
|---|---|---|
| page | String |
pageのURLか、もしくは<template>で宣言したテンプレートのid属性の値を指定できます。
|
| options | Object | オプションを指定するオブジェクト。 |
テンプレートからアラートダイアログのインスタンスを生成します。
返り値: ダイアログのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。
| 名前 | 型 | 概要 |
|---|---|---|
| page | String |
pageのURLか、もしくは<template>で宣言したテンプレートのid属性の値を指定できます。
|
| options | Object | オプションを指定するオブジェクト。 |
Shows an instant Action Sheet and lets the user choose an action. （翻訳中）
返り値:
| 名前 | 型 | 概要 |
|---|---|---|
| options | Object | オプションを指定するオブジェクト。 |
| options.buttons | Array |
Represent each button of the action sheet following the specified order. Every item can be either a string label or an object containing label, icon and modifier properties.
（翻訳中）
|
| options.title | String | Optional title for the action sheet. （翻訳中） |
| options.destructive | Number | Optional index of the “destructive” button (only for iOS). It can be specified in the button array as well. （翻訳中） |
| options.cancelable | Boolean | Whether the action sheet can be canceled by tapping on the background mask or not. （翻訳中） |
| options.modifier | String |
Modifier attribute of the action sheet. E.g. 'destructive'.
（翻訳中）
|
| options.maskColor | String | Optionally change the background mask color. （翻訳中） |
| options.id | String | The element’s id attribute. （翻訳中） |
| options.class | String | The element’s class attribute. （翻訳中） |
ons-loading-placeholderの属性値としてページが指定されていない場合は、ページロード前に呼ばれるons.resolveLoadingPlaceholder処理が行われるまで表示されません。
| 名前 | 型 | 概要 |
|---|---|---|
| page | String |
pageのURLか、もしくは<template>で宣言したテンプレートのid属性の値を指定できます。
|
Access the last created page from the current script scope. Only works inside <script></script> tags that are direct children of ons-page element. Use this to add lifecycle hooks to a page.
（翻訳中）
返り値:
Onsen UIの初期化を行います。Angular.jsのng-app属性を利用すること無しにOnsen UIを読み込んで初期化してくれます。
返り値: AngularJSのModuleオブジェクトを表します。
| 名前 | 型 | 概要 |
|---|---|---|
| moduleName | String | Angular.jsでのモジュール名 |
| dependencies | Array | 依存するAngular.jsのモジュール名の配列 |
指定されたdom引数の親要素をたどってコンポーネントを検索します。
返り値: コンポーネントのオブジェクトを返します。もしコンポーネントが見つからなかった場合にはnullを返します。
| 名前 | 型 | 概要 |
|---|---|---|
| name | String | コンポーネント名を指定します。例えばons-pageなどを指定します。 |
| dom | Object/jqLite/HTMLElement | $eventオブジェクト、jqLiteオブジェクト、HTMLElementオブジェクトのいずれかを指定できます。 |
CSSセレクタを使ってコンポーネントのオブジェクトを検索します。
返り値: コンポーネントのオブジェクトを返します。もしコンポーネントが見つからなかった場合にはnullを返します。
| 名前 | 型 | 概要 |
|---|---|---|
| selector | String | CSSセレクターを指定します。 |
| dom | HTMLElement | 検索対象とするDOM要素を指定します。 |
通常のHTMLの要素をOnsen UIのコンポーネントにコンパイルします。
| 名前 | 型 | 概要 |
|---|---|---|
| dom | HTMLElement | コンパイルする要素を指定します。 |
Create a new element from a template. Both inline HTML and external files are supported although the return value differs. If the element is appended it will also be compiled by AngularJS (otherwise, ons.compile should be manually used).
（翻訳中）
返り値:
| 名前 | 型 | 概要 |
|---|---|---|
| template | String |
Either an HTML file path, an <ons-template> id or an HTML string such as '<div id="foo">hoge</div>'.
（翻訳中）
|
| options | Object | オプションを指定するオブジェクト。 |
| options.append | Boolean|HTMLElement |
Whether or not the element should be automatically appended to the DOM. Defaults to false. If true value is given, document.body will be used as the target.
（翻訳中）
|
| options.insertBefore | HTMLElement |
Reference node that becomes the next sibling of the new node (options.append element).
（翻訳中）
|
| options.parentScope | Object | Parent scope of the element. Used to bind models and access scope methods from the element. Requires append option. （翻訳中） |
テンプレートからアラートダイアログのインスタンスを生成します。
返り値: ダイアログのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。
| 名前 | 型 | 概要 |
|---|---|---|
| page | String | pageのURLか、もしくはons-templateで宣言したテンプレートのid属性の値を指定できます。 |
| options | Object | オプションを指定するオブジェクト。 |
| options.parentScope | Object | ダイアログ内で利用する親スコープを指定します。ダイアログからモデルやスコープのメソッドにアクセスするのに使います。このパラメータはAngularJSバインディングでのみ利用できます。 |
テンプレートからダイアログのインスタンスを生成します。
返り値: ダイアログのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。
| 名前 | 型 | 概要 |
|---|---|---|
| page | String | pageのURLか、もしくはons-templateで宣言したテンプレートのid属性の値を指定できます。 |
| options | Object | オプションを指定するオブジェクト。 |
| options.parentScope | Object | ダイアログ内で利用する親スコープを指定します。ダイアログからモデルやスコープのメソッドにアクセスするのに使います。このパラメータはAngularJSバインディングでのみ利用できます。 |
テンプレートからポップオーバーのインスタンスを生成します。
返り値: ポップオーバーのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。
| 名前 | 型 | 概要 |
|---|---|---|
| page | String | pageのURLか、もしくはons-templateで宣言したテンプレートのid属性の値を指定できます。 |
| options | Object | オプションを指定するオブジェクト。 |
| options.parentScope | Object | ダイアログ内で利用する親スコープを指定します。ダイアログからモデルやスコープのメソッドにアクセスするのに使います。このパラメータはAngularJSバインディングでのみ利用できます。 |
Onsen UIに関する質問は、Stack Overflowにてonsen-uiタグを付与してください。Onsen UIチームはあなたの問題解決をお手伝いします。
バグ報告や機能要望については、GitHub Issuesに記載をお願いいたします。
あわせて、下記の情報も参考にしてください。