Application service
Plugins utilize the Application service API to load and render applications within Kibana's Single Page Application UI in response to user interactions. This service also provides utilities for managing navigation link state, integrating routing between applications, and handling on-demand loading of async chunks.
Note
The Application service is only available client side.
import { AppMountParameters, CoreSetup, Plugin, DEFAULT_APP_CATEGORIES } from '@kbn/core/public';
export class MyPlugin implements Plugin {
public setup(core: CoreSetup) {
core.application.register({
category: DEFAULT_APP_CATEGORIES.kibana,
id: 'my-plugin',
title: 'my plugin title',
euiIconType: '/path/to/some.svg',
order: 100,
appRoute: '/app/my_plugin',
async mount(params: AppMountParameters) {
// Load application bundle
const { renderApp } = await import('./application');
// Get start services
const [coreStart, depsStart] = await core.getStartServices();
// Render the application
return renderApp(coreStart, depsStart, params);
},
});
}
}
- application.register interface
- Application specific URL.
mountcallback is invoked when a user navigates to the application-specific URL.core.getStartServicesmethod provides API available duringstartlifecycle.- The
mountmethod must return an unmount function, which Kibana invokes when the application unmounts. This is where cleanup logic should be placed.
Note
you are free to use any UI library to render a plugin application in DOM. However, we recommend using React and EUI for all your basic UI components to create a consistent UI experience.