import ProgressDialog from '@osjs/dialogs/src/dialogs/progress.js'

public class | source

ProgressDialog

Dialog → ProgressDialog

Default OS.js Progress Dialog

Constructor Summary

Public Constructor
public	constructor(core: Core, args: Object, callback: Function) Constructor

Public Methods
public	setProgress(value: Number) Set the progress value
public	setStatus(status: String) Set the status text

From class Dialog
public	createButtons(states: Object): Object[] Gets the button (virtual) DOM elements
public	createView(children: Object[], state: Object): Object Creates the default view
public	destroy() Destroys the dialog
public	emitCallback(name: String, ev: Event, close: Boolean) Emits the callback
public	getNegativeButton(): String \| undefined Gets the first negative button
public	getPositiveButton(): String \| undefined Gets the first positive button
public	getValue(): * Gets the dialog result value
public	playSound(): boolean
public	render(cb: Function): * Renders the dialog

Constructor

Name	Type	Attribute	Description
core	Core		OS.js Core reference
args	Object		Arguments given from service creation
args.title	String	optional	Dialog title
args.message	String	optional	Dialog message
args.status	String	optional	Dialog status message
args.progress	String	optional	Initial progress value
args.buttons	String[]	optional	Override dialog buttons
callback	Function		The callback function

Set the progress value

Name	Type	Attribute	Description
value	Number		A value between 0 and 100

Set the status text

Name	Type	Attribute	Description
status	String		Status text