kibana/docs/development/core/public/kibana-plugin-public.md

4.1 KiB

Home > kibana-plugin-public

kibana-plugin-public package

Classes

Class Description
FlyoutRef A FlyoutRef is a reference to an opened flyout panel. It offers methods to close the flyout panel again. If you open a flyout panel you should make sure you call close() when it should be closed. Since a flyout could also be closed by a user or from another flyout being opened, you must bind to the onClose Promise on the FlyoutRef instance. The Promise will resolve whenever the flyout was closed at which point you should discard the FlyoutRef.
ToastsApi
UiSettingsClient

Interfaces

Interface Description
ApplicationSetup
ApplicationStart
BasePathSetup Provides access to the 'server.basePath' configuration option in kibana.yml
Capabilities The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled.
ChromeBadge
ChromeBrand
ChromeBreadcrumb
CoreSetup Core services exposed to the start lifecycle
CoreStart
FatalErrorsSetup FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error.
I18nSetup I18nSetup.Context is required by any localizable React component from @kbn/i18n and @elastic/eui packages and is supposed to be used as the topmost component for any i18n-compatible React tree.
InjectedMetadataSetup Provides access to the metadata injected by the server into the page
LegacyNavLink
NotificationsSetup
OverlayStart
Plugin The interface that should be returned by a PluginInitializer.
PluginInitializerContext The available core services passed to a PluginInitializer
PluginSetupContext The available core services passed to a plugin's Plugin#setup method.
UiSettingsState

Type Aliases

Type Alias Description
BasePathStart Provides access to the 'server.basePath' configuration option in kibana.yml
ChromeHelpExtension
ChromeSetup
HttpSetup
I18nStart
InjectedMetadataStart
NotificationsStart
PluginInitializer The plugin export at the root of a plugin's public directory should conform to this interface.
ToastInput
UiSettingsSetup