@longzai-intelligence-design/layouts 0.0.4 → 0.0.6

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.
Files changed (2) hide show
  1. package/dist/index.d.ts +86 -86
  2. package/package.json +26 -24
package/dist/index.d.ts CHANGED
@@ -1,49 +1,62 @@
1
1
  import { ReactElement, ReactNode } from "react";
2
2
  /**
3
- * 应用顶栏组件属性
3
+ * 窗口控件(desktop 平台注入,web 不传)
4
+ *
5
+ * 由 electron renderer(preload IPC)或 electrobun renderer(RPC)提供,
6
+ * 供应用骨架渲染最小化/最大化/关闭按钮。
4
7
  */
5
- type HeaderProps = {
8
+ type WindowControls = {
6
9
  /**
7
- * 应用标题(leftContent 未传时渲染为主文案)
10
+ * 最小化窗口
8
11
  */
9
- title?: string;
12
+ minimize: () => void;
10
13
  /**
11
- * 副标题(渲染于标题之后的次要文案)
14
+ * 最大化/还原窗口
12
15
  */
13
- subtitle?: string;
16
+ maximize: () => void;
14
17
  /**
15
- * 左侧自定义内容(优先于 title/subtitle)
18
+ * 关闭窗口
16
19
  */
17
- leftContent?: ReactNode;
20
+ close: () => void;
18
21
  /**
19
- * 右侧自定义内容(如窗口控件、操作按钮)
22
+ * 当前是否已最大化(用于切换按钮图标)
20
23
  */
21
- rightContent?: ReactNode;
24
+ isMaximized: boolean;
25
+ };
26
+ /**
27
+ * 应用骨架平台差异 props
28
+ *
29
+ * 应用骨架组件平台无关,窗口控件、拖拽区、导航模式等平台差异通过此 props 注入,
30
+ * 符合 ADR-0048 平台无关性原则(多策略 + props 注入)。
31
+ * 替代 base-lyra 硬编码的 enableDragRegion / data-electrobun-drag-region。
32
+ */
33
+ type LayoutPlatformProps = {
22
34
  /**
23
- * 是否启用窗口拖拽区(desktop 平台注入)
35
+ * 窗口控件(desktop renderer 注入,web 不传)
24
36
  *
25
- * 替代 base-lyra 的 enableDragRegion;由 LayoutPlatformProps.dragRegion 传入。
37
+ * 消费方可在 Header.rightContent 中据此渲染窗口控件按钮。
26
38
  */
27
- dragRegion?: boolean;
39
+ windowControls?: WindowControls;
28
40
  /**
29
- * 自定义类名(合并至默认样式之后)
41
+ * 是否启用窗口拖拽区
42
+ *
43
+ * desktop(electrobun/electron)置 true,Header 渲染 data-electrobun-drag-region;
44
+ * web 置 false 或不传。
30
45
  */
31
- className?: string;
46
+ dragRegion?: boolean;
32
47
  /**
33
- * 子元素(优先于 leftContent/rightContent 双栏布局,完全自定义顶栏内容)
48
+ * 导航模式
49
+ *
50
+ * browser:使用浏览器路由;ipc:使用 IPC 导航(desktop)。
34
51
  */
35
- children?: ReactNode;
52
+ navigationMode?: 'browser' | 'ipc';
36
53
  };
37
54
  /**
38
- * 应用顶栏组件
39
- *
40
- * 提供标题与左右内容栏的双栏布局。拖拽区通过 dragRegion 注入(平台无关),
41
- * 替代 base-lyra 硬编码的 Electrobun 拖拽属性,符合 ADR-0048 平台无关性原则。
55
+ * 默认平台 props(web 场景)
42
56
  *
43
- * @param options - 顶栏组件属性
44
- * @returns 顶栏 JSX 元素
57
+ * 无窗口控件、无拖拽区、浏览器导航。供 web 端消费方直接传入或作为 fallback。
45
58
  */
46
- declare function Header({ title, subtitle, leftContent, rightContent, dragRegion, className, children }: HeaderProps): import("react").JSX.Element;
59
+ declare const defaultPlatformProps: LayoutPlatformProps;
47
60
  /**
48
61
  * 导航菜单项配置
49
62
  *
@@ -86,10 +99,55 @@ type NavGroup = {
86
99
  */
87
100
  items: NavItem[];
88
101
  };
