Variable: arWebDesigner

const arWebDesigner: object;

The main object exported by WebDesigner ESM module.

Type declaration

addLanguage()

addLanguage: (lng, resources) => void;

Adds language resources for all instances of WebDesigner

Example:

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.addLanguage('en', [
   {
       "ns": "app",
       "lng": "en",
       "resources": {
          "textAppTitleCompact": "",
       }
   },
]);

**

Parameters

lng

string

resources

ResourceBundle[]

Returns

void

apiOf()

apiOf: (instanceId) => DesignerAPI;

Returns DesignerAPI of previously created instance of WebDesigner

Example:

// ESM usage
import { arWebDesigner } from './web-designer.js';
const designer = arWebDesigner.apiOf('ar-web-designer');

**

Parameters

instanceId

string

Returns

DesignerAPI

create()

create: (selector, settings) => Promise<DesignerAPI>;

Renders Web Designer to

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
	rpx: { enabled: true },
	appBar: { openButton: { visible: true } }
});

destroy: (selector, instanceId?) => void;

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#container-1', { ...settings, instanceId: 'instance-1' });
arWebDesigner.destroy('#container-1', 'instance-1');