Files
backstage/docs/reference/createPlugin.md
T

756 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';

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