# ibiz-plugin-example

**Repository Path**: iBizModeling/ibiz-plugin-example

## Basic Information

- **Project Name**: ibiz-plugin-example
- **Description**: iBiz前端插件示例仓库
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2025-07-11
- **Last Updated**: 2026-01-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# iBiz前端插件示例仓库

该仓库是 iBiz 前端插件的示例集合，旨在为 iBiz 应用开发提供丰富的插件参考实现。仓库包含多种类型的前端插件，覆盖自填列表项、部件、计数器、实体行为、编辑器、表格、表单成员、全局替换功能、表格列、面板项、门户部件、主题、工具栏项、界面行为、界面逻辑节点及视图等多个应用场景，每种插件均配有独立的文档说明，方便开发者了解具体实现细节和使用方法。

## 插件目录

| 插件类型         | 类型标识           | 文档                                                  |
| ---------------- | ------------------ | ----------------------------------------------------- |
| 自填列表项插件   | AC_ITEM            | [文档](./packages/ac-item-plugin/README.md)           |
| 部件插件         | CUSTOM             | [文档](./packages/control-plugin/README.md)           |
| 计数器插件       | APPCOUNTER         | [文档](./packages/counter-plugin/README.md)           |
| 实体行为插件     | DEMETHOD           | [文档](./packages/de-action-plugin/README.md)         |
| 编辑器插件       | EDITOR_CUSTOMSTYLE | [文档](./packages/editor-plugin/README.md)            |
| 表格插件         | GRID_RENDER        | [文档](./packages/entity-field-grid/README.md)        |
| 表单成员插件     | FORM_USERCONTROL   | [文档](./packages/form-user-control-plugin/README.md) |
| 全局插件         | GLOBAL_APP_UTIL    | [文档](./packages/global-plugin/README.md)            |
| 表格列插件       | GRID_COLRENDER     | [文档](./packages/grid-column-plugin/README.md)       |
| 面板项插件       | CUSTOM             | [文档](./packages/panel-item-plugin/README.md)        |
| 门户部件插件     | PORTLET_CUSTOM     | [文档](./packages/portlet-plugin/README.md)           |
| 主题插件         | -                  | [文档](./packages/theme-plugin/README.md)             |
| 工具栏项插件     | TOOLBAR_ITEM       | [文档](./packages/toolbar-item-plugin/README.md)      |
| 界面行为插件     | DEUIACTION         | [文档](./packages/ui-action-plugin/README.md)         |
| 界面逻辑节点插件 | UILOGICNODE        | [文档](./packages/ui-logic-node-plugin/README.md)     |
| 视图插件         | VIEW_CUSTOM        | [文档](./packages/view-plugin/README.md)              |

## 本地开发

本地开发插件时，需要先将插件项目 link 至全局，然后在主项目中引用插件。这里以视图插件为例，介绍插件本地开发的流程。也可查看上方对应插件的 README 文档了解插件具体的内容。

1. 在插件目录下安装依赖并 link 至全局

```sh
// 安装依赖
pnpm i

// link底包
./scripts/link.sh

// 启动
pnpm dev

// link到全局
pnpm link --global
```

2. 在主项目中引用插件

```sh
// link插件
pnpm link --global '@ibiz-plugin-template/view-plugin'
```

3. 在主项目中注册插件

```ts
import { App } from 'vue';
import plugin from '@ibiz-plugin-template/view-plugin';

export default {
  install(app: App): void {
    app.use(plugin);
    // 设置本地开发需要忽略加载的插件，可填写正则或全匹配字符串。匹配插件在modeling建模平台配置的[运行时插件仓库配置]内容
    ibiz.plugin.setDevIgnore(/^@ibiz-plugin-template\/view-plugin/);
  },
};
```