kibana-plugin-core-server.pluginmanifest.md

Home > kibana-plugin-core-server > PluginManifest

PluginManifest interface

Describes the set of required and optional properties plugin can define in its mandatory JSON manifest file.

Signature:

export interface PluginManifest 

Remarks

Should never be used in code outside of Core but is exported for documentation purposes.

Properties

Property	Modifiers	Type	Description
configPath	readonly	ConfigPath	Root used by the plugin, defaults to "id" in snake_case format.
description?	readonly	string	(Optional) TODO: make required once all plugins specify this. A brief description of what this plugin does and any capabilities it provides.
enabledOnAnonymousPages?	readonly	boolean	(Optional) Specifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when configured, etc.) Default is false.
extraPublicDirs?	readonly	string[]	(Optional) Specifies directory names that can be imported by other ui-plugins built using the same instance of the @kbn/optimizer. A temporary measure we plan to replace with better mechanisms for sharing static code between plugins
id	readonly	PluginName	Identifier of the plugin. Must be a string in camelCase. Part of a plugin public contract. Other plugins leverage it to access plugin API, navigate to the plugin, etc.
kibanaVersion	readonly	string	The version of Kibana the plugin is compatible with, defaults to "version".
optionalPlugins	readonly	readonly PluginName[]	An optional list of the other plugins that if installed and enabled **may be** leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly.
owner	readonly	{ readonly name: string; readonly githubTeam?: string; }
requiredBundles	readonly	readonly string[]	List of plugin ids that this plugin's UI code imports modules from that are not in requiredPlugins.
requiredPlugins	readonly	readonly PluginName[]	An optional list of the other plugins that **must be** installed and enabled for this plugin to function properly.
server	readonly	boolean	Specifies whether plugin includes some server-side specific functionality.
serviceFolders?	readonly	readonly string[]	(Optional) Only used for the automatically generated API documentation. Specifying service folders will cause your plugin API reference to be broken up into sub sections.
type	readonly	PluginType	Type of the plugin, defaults to standard.
ui	readonly	boolean	Specifies whether plugin includes some client/browser specific functionality that should be included into client bundle via public/ui_plugin.js file.
version	readonly	string	Version of the plugin.