Comment on page
Constructor
Appmixer Constructor lays a foundation for building user interfaces with widgets.
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)
Type:
String
| Default: null
Base URL of your Appmixer engine REST API.
Type:
String
| Default: null
Access token of an authorized user.
Type:
Boolean
| Default: false
Enable debugger for development purposes.
Type:
Object
| Default: DefaultTheme
Type:
Object
| Default: DefaultL10N
Define custom localization texts.
Type:
String
| Default: en
Specify a language code for the localization of components.
Type:
Object
| Default: {}
Set custom API methods.
appmixer.ui('Widget', {/* ... */})
appmixer.ui.Widget({/* ... */})
Register and create UI Widgets.
Use methods of built-in API Module.
appmixer.set(key, value)
Set configuration property.
appmixer.get(key, value)
Get configuration property.
appmixer.registerCustomComponentShape(name, shape)
Register a custom Designer component shape.
appmixer.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>
Change
USERNAME
and PASSWORD
parameters to valid credentials for registration of a new user.
Flow Manager
Learn more about the basic usage with the Quick Start example.
Last modified 4mo ago