102
+ /**
103
+ * 应用顶栏组件属性
104
+ */
105
+ type HeaderProps = {
106
+ /**
107
+ * 应用标题(leftContent 未传时渲染为主文案)
108
+ */
109
+ title?: string;
110
+ /**
111
+ * 副标题(渲染于标题之后的次要文案)
112
+ */
113
+ subtitle?: string;
114
+ /**
115
+ * 左侧自定义内容(优先于 title/subtitle)
116
+ */
117
+ leftContent?: ReactNode;
118
+ /**
119
+ * 右侧自定义内容(如窗口控件、操作按钮)
120
+ */
121
+ rightContent?: ReactNode;
122
+ /**
123
+ * 是否启用窗口拖拽区(desktop 平台注入)
124
+ *
125
+ * 替代 base-lyra 的 enableDragRegion;由 LayoutPlatformProps.dragRegion 传入。
126
+ */
127
+ dragRegion?: boolean;
128
+ /**
129
+ * 自定义类名(合并至默认样式之后)
130
+ */
131
+ className?: string;
132
+ /**
133
+ * 子元素(优先于 leftContent/rightContent 双栏布局,完全自定义顶栏内容)
134
+ */
135
+ children?: ReactNode;
136
+ };
137
+ /**
138
+ * 应用顶栏组件
139
+ *
140
+ * 提供标题与左右内容栏的双栏布局。拖拽区通过 dragRegion 注入(平台无关),
141
+ * 替代 base-lyra 硬编码的 Electrobun 拖拽属性,符合 ADR-0048 平台无关性原则。
142
+ *
143
+ * @param options - 顶栏组件属性
144
+ * @returns 顶栏 JSX 元素
145
+ */
146
+ declare function Header({ title, subtitle, leftContent, rightContent, dragRegion, className, children }: HeaderProps): import("react").JSX.Element;
89
147
  /**
90
148
  * 侧边栏侧边(左/右)
91
149
  */
92
- type SidebarSide = "left" | "right";
150
+ type SidebarSide = 'left' | 'right';
93
151
  /**
94
152
  * 折叠模式
95
153
  *
@@ -97,7 +155,7 @@ type SidebarSide = "left" | "right";
97
155
  * - icon:折叠为图标栏(仅显示图标,悬停可见 tooltip)
98
156
  * - offcanvas:抽屉式收起(完全隐藏,移动端用 Sheet)
99
157
  */
100
- type SidebarCollapsible = "none" | "icon" | "offcanvas";
158
+ type SidebarCollapsible = 'none' | 'icon' | 'offcanvas';
101
159
  /**
102
160
  * 导航侧边栏组件属性
103
161
  */
