---
title: plugins - æ’件 API
sidebar_position: 2
---
> **@types** [IPublicApiPlugins](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/api/plugins.ts)
> **@since** v1.0.0
## 模å—简介
æ’件管ç†å™¨ï¼Œæ供编排模å—ä¸ç®¡ç†æ’件的能力。
## 方法
### register
注册æ’件
```typescript
async function register(
plugin: IPublicTypePlugin,
options?: IPublicTypePluginRegisterOptions,
): Promise
```
相关 types:
- [IPublicTypePlugin](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/plugin.ts)
- [IPublicTypePluginRegisterOptions](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/plugin-register-options.ts)
å…¶ä¸ç¬¬ä¸€ä¸ªå‚æ•° plugin 通过低代ç 工具链的æ’件脚手架生æˆç¼–写模æ¿ï¼Œå¼€å‘者å¯ä»¥å‚考[è¿™ä¸ªç« èŠ‚](/site/docs/guide/expand/editor/cli)进行创建
#### 简å•ç¤ºä¾‹
```typescript
import { plugins } from '@alilc/lowcode-engine';
import { IPublicModelPluginContext } from '@alilc/lowcode-types';
const builtinPluginRegistry = (ctx: IPublicModelPluginContext) => {
return {
async init() {
const { skeleton } = ctx;
// 注册组件é¢æ¿
const componentsPane = skeleton.add({
area: 'leftArea',
type: 'PanelDock',
name: 'componentsPane',
content: ComponentsPane,
contentProps: {},
props: {
align: 'top',
icon: 'zujianku',
description: '组件库',
},
});
componentsPane?.disable?.();
project.onSimulatorRendererReady(() => {
componentsPane?.enable?.();
})
},
};
}
builtinPluginRegistry.pluginName = 'builtinPluginRegistry';
await plugins.register(builtinPluginRegistry);
```
#### 使用 exports 示例
```typescript
import { plugins } from '@alilc/lowcode-engine';
import { IPublicModelPluginContext } from '@alilc/lowcode-types';
const PluginA = (ctx: IPublicModelPluginContext) => {
return {
async init() {},
exports() { return { x: 1, } },
};
}
PluginA.pluginName = 'PluginA';
const PluginB = (ctx: IPublicModelPluginContext) => {
return {
async init() {
// èŽ·å– pluginA 的导出值
console.log(ctx.plugins.PluginA.x); // => 1
},
};
}
PluginA.pluginName = 'pluginA';
PluginB.pluginName = 'PluginB';
PluginB.meta = {
dependencies: ['PluginA'],
}
await plugins.register(PluginA);
await plugins.register(PluginB);
```
> 注：ctx 是在æ’件ä¸èŽ·å–引擎 API çš„å”¯ä¸€æ¸ é“，具体定义å‚è§ [IPublicModelPluginContext](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/plugin-context.ts)
#### 设置兼容引擎版本示例
```typescript
import { plugins } from '@alilc/lowcode-engine';
import { IPublicModelPluginContext } from '@alilc/lowcode-types';
const BuiltinPluginRegistry = (ctx: IPublicModelPluginContext) => {
return {
async init() {
...
},
};
}
BuiltinPluginRegistry.pluginName = 'BuiltinPluginRegistry';
BuiltinPluginRegistry.meta = {
engines: {
lowcodeEngine: '^1.0.0', // æ’件需è¦é…åˆ ^1.0.0 的引擎æ‰å¯è¿è¡Œ
},
}
await plugins.register(BuiltinPluginRegistry);
```
#### 设置æ’件å‚数版本示例
```typescript
import { plugins } from '@alilc/lowcode-engine';
import { IPublicModelPluginContext } from '@alilc/lowcode-types';
const BuiltinPluginRegistry = (ctx: IPublicModelPluginContext, options: any) => {
return {
async init() {
// ç›´æŽ¥ä¼ å€¼æ–¹å¼ï¼š
// 通过 register(xxx, options) ä¼ å…¥
// 通过 options å–出
// 引擎åˆå§‹åŒ–时也å¯ä»¥è®¾ç½®æŸæ’件的全局é…置项：
// 通过 engine.init(..., preference) ä¼ å…¥
// 通过 ctx.preference.getValue() å–出
},
};
}
BuiltinPluginRegistry.pluginName = 'BuiltinPluginRegistry';
BuiltinPluginRegistry.meta = {
preferenceDeclaration: {
title: 'pluginA çš„å‚数定义',
properties: [
{
key: 'key1',
type: 'string',
description: 'this is description for key1',
},
{
key: 'key2',
type: 'boolean',
description: 'this is description for key2',
},
{
key: 'key3',
type: 'number',
description: 'this is description for key3',
},
{
key: 'key4',
type: 'string',
description: 'this is description for key4',
},
],
},
}
await plugins.register(BuiltinPluginRegistry, { key1: 'abc', key5: 'willNotPassToPlugin' });
```
### get
获å–指定æ’件
```typescript
/**
* 获å–指定æ’件
* get plugin instance by name
*/
get(pluginName: string): IPublicModelPluginInstance | null;
```
å…³è”模型 [IPublicModelPluginInstance](./model/plugin-instance)
### getAll
获å–所有的æ’件实例
```typescript
/**
* 获å–所有的æ’件实例
* get all plugin instances
*/
getAll(): IPublicModelPluginInstance[];
```
å…³è”模型 [IPublicModelPluginInstance](./model/plugin-instance)
### has
判æ–是å¦æœ‰æŒ‡å®šæ’件
```typescript
/**
* 判æ–是å¦æœ‰æŒ‡å®šæ’件
* check if plugin with certain name exists
*/
has(pluginName: string): boolean;
```
### delete
åˆ é™¤æŒ‡å®šæ’件
```typescript
/**
* åˆ é™¤æŒ‡å®šæ’件
* delete plugin instance by name
*/
delete(pluginName: string): void;
```
### getPluginPreference
引擎åˆå§‹åŒ–æ—¶å¯ä»¥æ供全局é…置给到å„æ’件，通过这个方法å¯ä»¥èŽ·å¾—本æ’件对应的é…ç½®
```typescript
/**
* 引擎åˆå§‹åŒ–æ—¶å¯ä»¥æ供全局é…置给到å„æ’件，通过这个方法å¯ä»¥èŽ·å¾—本æ’件对应的é…ç½®
* use this to get preference config for this plugin when engine.init() called
*/
getPluginPreference(
pluginName: string,
): Record | null | undefined;
```
## 相关类型定义
- [IPublicModelPluginContext](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/plugin-context.ts)
- [IPublicTypePluginConfig](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/plugin-config.ts)
- [IPublicModelPluginInstance](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/plugin-instance.ts)
## æ’件元数æ®å·¥ç¨‹è½¬åŒ–示例
your-plugin/package.json
```json
{
"name": "@alilc/lowcode-plugin-debug",
"lcMeta": {
"pluginName": "debug",
"meta": {
"engines": {
"lowcodeEgnine": "^1.0.0"
},
"preferenceDeclaration": { ... }
}
}
}
```
转æ¢åŽçš„结构：
```typescript
const debug = (ctx: IPublicModelPluginContext, options: any) => {
return {};
}
debug.pluginName = 'debug';
debug.meta = {
engines: {
lowcodeEgnine: '^1.51.0',
},
preferenceDeclaration: { ... }
};
```