Confirm action
Introduction¶
Create a modal confirm dialog temporary, invoke callback after clicking button.
- Author: Rex
- Method
Live demos¶
Usage¶
Install plugin¶
Load minify file¶
- Load plugin (minify file) in preload stage
scene.load.scenePlugin('rexuiplugin', 'https://raw.githubusercontent.com/rexrainbow/phaser3-rex-notes/master/dist/rexuiplugin.min.js', 'rexUI', 'rexUI');
- Run confirm action
var dialog = scene.rexUI.confirmAction(scene, config);
dialog
: Confirm dialog will be destroy after clicking any button.
Import plugin¶
- Install rex plugins from npm
npm i phaser3-rex-plugins
- Install plugin in configuration of game
import UIPlugin from 'phaser3-rex-plugins/templates/ui/ui-plugin.js'; var config = { // ... plugins: { scene: [{ key: 'rexUI', plugin: UIPlugin, mapping: 'rexUI' }, // ... ] } // ... }; var game = new Phaser.Game(config);
- Run confirm action
var dialog = scene.rexUI.confirmAction(scene, config)
dialog
: Confirm dialog will be destroy after clicking any button.
Import class¶
- Install rex plugins from npm
npm i phaser3-rex-plugins
- Import class
import { ConfirmAction } from 'phaser3-rex-plugins/templates/ui/ui-components.js';
- Run confirm action
var dialog = ConfirmAction(scene, config)
dialog
: Confirm dialog will be destroy after clicking any button.
Run confirm action¶
var dialog = scene.rexUI.confirmAction(scene, {
style: confirmDialogConfig
content: confirmDialogResetChoiceDisplayContentConfig,
// modal: confirmDialogModalConfig,
// onCreateDialog: function(dialog) { },
confirm: function() {},
// confirmScope:
// confirmButtonIndex: 0,
// cancel: function() {},
// cancelScope:
// cancelButtonIndex: 1,
})
- Build confirm dialog
style
: Config parameter of Confirm dialogcontent
: Content strings of title, content, button.modal
: Config parameter of modal methodonCreateDialog
: Callback invoking after creating dialog.function(dialog) { }
- Callbacks
confirm
,confirmScope
: Callback invoking when click confirm/OK button of Confirm dialogconfirmButtonIndex
: Index of confirm/OK button on Confirm dialog. Default value is0
.cancel
,cancelScope
: Callback invoking when click cancel/cancel button of Confirm dialogcancelButtonIndex
: Index of cancel/cancel button on Confirm dialog. Default value is1
.
dialog
: Confirm dialog will be destroy after clicking any button.