function

defineAdminPlugin

function defineAdminPlugin<const Plugin extends AdminPlugin>(
	plugin: Plugin,
): Plugin

Preserve inference while declaring a statically bundled admin plugin.

Source packages/plugin/src/index.ts:28

@param plugin: The plugin value.
@returns: The declared result.

Example

export const editorial = defineAdminPlugin({
  apiVersion: ADMIN_PLUGIN_API_VERSION,
  key: "acme.editorial",
  pairingVersion: 1,
  fields: [],
  routes: [
    {
      path: "/editorial",
      component: EditorialView,
      navigation: { label: "Editorial" },
    },
  ],
});

Related types

AdminPlugin
The complete statically bundled admin half of a plugin.