@bpmn-nova/studio 0.3.0-preview

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/LICENSE ADDED
@@ -0,0 +1,17 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ Copyright 2026 BPMN Nova contributors
6
+
7
+ Licensed under the Apache License, Version 2.0 (the "License");
8
+ you may not use this file except in compliance with the License.
9
+ You may obtain a copy of the License at
10
+
11
+ http://www.apache.org/licenses/LICENSE-2.0
12
+
13
+ Unless required by applicable law or agreed to in writing, software
14
+ distributed under the License is distributed on an "AS IS" BASIS,
15
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ See the License for the specific language governing permissions and
17
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # @bpmn-nova/studio
2
+
3
+ BPMN Nova 的推荐聚合入口,组合流程设计器、只读 Viewer、审批轨迹、Palette、Properties 和主题。
4
+
5
+ > **English summary:** The recommended aggregate package for BPMN Nova Designer, Viewer, runtime visualization, Palette and Properties.
6
+
7
+ > 当前版本为 `0.3.0-preview`。API 与 BPMN round-trip 能力仍在稳定中,请固定 Preview 版本或使用 `preview` dist-tag。
8
+
9
+ ## 安装
10
+
11
+ ```bash
12
+ npm install @bpmn-nova/studio
13
+ ```
14
+
15
+ ```js
16
+ import '@bpmn-nova/studio/styles.css'
17
+ ```
18
+
19
+ JavaScript 不会隐式注入 CSS;只导入当前视觉包的样式入口。
20
+
21
+ ## 最小用法
22
+
23
+ ```jsx
24
+ import {
25
+ createEmptyProcess,
26
+ createStudioController,
27
+ createStudioShell,
28
+ } from '@bpmn-nova/studio'
29
+ import '@bpmn-nova/studio/styles.css'
30
+
31
+ const model = createEmptyProcess('flowable')
32
+ const studio = createStudioController({ model })
33
+ const shell = createStudioShell({ container, studio, theme: 'auto' })
34
+
35
+ const xml = studio.exportXml()
36
+ shell.destroy()
37
+ studio.destroy()
38
+ ```
39
+
40
+ ## 主要接口
41
+
42
+ - `createStudioController / BpmnStudioController`
43
+ - `createStudioShell / BpmnStudioShell`
44
+ - `BpmnCanvas 与 InteractionController`
45
+ - `ContextMenu、Template、Palette、Properties Registries`
46
+ - `Studio 聚合导出的 Core、XML、Runtime、Theme、Designer 与 Viewer API`
47
+
48
+ 参数、默认值、事件和实例方法以随包发布的 TypeScript 声明为准。
49
+
50
+ ## 文档
51
+
52
+ - [快速开始](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/GETTING-STARTED.md)
53
+ - [组件参数](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/COMPONENTS.md)
54
+ - [API](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/API.md)
55
+ - [自定义指南](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/CUSTOMIZATION.md)
56
+ - [Properties Panel](https://github.com/daxiangme/bpmn-nova/blob/dev/docs/PROPERTIES-PANEL.md)
57
+
58
+ ## License
59
+
60
+ Apache-2.0. See [LICENSE](LICENSE).