javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-22 13:32:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(app): documented setEnabled, setScrollDisabled methods

Browse Source 
documented setEnabled, setScrollDisabled methods
This commit is contained in:
Dan Bucholtz
2016-08-10 09:38:08 -05:00
parent 79e25a342d
commit e244d09eaa
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/components/app/app.ts
View File

@ -93,12 +93,11 @@ export class App {
} }
/** /**
* @private
* Sets if the app is currently enabled or not, meaning if it's * Sets if the app is currently enabled or not, meaning if it's
* available to accept new user commands. For example, this is set to `false` * available to accept new user commands. For example, this is set to `false`
* while views transition, a modal slides up, an action-sheet * while views transition, a modal slides up, an action-sheet
* slides up, etc. After the transition completes it is set back to `true`. * slides up, etc. After the transition completes it is set back to `true`.
* @param {boolean} isEnabled * @param {boolean} isEnabled `true` for enabled, `false` for disabled
* @param {number} duration When `isEnabled` is set to `false`, this argument * @param {number} duration When `isEnabled` is set to `false`, this argument
* is used to set the maximum number of milliseconds that app will wait until * is used to set the maximum number of milliseconds that app will wait until
* it will automatically enable the app again. It's basically a fallback incase * it will automatically enable the app again. It's basically a fallback incase
@ -120,7 +119,9 @@ export class App {
} }
/** /**
* @private * Toggles whether an application can be scrolled
* @param {boolean} disableScroll when set to `false`, the application's
* scrolling is enabled. When set to `true`, scrolling is disabled.
*/ */
setScrollDisabled(disableScroll: boolean) { setScrollDisabled(disableScroll: boolean) {
let enabled = this._config.get('canDisableScroll', true); let enabled = this._config.get('canDisableScroll', true);