@longzai-intelligence-design/layouts 0.0.0-stage → 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.
package/README.md CHANGED
@@ -1,3 +1,15 @@
1
- # Temporary Holding Version
1
+ # @longzai-intelligence-design/layouts
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Longzai Intelligence Design 的应用骨架层,提供数据驱动的应用布局成品。
4
+
5
+ ## 简介
6
+
7
+ 治理应用外壳重复搭建的问题:应用布局成品由本包统一提供,侧栏折叠、移动端形态等能力在骨架内约束,平台差异(窗口控件、拖拽区)以属性注入方式适配,消费方以数据驱动方式组装应用框架。底层复用 Base UI 适配层的侧边栏原语组合。
8
+
9
+ ## 能力
10
+
11
+ - 应用组合壳:成品侧栏 + 顶栏 + 主内容区
12
+ - 数据驱动成品侧栏:分组 / 选中项 / 选择回调
13
+ - 应用顶栏:标题与两侧内容插槽,含拖拽区
14
+ - 主内容区:语义化 main,用于简单 flex 布局
15
+ - 平台差异注入:窗口控件、拖拽区等平台属性
@@ -0,0 +1,297 @@
1
+ import { ReactElement, ReactNode } from "react";
2
+ /**
3
+ * 窗口控件(desktop 平台注入,web 不传)
4
+ *
5
+ * 由 electron renderer(preload IPC)或 electrobun renderer(RPC)提供,
6
+ * 供应用骨架渲染最小化/最大化/关闭按钮。
7
+ */
8
+ type WindowControls = {
9
+ /**
10
+ * 最小化窗口
11
+ */
12
+ minimize: () => void;
13
+ /**
14
+ * 最大化/还原窗口
15
+ */
16
+ maximize: () => void;
17
+ /**
18
+ * 关闭窗口
19
+ */
20
+ close: () => void;
21
+ /**
22
+ * 当前是否已最大化(用于切换按钮图标)
23
+ */
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 = {
34
+ /**
35
+ * 窗口控件(desktop renderer 注入,web 不传)
36
+ *
37
+ * 消费方可在 Header.rightContent 中据此渲染窗口控件按钮。
38
+ */
39
+ windowControls?: WindowControls;
40
+ /**
41
+ * 是否启用窗口拖拽区
42
+ *
43
+ * desktop(electrobun/electron)置 true,Header 渲染 data-electrobun-drag-region;
44
+ * web 置 false 或不传。
45
+ */
46
+ dragRegion?: boolean;
47
+ /**
48
+ * 导航模式
49
+ *
50
+ * browser:使用浏览器路由;ipc:使用 IPC 导航(desktop)。
51
+ */
52
+ navigationMode?: 'browser' | 'ipc';
53
+ };
54
+ /**
55
+ * 默认平台 props(web 场景)
56
+ *
57
+ * 无窗口控件、无拖拽区、浏览器导航。供 web 端消费方直接传入或作为 fallback。
58
+ */
59
+ declare const defaultPlatformProps: LayoutPlatformProps;
60
+ /**
61
+ * 导航菜单项配置
62
+ *
63
+ * 对位旧 design-system base-lyra 的 NavItem,作为数据驱动侧边栏的单项数据。
64
+ */
65
+ type NavItem = {
66
+ /**
67
+ * 唯一标识(用于选中态判断与 onSelect 回调)
68
+ */
69
+ id: string;
70
+ /**
71
+ * 显示名称(菜单项主文案)
72
+ */
73
+ label: string;
74
+ /**
75
+ * 辅助名称(可选,用于展示英文标识等次要文案)
76
+ */
77
+ name?: string;
78
+ /**
79
+ * 图标节点(可选,渲染于名称之前)
80
+ */
81
+ icon?: ReactElement;
82
+ /**
83
+ * 是否禁用(禁用项不触发 onSelect 且降低可交互性)
84
+ */
85
+ disabled?: boolean;
86
+ };
87
+ /**
88
+ * 导航分组配置
89
+ *
90
+ * 一组同属一个标题下的菜单项,用于数据驱动侧边栏的分组渲染。
91
+ */
92
+ type NavGroup = {
93
+ /**
94
+ * 分组标题(可选,不传则不渲染分组标签)
95
+ */
96
+ title?: string;
97
+ /**
98
+ * 分组内的菜单项集合
99
+ */
100
+ items: NavItem[];
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;
147
+ /**
148
+ * 侧边栏侧边(左/右)
149
+ */
150
+ type SidebarSide = 'left' | 'right';
151
+ /**
152
+ * 折叠模式
153
+ *
154
+ * - none:不可折叠(静态侧栏,对位 base-lyra 默认行为)
155
+ * - icon:折叠为图标栏(仅显示图标,悬停可见 tooltip)
156
+ * - offcanvas:抽屉式收起(完全隐藏,移动端用 Sheet)
157
+ */
158
+ type SidebarCollapsible = 'none' | 'icon' | 'offcanvas';
159
+ /**
160
+ * 导航侧边栏组件属性
161
+ */
162
+ type NavSidebarProps = {
163
+ /**
164
+ * 导航分组配置(数据驱动渲染整棵菜单)
165
+ */
166
+ groups: NavGroup[];
167
+ /**
168
+ * 当前选中的菜单项 ID(用于高亮选中态)
169
+ */
170
+ selectedId?: string;
171
+ /**
172
+ * 菜单项选择回调(点击非禁用项时触发,参数为 item.id)
173
+ */
174
+ onSelect?: (id: string) => void;
175
+ /**
176
+ * 自定义头部内容(渲染于侧栏顶部)
177
+ */
178
+ header?: ReactNode;
179
+ /**
180
+ * 自定义底部内容(渲染于侧栏底部)
181
+ */
182
+ footer?: ReactNode;
183
+ /**
184
+ * 侧边栏侧边(默认 left)
185
+ */
186
+ side?: SidebarSide;
187
+ /**
188
+ * 折叠模式(默认 none,对位 base-lyra 静态侧栏)
189
+ */
190
+ collapsible?: SidebarCollapsible;
191
+ /**
192
+ * 自定义类名(合并至 Sidebar 根元素)
193
+ */
194
+ className?: string;
195
+ };
196
+ /**
197
+ * 导航侧边栏(数据驱动成品)
198
+ *
199
+ * 接收 `groups` 数据并渲染整棵导航菜单,对位 base-lyra layouts 的 Sidebar。
200
+ * 底层复用 adapter-base-ui 的 Sidebar 原语组合(Sidebar/SidebarGroup/SidebarMenu/
201
+ * SidebarMenuButton),自动获得折叠、移动端 Sheet、cookie 持久化等能力,
202
+ * 超越 base-lyra 的简单纯成品。
203
+ *
204
+ * 必须在 SidebarProvider 内使用(由 AppLayout 自动包裹;单独使用时消费方需手动
205
+ * 包裹 SidebarProvider)。
206
+ *
207
+ * @param options - 导航侧边栏组件属性
208
+ * @returns 导航侧边栏 JSX 元素
209
+ */
210
+ declare function NavSidebar({ groups, selectedId, onSelect, header, footer, side, collapsible, className }: NavSidebarProps): import("react").JSX.Element;
211
+ /**
212
+ * 应用布局组件属性
213
+ */
214
+ type AppLayoutProps = {
215
+ /**
216
+ * 导航分组配置(透传给 NavSidebar)
217
+ */
218
+ groups: NavGroup[];
219
+ /**
220
+ * 当前选中的菜单项 ID(透传给 NavSidebar)
221
+ */
222
+ selectedId?: string;
223
+ /**
224
+ * 菜单项选择回调(透传给 NavSidebar)
225
+ */
226
+ onSelect?: (id: string) => void;
227
+ /**
228
+ * 侧边栏头部内容(透传给 NavSidebar)
229
+ */
230
+ sidebarHeader?: ReactNode;
231
+ /**
232
+ * 侧边栏底部内容(透传给 NavSidebar)
233
+ */
234
+ sidebarFooter?: ReactNode;
235
+ /**
236
+ * 折叠模式(透传给 NavSidebar,默认 none)
237
+ */
238
+ collapsible?: NavSidebarProps['collapsible'];
239
+ /**
240
+ * 顶栏配置(title/subtitle/leftContent/rightContent,dragRegion 由 platformProps 控制)
241
+ */
242
+ header?: Omit<HeaderProps, 'dragRegion'>;
243
+ /**
244
+ * 平台差异 props(dragRegion 注入顶栏拖拽区,windowControls 供消费方在 header.rightContent 渲染)
245
+ */
246
+ platformProps?: LayoutPlatformProps;
247
+ /**
248
+ * 主内容区子元素
249
+ */
250
+ children: ReactNode;
251
+ };
252
+ /**
253
+ * 应用布局组件
254
+ *
255
+ * 组合 NavSidebar + Header + 主内容区的完整应用骨架,对位 base-lyra 的 app-layout。
256
+ * 内部用 SidebarProvider 包裹(自动获得折叠、移动端 Sheet、cookie 持久化),
257
+ * 主内容区用 SidebarInset(`<main>`)配合 sidebar 的 peer 布局。
258
+ *
259
+ * 平台差异通过 platformProps 注入:dragRegion 控制顶栏拖拽区,
260
+ * windowControls 供消费方在 header.rightContent 中渲染窗口控件(符合 ADR-0048)。
261
+ *
262
+ * @param options - 应用布局组件属性
263
+ * @returns 应用布局 JSX 元素
264
+ */
265
+ declare function AppLayout({ groups, selectedId, onSelect, sidebarHeader, sidebarFooter, collapsible, header, platformProps, children }: AppLayoutProps): import("react").JSX.Element;
266
+ /**
267
+ * 主内容区组件属性
268
+ */
269
+ type MainProps = {
270
+ /**
271
+ * 子元素(页面主体内容)
272
+ */
273
+ children: ReactNode;
274
+ /**
275
+ * 自定义类名(合并至默认样式之后)
276
+ */
277
+ className?: string;
278
+ /**
279
+ * 内边距类名(Tailwind,默认 p-6)
280
+ */
281
+ padding?: string;
282
+ };
283
+ /**
284
+ * 主内容区组件
285
+ *
286
+ * 语义化 `<main>`,提供滚动容器与默认内边距。
287
+ * 对位 base-lyra layouts 的 Main,用于不依赖 SidebarInset 的简单 flex 布局
288
+ * (消费方自行 flex 组合 NavSidebar + Main 时使用)。
289
+ *
290
+ * 注意:使用 AppLayout 时无需此组件——AppLayout 内部用 SidebarInset(`<main>`)
291
+ * 承载主内容,避免 `<main>` 嵌套。
292
+ *
293
+ * @param options - 主内容区组件属性
294
+ * @returns 主内容区 JSX 元素
295
+ */
296
+ declare function Main({ children, className, padding }: MainProps): import("react").JSX.Element;
297
+ export { AppLayout, type AppLayoutProps, Header, type HeaderProps, type LayoutPlatformProps, Main, type MainProps, type NavGroup, type NavItem, NavSidebar, type NavSidebarProps, type WindowControls, defaultPlatformProps };
package/dist/index.js ADDED
@@ -0,0 +1 @@
1
+ import{Sidebar as e,SidebarContent as t,SidebarFooter as n,SidebarGroup as r,SidebarGroupLabel as i,SidebarHeader as a,SidebarInset as o,SidebarMenu as s,SidebarMenuButton as c,SidebarMenuItem as l,SidebarProvider as u}from"@longzai-intelligence-design/adapter-base-ui";import{cn as d}from"@longzai-intelligence-design/utils";import{Fragment as f,jsx as p,jsxs as m}from"react/jsx-runtime";function h({title:e,subtitle:t,leftContent:n,rightContent:r,dragRegion:i=!1,className:a,children:o}){let s=i?{"data-electrobun-drag-region":!0}:{};return/* @__PURE__ */ p(`header`,{className:d(`flex h-14 items-center justify-between border-b bg-background px-6`,a),...s,children:o??/* @__PURE__ */ m(f,{children:[/* @__PURE__ */ p(`div`,{className:`flex items-center gap-2`,...s,children:n??/* @__PURE__ */ m(f,{children:[e?/* @__PURE__ */ p(`h1`,{className:`text-lg font-semibold`,children:e}):null,t?/* @__PURE__ */ p(`span`,{className:`text-sm text-muted-foreground`,children:t}):null]})}),r?/* @__PURE__ */ p(`div`,{className:`flex items-center gap-4`,children:r}):null]})})}function g({groups:o,selectedId:u,onSelect:f,header:h,footer:g,side:_=`left`,collapsible:v=`none`,className:y}){return/* @__PURE__ */ m(e,{className:d(y),collapsible:v,side:_,children:[h?/* @__PURE__ */ p(a,{children:h}):null,/* @__PURE__ */ p(t,{children:o.map((e,t)=>/* @__PURE__ */ m(r,{children:[e.title?/* @__PURE__ */ p(i,{children:e.title}):null,/* @__PURE__ */ p(s,{children:e.items.map(e=>/* @__PURE__ */ p(l,{children:/* @__PURE__ */ m(c,{isActive:u===e.id,disabled:e.disabled,onClick:()=>{f?.(e.id)},children:[e.icon,/* @__PURE__ */ p(`span`,{children:e.label}),e.name?/* @__PURE__ */ p(`span`,{className:`ml-auto text-xs opacity-60`,children:e.name}):null]})},e.id))})]},e.title??t))}),g?/* @__PURE__ */ p(n,{children:g}):null]})}function _({groups:e,selectedId:t,onSelect:n,sidebarHeader:r,sidebarFooter:i,collapsible:a=`none`,header:s,platformProps:c,children:l}){return/* @__PURE__ */ m(u,{children:[/* @__PURE__ */ p(g,{collapsible:a,footer:i,groups:e,header:r,onSelect:n,selectedId:t}),/* @__PURE__ */ m(o,{children:[/* @__PURE__ */ p(h,{dragRegion:c?.dragRegion,...s}),/* @__PURE__ */ p(`div`,{className:`flex-1 overflow-y-auto p-6`,children:l})]})]})}function v({children:e,className:t,padding:n=`p-6`}){return/* @__PURE__ */ p(`main`,{className:d(`flex-1 overflow-y-auto`,n,t),children:e})}const y={dragRegion:!1,navigationMode:`browser`};export{_ as AppLayout,h as Header,v as Main,g as NavSidebar,y as defaultPlatformProps};
package/package.json CHANGED
@@ -1,6 +1,57 @@
1
1
  {
2
2
  "name": "@longzai-intelligence-design/layouts",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.0.6",
4
+ "description": "Longzai Intelligence Design 应用骨架层",
5
+ "keywords": [
6
+ "design",
7
+ "layouts",
8
+ "longzai-intelligence",
9
+ "shell",
10
+ "sidebar"
11
+ ],
12
+ "license": "UNLICENSED",
13
+ "files": [
14
+ "dist",
15
+ "source.css"
16
+ ],
17
+ "type": "module",
18
+ "main": "./dist/index.js",
19
+ "types": "./dist/index.d.ts",
20
+ "exports": {
21
+ ".": {
22
+ "types": "./dist/index.d.ts",
23
+ "import": "./dist/index.js"
24
+ },
25
+ "./source.css": "./source.css"
26
+ },
27
+ "scripts": {
28
+ "build": "lzi-builder",
29
+ "build:prod": "NODE_ENV=production bun run build",
30
+ "prepublishOnly": "bun run build:prod",
31
+ "typecheck": "lzi-typecheck",
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"
38
+ },
39
+ "dependencies": {
40
+ "@longzai-intelligence-design/adapter-base-ui": "0.0.6",
41
+ "@longzai-intelligence-design/utils": "0.0.6"
42
+ },
43
+ "devDependencies": {
44
+ "@testing-library/dom": "^10.4.2",
45
+ "@testing-library/jest-dom": "^7.0.1",
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"
52
+ },
53
+ "peerDependencies": {
54
+ "react": ">=18.0.0",
55
+ "react-dom": ">=18.0.0"
56
+ }
57
+ }
package/source.css ADDED
@@ -0,0 +1,2 @@
1
+ /* 消费方样式编译的扫描源自注册入口,声明本包产物为类名扫描面 */
2
+ @source './dist';