@framework-m/plugin-sdk 0.2.3 → 0.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +38 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# @framework-m/plugin-sdk
|
|
2
|
+
|
|
3
|
+
Plugin infrastructure and runtime for Framework M multi-app composition.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @framework-m/plugin-sdk
|
|
9
|
+
|
|
10
|
+
# With pnpm
|
|
11
|
+
pnpm add @framework-m/plugin-sdk
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Core Concepts
|
|
15
|
+
|
|
16
|
+
- **Multi-App Composition**: Bundle multiple independent apps into a single unified interface.
|
|
17
|
+
- **Plugin Lifecycle**: Standardized registration and initialization for frontend extensions.
|
|
18
|
+
- **Shared Context**: Access to host application state and APIs from within plugins.
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import { definePlugin } from "@framework-m/plugin-sdk";
|
|
24
|
+
|
|
25
|
+
export default definePlugin({
|
|
26
|
+
name: "my-plugin",
|
|
27
|
+
setup(api) {
|
|
28
|
+
api.addMenuItem({
|
|
29
|
+
path: "/my-page",
|
|
30
|
+
label: "My Plugin Page",
|
|
31
|
+
});
|
|
32
|
+
},
|
|
33
|
+
});
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## License
|
|
37
|
+
|
|
38
|
+
Apache-2.0
|