Plugins can be created and managed through the Zengine Developer screen, found in the Developer section of My Account. To start, there are two options – name and namespace. Name will be used to publicly identify your plugin in the app. Namespace is a unique identifier to be used by your plugin code to distinguish it from other plugins. Namespace is not publicly displayed, but it will be used in several places in your plugin code. Name can be changed, but namespace cannot be changed after your plugin is created.
text property to
If you click into CSS, you can see the CSS that will apply to your HTML. CSS will be scoped by your namespace when published, so your CSS will only apply inside your plugin.
There are various plugin options you can change through the registration options. The following options are the only ones you need to get a full-page plugin up and running.
A plugin can have one or more
interfaces. This interfaces allows you to develop a plugin that with different types, for example a common use case is a plugin type
A plugin can also have multiple
This allows you to develop a plugin with different types, for example a common use case is a plugin with both
route parameter represents the URI path to run your plugin. If your route is
/myplugin, then the full URI to your plugin might be
controller parameter represents the main controller name. Note that all controller names are prefixed with your namespace, like
Similar to controller, your plugin HTML can have multiple templates. The
template parameter corresponds to the template associated with the main controller. This value represents a template ID in the plugin HTML. The template ID must be prefixed with a dash-delimited version of your namespace, like
my-plugin-main. This is in keeping with the AngularJS HTML attribute style.
You can test your plugin as you develop by clicking the Run button in the top right corner. When you run your plugin, you will be taken out of the editor and back to the app. Navigate to one of your workspaces and you will notice a new icon for the plugin in the header. Hover over the icon and it should display the plugin name. Click on the icon and it will open the plugin to display the Hello World text.
At this point, your plugin is not published. Only you can access and run your plugin.
To get back to the plugin editor, hover over the Dev Mode menu in the right of the header and click View Editor.
You can get to the publishing screen by clicking the Publishing Settings button in the plugin editor. From there you can confirm settings such as the name and description. You can also provide a Firebase URL and optionally a Firebase secret. The Firebase secret will allow a plugin to take advantage of Firebase authentication.
Plugins are available only to the developer prior to publishing. Once a plugin is published, different rules apply, depending on whether it’s a private or public plugin:
More information about publishing is available here.