Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Create charts to visualize logs of messages that passed through flows.
Set up a new instance with config
parameters and set
/get
methods:
config.el
...
Learn about widget
config
here.
Learn about widget
instance here.
loader
Type: Boolean
| Default: null
Toggle a custom loading state.
error
Type: String
| Default: null
Toggle a custom error message.
close
Close the editor.
Build, edit and inspect individual flows in a comprehensive editor.
Set up a new instance with config
parameters and set
/get
methods:
config.el
...
config.flowId
Type: String
| Default: null
ID of a flow that is opened in the editor.
config.componentId
Type: String
| Default: null
ID of a component that is opened in the editor.
config.shareTypes
Type: Object
| Default: DefaultShareTypes
Override default sharing dialog types.
config.sharePermissions
Type: Object[]
| Default: DefaultSharePermissions
Override default sharing dialog permissions.
config.options.showHeader
Type: Boolean
| Default: true
Toggle visibility of the header.
config.options.menu
Type: Object[]
| Default: []
Add a dropdown menu input to trigger built-in and custom events:
The optional icon
property is a URL of an image or a base64
string.
config.options.toolbar
Type: Array[]
| Default: []
Add a toolbar with groups of built-in and custom buttons:
loader
Type: Boolean
| Default: null
Toggle a custom loading state.
error
Type: String
| Default: null
Toggle a custom error message.
flow:start
Toggle stage button to start the flow.
flow:stop
Toggle stage button to stop the flow.
flow:share
Click menu item to open sharing of the flow.
flow:rename
Click menu item to rename the flow.
flow:export-svg
Click menu item to export diagram of the flow to SVG.
flow:export-png
Click menu item to export diagram of the flow to PNG.
flow:print
Click menu item to print diagram of the flow.
flow:wizard-builder
Click menu item to open a wizard builder dialog.
component:add
Add a new component to the flow.
component:open
Open component inspector.
component:close
Close component inspector.
component:rename
Rename a component.
component:update-type
Use selection input to change component type.
navigate:validation
Click a button to show validation errors.
Browse logs of messages that passed through flows.
Browse and manipulate flows that are accessible to the current user.
Set up a new instance with config
parameters and set
/get
methods:
config.el
...
config.options
Type: Object
| Default: DefaultOptions
config.options.menu
Type: Object[]
| Default: []
Add a dropdown menu input to each flows to trigger built-in and custom events:
The optional icon
property is a URL of an image or a base64
string.
config.options.shareTypes
Type: Object
| Default: DefaultShareTypes
Override default sharing dialog types.
config.options.sharePermissions
Type: Object[]
| Default: DefaultSharePermissions
Override default sharing dialog permissions.
config.options.filters
Type: Object[]
| Default: []
Create dropdown inputs with built-in query filters:
config.options.customFilter
Type: Object
| Default: {}
Filter the flows with additional parameters:
This is especially useful in connection with customFields
metadata
to display multiple different Flow Managers each listing a different category of flows:
config.options.sorting
Type: Object[]
| Default: []
Create dropdown inputs with built-in sorting:
loader
Type: Boolean
| Default: null
Toggle a custom loading state.
error
Type: String
| Default: null
Toggle a custom error message.
layout
Type: String
| Default: grid
Change layout of the widget.
query
Type: Object
| Default: DefaultQuery
Set custom query parameters.
flow:open
Select a flow to open in Designer widget.
flow:create
Click Create Flow button.
flow:start
Toggle flow stage button.
flow:stop
Toggle flow stage button.
flow:clone
Click menu item to clone a flow.
flow:share
Click menu item to open sharing of a flow.
flow:rename
Click menu item to rename flow.
flow:remove
Click menu item to remove a flow.
Add menu item with flow:share
event for a configurable flow sharing dialog:
Learn about widget
config
.
Specify Vue under widget
to create a custom toolbar button.
Learn about widget
instance .
Learn about widget
config
.
Learn about widget
instance .
Learn about widget
config
.
Learn about widget
instance .
Appmixer UI is a tool for building user interfaces with component-based widgets.
Widgets are included in appmixer.ui
instances made with Appmixer constructor:
config.el
Type: String|Element
| Default: null
HTML DOM element to serve as a container of the widget.
config.theme
Type: Object
| Default: DefaultTheme
Custom theme definition.
config.l10n
Type: Object
| Default: DefaultL10N
Custom localization texts.
config.lang
Type: String
| Default: en
Language code for localization of components.
config.api
Type: Object
| Default: DefaultAPI
Custom API methods.
widget.open
Mount the widget
instance and render it inside the el
container.
widget.close
Unmount the widget
instance and hide the el
container.
widget.reload
Reload the entire widget
.
widget.reset
Reset the state of the widget to defaults.
widget.state
Use state
for properties that may change at any time when the widget
is active.
widget.set
Set config
property.
widget.get
Get config
property.
widget.on
Add a new event listener and disable the default handler of the event.
widget.off
Remove an event listener and enable the default handler of the event.
Browse apps and components that are accessible to the current user inside flows.
Set up a new instance with config
parameters and set
/get
methods:
config.el
...
Learn about widget
config
here.
Learn about widget
instance here.
loader
Type: Boolean
| Default: null
Toggle a custom loading state.
error
Type: String
| Default: null
Toggle a custom error message.
Browse and manipulate charts created by the current user.
Set up a new instance with config
parameters and set
/get
methods:
config.el
...
Learn about widget
config
here.
Learn about widget
instance here.
loader
Type: Boolean
| Default: null
Toggle a custom loading state.
error
Type: String
| Default: null
Toggle a custom error message.
chart:clone
Clone chart.
chart:remove
Remove chart.
chart:open
Open chart in Chart Editor.
Manage accounts authorized by the current user.
Set up a new instance with config
parameters and set
/get
methods:
config.el
...
Learn about widget
config
here.
Learn about widget
instance here.
loader
Type: Boolean
| Default: null
Toggle a custom loading state.
error
Type: String
| Default: null
Toggle a custom error message.
flow:open
Select a flow to open in Designer widget.
Manage flows used as integration templates and instances.
Set up a new instance with config
parameters and set
/get
methods:
config.el
...
Learn about widget
config
here.
config.options
Type: Object
| Default: {}
config.options.customFilter
Type: Object
| Default: {}
Filter the integrations with additional parameters:
Learn about widget
instance here.
loader
Type: Boolean
| Default: null
Toggle a custom loading state.
error
Type: String
| Default: null
Toggle a custom error message.
integration:create
Click a button to to create a new integration from template.
integration:edit
Click a button to edit integration.
integration:remove
Click a button to remove integration.
integration:start
Click a button to start integration.
integration:stop
Click a button to stop integration.
Manage tasks created by utility components of flows.
Set up a new instance with config
parameters and set
/get
methods:
config.el
...
Learn about widget
config
here.
Learn about widget
instance here.
loader
Type: Boolean
| Default: null
Toggle a custom loading state.
error
Type: String
| Default: null
Toggle a custom error message.
Manage a flow that is used as an integration instance.
Set up a new instance with config
parameters and set
/get
methods:
config.el
...
Learn about widgetconfig
here.
config.flowId
Type: String
| Default: null
The ID of a flow that is opened in the wizard.
Learn about widget
instance here.
loader
Type: Boolean
| Default: null
Toggle a custom loading state.
error
Type: String
| Default: null
Toggle a custom error message.
flow:start
Submit the form and start the flow.
flow:validation
Flow validation errors changed.
cancel
Click a button to close the form.
close
Submit the form and wait for the flow to start.
Manage records associated with data storage utility components of flows.
Set up a new instance with config
parameters and set
/get
methods:
config.el
...
Learn about widget
config
here.
config.storeId
Type: String
| Default: []
ID of a store to open within the storage.
Learn about widget
instance here.
loader
Type: Boolean
| Default: null
Toggle a custom loading state.
error
Type: String
| Default: null
Toggle a custom error message.