Ui
showNotification(name, title, message, [sticky], [level])
Show a notification, if Writer is used inside of Dashboard, the notification will be elevated and displayed through the Dashboard notification instead
Parameters
Example
showArticleMessage(origin, id, options)
Display a message with static positioning at the top of the article. Can disallow closing, and can include buttons with callback functions.
Parameters
Example
showDialog(contentComponent, props, options, [focusPrimary], [theme], [takeover], [cssClass], [clearSelection], [disableEscKey], [heading])
Display a dialog with the specified content.
Supported dialog actions:
`dialog:enablePrimaryBtn`Enables the primary button`dialog:disablePrimaryBtn`Disables the primary button
See: component/dialogComponent
Parameters
Example
showAuthDialog(authComponent, authProps, authOptions)
Display a Auth dialog (401/402) above any other dialogs.
Parameters
showMessageDialog(messages, cbContinue, cbCancel, [heading], [showTimestamp])
Display a number of messages and different options depending on the severity on each message. Messages can be of type info, warning or error.
If there are error messages the user will not be able to continue. If there are warnings the user can continue but suggested to cancel. If only info messages only a continue is possible.
Parameters
Example
showConfirmDialog(title, message, buttons)
Display a simple confirmation dialog
Parameters
Example
showBottomPanel(pluginName, component, [props], [sticky])
Renders a supplied component in a screen-wide panel which smoothly animates from the bottom of the screen.
Parameters
Example
showOverlay(pluginName, component, [props])
Renders a supplied component in a "fullscreen" overlay.
Parameters
Example
hideOverlay(pluginName)
Hides the overlay. Useful to call this in a component that rendered as and overlay component.
Parameters
Example
getComponent()
Deprecated
Deprecated, use import {UIComponent} from 'writer'
statements for UIComponents instead
Last updated