Plugin
Plugins enable developers to replace DatoCMS field components with HTML5 applications so the editing experiences of the DatoCMS web app can be customized.
Object payload
RFC 4122 UUID of plugin expressed in URL-safe base64 format
"RMAMRffBRlmBuDlQsIWZ0g"
Must be exactly "plugin".
The name of the plugin
"5 stars"
A description of the plugin
"A better rating experience!"
The entry point URL of the plugin
"https://cdn.rawgit.com/datocms/extensions/master/samples/five-stars/extension.ts"
Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits. Collaborators always receive it. API tokens and OAuth applications receive it only if they can edit the schema of the project, otherwise it returns null.
{ devMode: true }
NPM package name of the plugin (or null if it's a private plugin)
"datocms-plugin-star-rating-editor"
The installed version of the plugin (or null if it's a private plugin)
"0.0.4"
Permissions granted to this plugin
Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
Version of the plugin. Legacy plugins are v1, new plugins are v2
"2"
The type of field extension a legacy plugin implements
This field makes sense for legacy plugins only. Modern plugins declare their capabilities at run-time.
Field editor plugin
Sidebar plugin
Field addon plugin
On which types of field in which a legacy plugin can be used
This field makes sense for legacy plugins only. Modern plugins declare their capabilities at run-time.
The schema for the parameters a legacy plugin can persist
This field makes sense for legacy plugins only. Modern plugins declare can store anything they want in the parameters attribute.