Constructor
Appmixer Constructor lays a foundation for building user interfaces with widgets.
Last updated
Was this helpful?
5.2
Appmixer Constructor lays a foundation for building user interfaces with widgets.
Last updated
Was this helpful?
Was this helpful?
Set up a new appmixer instance with config parameters and set/get methods:
const appmixer = new Appmixer({/* [name]: value */})
appmixer.set(name, value)
appmixer.get(name)config.baseUrlType: String | Default: null
Base URL of your Appmixer engine REST API.
config.accessTokenType: String | Default: null
Access token of an authorized user.
config.debugType: Boolean | Default: false
Enable debugger for development purposes.
config.themeType: Object | Default: DefaultTheme
config.l10nType: Object | Default: DefaultL10N
Define custom localization texts.
config.langType: String | Default: en
Specify a language code for the localization of components.
config.apiType: Object | Default: {}
Set custom API methods.
appmixer.uiappmixer.ui('Widget', {/* ... */})
appmixer.ui.Widget({/* ... */})Register and create UI Widgets.
appmixer.apiUse methods of built-in API Module.
appmixer.setappmixer.set(key, value)Set configuration property.
appmixer.getappmixer.get(key, value)Get configuration property.
appmixer.registerCustomComponentShapeappmixer.registerCustomComponentShape(name, shape)Register a custom Designer component shape.
appmixer.registerInspectorFieldappmixer.registerInspectorField(type, Field, options)Register a custom Designer inspector field.
Connect to Appmixer engine REST API and render user interfaces with a built-in widget:
<html lang="en">
<head>
<meta charset="UTF-8">
<script src="https://my.YOURTENANT.appmixer.cloud/appmixer/appmixer.js"></script>
</head>
<body>
<div id="your-widget"></div>
<script async type="module">
const appmixer = new Appmixer({ baseUrl: BASE_URL })
const auth = await appmixer.api.signupUser(USERNAME, PASSWORD)
appmixer.set('accessToken', auth.token)
appmixer.ui.FlowManager({ el: '#your-widget' }).open()
</script>
</body>
</html>
Learn more about the basic usage with the Quick Start example.