@@ -150,64 +208,6 @@ type NavSidebarProps = {
150
208
  * @returns 导航侧边栏 JSX 元素
151
209
  */
152
210
  declare function NavSidebar({ groups, selectedId, onSelect, header, footer, side, collapsible, className }: NavSidebarProps): import("react").JSX.Element;
153
- /**
154
- * 窗口控件(desktop 平台注入,web 不传)
155
- *
156
- * 由 electron renderer(preload IPC)或 electrobun renderer(RPC)提供,
157
- * 供应用骨架渲染最小化/最大化/关闭按钮。
158
- */
159
- type WindowControls = {
160
- /**
161
- * 最小化窗口
162
- */
163
- minimize: () => void;
164
- /**
165
- * 最大化/还原窗口
166
- */
167
- maximize: () => void;
168
- /**
169
- * 关闭窗口
170
- */
171
- close: () => void;
172
- /**
173
- * 当前是否已最大化(用于切换按钮图标)
174
- */
175
- isMaximized: boolean;
176
- };
177
- /**
178
- * 应用骨架平台差异 props
179
- *
180
- * 应用骨架组件平台无关,窗口控件、拖拽区、导航模式等平台差异通过此 props 注入,
181
- * 符合 ADR-0048 平台无关性原则(多策略 + props 注入)。
182
- * 替代 base-lyra 硬编码的 enableDragRegion / data-electrobun-drag-region。
183
- */
184
- type LayoutPlatformProps = {
185
- /**
186
- * 窗口控件(desktop renderer 注入,web 不传)
187
- *
188
- * 消费方可在 Header.rightContent 中据此渲染窗口控件按钮。
189
- */
190
- windowControls?: WindowControls;
191
- /**
192
- * 是否启用窗口拖拽区
193
- *
194
- * desktop(electrobun/electron)置 true,Header 渲染 data-electrobun-drag-region;
195
- * web 置 false 或不传。
196
- */
197
- dragRegion?: boolean;
198
- /**
199
- * 导航模式
200
- *
201
- * browser:使用浏览器路由;ipc:使用 IPC 导航(desktop)。
202
- */
203
- navigationMode?: "browser" | "ipc";
204
- };
205
- /**
206
- * 默认平台 props(web 场景)
207
- *
208
- * 无窗口控件、无拖拽区、浏览器导航。供 web 端消费方直接传入或作为 fallback。
209
- */
210
- declare const defaultPlatformProps: LayoutPlatformProps;
211
211
  /**
212
212
  * 应用布局组件属性
213
213
  */
@@ -235,11 +235,11 @@ type AppLayoutProps = {
235
235
  /**
236
236
  * 折叠模式(透传给 NavSidebar,默认 none)
237
237
  */
238
- collapsible?: NavSidebarProps["collapsible"];
238
+ collapsible?: NavSidebarProps['collapsible'];
239
239
  /**
240
240
  * 顶栏配置(title/subtitle/leftContent/rightContent,dragRegion 由 platformProps 控制)
241
241
  */
242
- header?: Omit<HeaderProps, "dragRegion">;
242
+ header?: Omit<HeaderProps, 'dragRegion'>;
243
243
  /**
244
244
  * 平台差异 props(dragRegion 注入顶栏拖拽区,windowControls 供消费方在 header.rightContent 渲染)
245
245
  */
package/package.json CHANGED
@@ -1,14 +1,19 @@
1
1
  {
2
2
  "name": "@longzai-intelligence-design/layouts",
3
- "version": "0.0.4",
3
+ "version": "0.0.6",
4
4
  "description": "Longzai Intelligence Design 应用骨架层",
5
5
  "keywords": [
6
- "longzai-intelligence",
7
6
  "design",
8
7
  "layouts",
8
+ "longzai-intelligence",
9
9
  "shell",
10
10
  "sidebar"
11
11
  ],
12
+ "license": "UNLICENSED",
13
+ "files": [
14
+ "dist",
15
+ "source.css"
16
+ ],
12
17
  "type": "module",
13
18
  "main": "./dist/index.js",
14
19
  "types": "./dist/index.d.ts",
@@ -19,37 +24,34 @@
19
24
  },
20
25
  "./source.css": "./source.css"
21
26
  },
22
- "files": [
23
- "dist",
24
- "source.css"
25
- ],
26
27
  "scripts": {
27
28
  "build": "lzi-builder",
28
29
  "build:prod": "NODE_ENV=production bun run build",
29
30
  "prepublishOnly": "bun run build:prod",
30
- "dev": "lzi-builder --watch",
31
31
  "typecheck": "lzi-typecheck",
32
- "clean": "lzi-dev-cli clean",
33
- "test": "vitest run --passWithNoTests",
34
- "test:watch": "vitest"
35
- },
36
- "peerDependencies": {
37
- "react": ">=18.0.0",
38
- "react-dom": ">=18.0.0"
32
+ "lint": "lzi-lint lint",
33
+ "lint:fix": "lzi-lint fix",
34
+ "test": "lzi-bun test",
35
+ "test:watch": "lzi-bun test --watch",
36
+ "test:coverage": "lzi-bun test --coverage",
37
+ "clean": "lzi-dev-tools clean"
39
38
  },
40
39
  "dependencies": {
41
- "@longzai-intelligence-design/adapter-base-ui": "0.0.4",
42
- "@longzai-intelligence-design/utils": "0.0.4"
40
+ "@longzai-intelligence-design/adapter-base-ui": "0.0.6",
41
+ "@longzai-intelligence-design/utils": "0.0.6"
43
42
  },
44
43
  "devDependencies": {
45
- "@testing-library/dom": "^10.4.1",
44
+ "@testing-library/dom": "^10.4.2",
46
45
  "@testing-library/jest-dom": "^7.0.1",
47
- "@testing-library/react": "^16.3.2",
48
- "@types/react": "^19.2.14",
49
- "@types/react-dom": "^19.2.3",
50
- "jsdom": "^30.0.1",
51
- "react": "^19.2.5",
52
- "react-dom": "^19.2.5"
46
+ "@testing-library/react": "^16.3.3",
47
+ "@types/react": "^19.3.0",
48
+ "@types/react-dom": "^19.3.0",
49
+ "jsdom": "^30.1.3",
50
+ "react": "^19.3.1",
51
+ "react-dom": "^19.3.1"
53
52
  },
54
- "license": "UNLICENSED"
53
+ "peerDependencies": {
54
+ "react": ">=18.0.0",
55
+ "react-dom": ">=18.0.0"
56
+ }
55
57
  }