ons

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. (翻訳中)
forceUIWebViewScrollFix() Applies a fix for iOS UIWebView which prevents scroll events jumping to pages under the top layer. This may visually affect normal scrolling of UIWebView if you open a dialog/menu before the scroll momentum finished. Disabled by default. (翻訳中)
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. (翻訳中)
isReady(): Boolean

Onsen UIがすでに初期化されているかどうかを返すメソッドです。

返り値: 初期化されているかどうかを返します。

isWebView(): Boolean

Cordovaで実行されているかどうかを返すメソッドです。

返り値: Cordovaで実行されている場合にtrueになります。

ready(callback)

アプリの初期化に利用するメソッドです。渡された関数は、Onsen UIの初期化が終了している時点で必ず呼ばれます。

パラメーター
名前 概要
callback Function Onsen UIが初期化が完了した後に呼び出される関数オブジェクトを指定します。
setDefaultDeviceBackButtonListener(listener)

デバイスのバックボタンのためのデフォルトのハンドラを設定します。

パラメーター
名前 概要
listener Function デバイスのバックボタンが押された時に実行される関数オブジェクトを指定します。
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. (翻訳中)

forceUIWebViewScrollFix()

Applies a fix for iOS UIWebView which prevents scroll events jumping to pages under the top layer. This may visually affect normal scrolling of UIWebView if you open a dialog/menu before the scroll momentum finished. Disabled by default. (翻訳中)

パラメーター
名前 概要
force Boolean Enable or disable the fix.
forcePlatformStyling(platform)

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.
preload(templatePaths): Promise

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. (翻訳中)
createElement(template, options): HTMLElement|Promise

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). (翻訳中)
createPopover(page, [options]): Promise

テンプレートからポップオーバーのインスタンスを生成します。

返り値: ポップオーバーのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。

パラメーター
名前 概要
page String pageのURLか、もしくは<template>で宣言したテンプレートのid属性の値を指定できます。
options Object オプションを指定するオブジェクト。
options.parentScope Object ダイアログ内で利用する親スコープを指定します。ダイアログからモデルやスコープのメソッドにアクセスするのに使います。このパラメータはAngularJSバインディングでのみ利用できます。
createDialog(page, [options]): Promise

テンプレートからダイアログのインスタンスを生成します。

返り値: ダイアログのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。

パラメーター
名前 概要
page String pageのURLか、もしくは<template>で宣言したテンプレートのid属性の値を指定できます。
options Object オプションを指定するオブジェクト。
createAlertDialog(page, [options]): Promise

テンプレートからアラートダイアログのインスタンスを生成します。

返り値: ダイアログのコンポーネントオブジェクトを解決するPromiseオブジェクトを返します。

パラメーター
名前 概要
page String pageのURLか、もしくは<template>で宣言したテンプレートのid属性の値を指定できます。
options Object オプションを指定するオブジェクト。
openActionSheet(options): Promise

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. (翻訳中)
resolveLoadingPlaceholder(page)

ons-loading-placeholderの属性値としてページが指定されていない場合は、ページロード前に呼ばれるons.resolveLoadingPlaceholder処理が行われるまで表示されません。

パラメーター
名前 概要
page String pageのURLか、もしくは<template>で宣言したテンプレートのid属性の値を指定できます。
getScriptPage(): HTMLElement

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に関する質問は、Stack Overflowにてonsen-uiタグを付与してください。Onsen UIチームはあなたの問題解決をお手伝いします。

バグ報告や機能要望については、GitHub Issuesに記載をお願いいたします。

あわせて、下記の情報も参考にしてください。