Files
backstage/docs/reference/createPlugin.md
T
Patrik Oldsberg 642cec7ac7 docs: remove references to @backstage/core
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-24 12:50:40 +02:00

767 B

id, title, description
id title description
createPlugin createPlugin Documentation on createPlugin

Takes a plugin config as an argument and returns a new plugin.

Plugin Config

function createPlugin(config: PluginConfig): BackstagePlugin;

type PluginConfig = {
  id: string;
  register?(hooks: PluginHooks): void;
};

type PluginHooks = {
  featureFlags: FeatureFlagsHooks;
};

Example Uses

Creating a basic plugin

Showcasing adding a feature flag.

import { createPlugin } from '@backstage/core-plugin-api';

export default createPlugin({
  id: 'new-plugin',
  register({ router, featureFlags }) {
    featureFlags.register('enable-example-component');
  },
});