Skip to main content

Admin panel plugin

The Admin panel plugin screen enables you to insert custom plugins into the Kuroco Admin panel pages. Currently, Kuroco supports 2 types of plugins:

  • Vue.js
  • CSS

Plugin list

Accessing the screen

In the left sidebar menu, under "SETTINGS", click [Environment] -> [Admin panel plugin].

Image from Gyazo

Item descriptions

Image from Gyazo

Item/ButtonDescription
StatusStatus of the plugin.
Plugin IDID of the plugin.
NameName of the plugin.
TypeType of plugin (CSS or Vue.js).
SourceLocation information for the plugin.
TargetAdmin panel screen and slot for loading the plugin.
PropsYou can insert a JSON object with initial props to be read by Vue.js plugins. Certain pages and slots use additional props.
Updated onDate and time the plugin was last updated.
EditClick [Settings] to open the configuration dialog.
DeleteClick to remove the plugin.

Batch actions

Image from Gyazo

To delete selected plugins in bulk, check the checkboxes on the left side of the list and click [Delete].

Adding and editing Admin panel plugins

To add a new plugin

Click [Add] in the upper right corner of the screen.

Image from Gyazo

After entering the content, click [Add] to apply the changes.

Image from Gyazo

To edit an existing plugin

Click [Settings] under the "Edit" column.

Image from Gyazo

After updating the content, click [Update] to apply the changes.

Image from Gyazo

Item Description

ItemDescription
StatusOption to activate the plugin settings.
Plugin nameName of the plugin.
TypeType of plugin (CSS or Vue.js).
Source
Component name
For Vue.js plugins, Kuroco supports MPAs (multi-page applications). Enter the component name of your MPA entry point here (e.g., MyEntryPoint).
Source URLUpload location of the plugin. This can be any domain.
Manifest keysFor Vue.js plugins, enter the list of Webpack manifest keys for the app components in the order of loading, separated by semicolons (e.g., MyEntryPoint.js;vendors.*). Values are based on your Webpack code splitting/chunking configurations.
Target
Page URI
Relative URI of the Kuroco admin panel page that will load your plugin. Omit the /management prefix. You can also specify any custom page, in which case the page will be accessible as exclusive content for the plugin.
Slot nameSlot that loads the plugin. Plugins can be loaded in various locations depending on their values. (See:Slots available for admin panel plugins)
Slot paramsSome pages allow slot params that configure specific conditions for loading the plugins. For example, the content editor page may load a plugin only for specific user groups.
PropsTo pass configurable props to your plugin, enter them here as JSON objects: e.g., {"my_prop": "my_prop_value"}.
UpdateApplies the edits made to the admin panel plugin.
CopyCopies the currently existing admin panel plugin to create a new admin panel plugin.

Update History

Image from Gyazo

ItemDescription
VersionDisplays the version.
Click to check the status of the selected version.
Updated onDisplays the date and time when the content was updated.
Updated byDisplays the name of the member who updated the content.
ActionDisplays the type of action taken.
There are six types of actions:
  • New Addition
  • Update
  • Delete
  • Submit
  • Approve
  • Rejection of Approval
CommentDisplays comments left at the time of the update.
ContentDisplays the updated content.

Support

If you have any other questions, please contact us or check out Our Slack Community.