@framework-m/desk 0.4.6 → 0.5.1
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/dist/components/layout/FrameworkMShell.d.ts +25 -0
- package/dist/components/layout/FrameworkMShell.d.ts.map +1 -0
- package/dist/components/layout/Navbar/Navbar.d.ts +16 -0
- package/dist/components/layout/Navbar/Navbar.d.ts.map +1 -0
- package/dist/components/layout/Sidebar/Sidebar.d.ts +25 -0
- package/dist/components/layout/Sidebar/Sidebar.d.ts.map +1 -0
- package/dist/components/layout/index.d.ts +15 -2
- package/dist/components/layout/index.d.ts.map +1 -1
- package/dist/desk.css +1 -0
- package/dist/hooks/useShell.d.ts +3 -0
- package/dist/hooks/useShell.d.ts.map +1 -0
- package/dist/index.d.ts +10 -14
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5733 -2430
- package/dist/index.js.map +1 -1
- package/dist/pages/ListView.d.ts.map +1 -1
- package/dist/pages/LoginPage.d.ts +1 -17
- package/dist/pages/LoginPage.d.ts.map +1 -1
- package/dist/shell/ShellProvider.d.ts +11 -0
- package/dist/shell/ShellProvider.d.ts.map +1 -0
- package/dist/shell/context.d.ts +3 -0
- package/dist/shell/context.d.ts.map +1 -0
- package/dist/shell/realtime.d.ts +9 -0
- package/dist/shell/realtime.d.ts.map +1 -0
- package/dist/shell/types.d.ts +40 -0
- package/dist/shell/types.d.ts.map +1 -0
- package/package.json +15 -9
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { default as React, ReactNode } from 'react';
|
|
2
|
+
import { FrameworkMPlugin } from '@framework-m/plugin-sdk';
|
|
3
|
+
export interface FrameworkMShellProps {
|
|
4
|
+
/** Application title for the Navbar */
|
|
5
|
+
title: string;
|
|
6
|
+
/** Primary content to render inside the main layout */
|
|
7
|
+
children?: ReactNode;
|
|
8
|
+
/** Optional plugins to initialize the shell with */
|
|
9
|
+
initialPlugins?: FrameworkMPlugin[];
|
|
10
|
+
/** Optional custom Sidebar component */
|
|
11
|
+
sidebar?: ReactNode;
|
|
12
|
+
/** Optional custom Navbar component */
|
|
13
|
+
navbar?: ReactNode;
|
|
14
|
+
/** Whether focus mode is enabled by default */
|
|
15
|
+
defaultFocusMode?: boolean;
|
|
16
|
+
/** Optional custom login page */
|
|
17
|
+
loginPage?: ReactNode;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* FrameworkMShell
|
|
21
|
+
*
|
|
22
|
+
* The standard high-level container for Framework M applications.
|
|
23
|
+
*/
|
|
24
|
+
export declare const FrameworkMShell: React.FC<FrameworkMShellProps>;
|
|
25
|
+
//# sourceMappingURL=FrameworkMShell.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FrameworkMShell.d.ts","sourceRoot":"","sources":["../../../src/components/layout/FrameworkMShell.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAY,MAAM,OAAO,CAAC;AASnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAY3D,MAAM,WAAW,oBAAoB;IACnC,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,oDAAoD;IACpD,cAAc,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACpC,wCAAwC;IACxC,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,uCAAuC;IACvC,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,+CAA+C;IAC/C,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iCAAiC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAmDD;;;;GAIG;AACH,eAAO,MAAM,eAAe,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CA4K1D,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Navbar props
|
|
3
|
+
*/
|
|
4
|
+
export interface NavbarProps {
|
|
5
|
+
/** App title */
|
|
6
|
+
title?: string;
|
|
7
|
+
/** Logo URL */
|
|
8
|
+
logo?: string;
|
|
9
|
+
/** Whether to show global search */
|
|
10
|
+
showSearch?: boolean;
|
|
11
|
+
/** Optional callback to toggle mobile menu */
|
|
12
|
+
onMenuToggle?: () => void;
|
|
13
|
+
}
|
|
14
|
+
export declare function Navbar({ title, logo, showSearch, onMenuToggle, }: Readonly<NavbarProps>): import("react/jsx-runtime").JSX.Element;
|
|
15
|
+
export default Navbar;
|
|
16
|
+
//# sourceMappingURL=Navbar.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Navbar.d.ts","sourceRoot":"","sources":["../../../../src/components/layout/Navbar/Navbar.tsx"],"names":[],"mappings":"AAoBA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,8CAA8C;IAC9C,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B;AAwKD,wBAAgB,MAAM,CAAC,EACrB,KAAqB,EACrB,IAAI,EACJ,UAAiB,EACjB,YAAY,GACb,EAAE,QAAQ,CAAC,WAAW,CAAC,2CAsevB;AAED,eAAe,MAAM,CAAC"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
interface MenuSourceItem {
|
|
2
|
+
name: string;
|
|
3
|
+
label?: string;
|
|
4
|
+
icon?: string;
|
|
5
|
+
route?: string;
|
|
6
|
+
module?: string;
|
|
7
|
+
parent?: string;
|
|
8
|
+
}
|
|
9
|
+
interface MenuItem extends MenuSourceItem {
|
|
10
|
+
children?: MenuItem[];
|
|
11
|
+
}
|
|
12
|
+
export interface SidebarProps {
|
|
13
|
+
collapsed?: boolean;
|
|
14
|
+
onCollapse?: (collapsed: boolean) => void;
|
|
15
|
+
menuItems?: MenuItem[];
|
|
16
|
+
/** Whether the current viewport is mobile */
|
|
17
|
+
isMobile?: boolean;
|
|
18
|
+
/** Whether the mobile drawer is open */
|
|
19
|
+
mobileOpen?: boolean;
|
|
20
|
+
/** Callback to close the mobile drawer */
|
|
21
|
+
onCloseMobile?: () => void;
|
|
22
|
+
}
|
|
23
|
+
export declare function Sidebar({ collapsed, onCollapse, isMobile, mobileOpen, onCloseMobile, }: Readonly<SidebarProps>): import("react/jsx-runtime").JSX.Element;
|
|
24
|
+
export {};
|
|
25
|
+
//# sourceMappingURL=Sidebar.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Sidebar.d.ts","sourceRoot":"","sources":["../../../../src/components/layout/Sidebar/Sidebar.tsx"],"names":[],"mappings":"AAaA,UAAU,cAAc;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,QAAS,SAAQ,cAAc;IACvC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;CACvB;AA+BD,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IAC1C,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,wCAAwC;IACxC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED,wBAAgB,OAAO,CAAC,EACtB,SAAiB,EACjB,UAAU,EACV,QAAgB,EAChB,UAAkB,EAClB,aAAa,GACd,EAAE,QAAQ,CAAC,YAAY,CAAC,2CA8PxB"}
|
|
@@ -1,3 +1,16 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export
|
|
1
|
+
import { default as React, ReactNode } from 'react';
|
|
2
|
+
export interface LayoutProps {
|
|
3
|
+
/** Sidebar component or slot */
|
|
4
|
+
sidebar: ReactNode;
|
|
5
|
+
/** Navbar component or slot */
|
|
6
|
+
navbar: ReactNode;
|
|
7
|
+
/** Primary content */
|
|
8
|
+
children: ReactNode;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Standard Framework M Desk Layout
|
|
12
|
+
*
|
|
13
|
+
* Provides a responsive structure for the sidebar, navbar, and main content area.
|
|
14
|
+
*/
|
|
15
|
+
export declare const Layout: React.FC<LayoutProps>;
|
|
3
16
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/layout/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/layout/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEzC,MAAM,WAAW,WAAW;IAC1B,gCAAgC;IAChC,OAAO,EAAE,SAAS,CAAC;IACnB,+BAA+B;IAC/B,MAAM,EAAE,SAAS,CAAC;IAClB,sBAAsB;IACtB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;GAIG;AACH,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAgBxC,CAAC"}
|
package/dist/desk.css
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.shell-header{display:flex!important;flex-direction:row!important;align-items:center!important;justify-content:space-between!important;width:100%!important;padding:0 24px!important;height:56px!important;background-color:var(--color-bg)!important;border-bottom:1px solid var(--color-border)!important}.shell-breadcrumbs{display:flex!important;flex-direction:row!important;align-items:center!important;gap:16px!important;list-style:none!important;margin:0!important;padding:0!important}.shell-breadcrumb-item{display:flex!important;flex-direction:row!important;align-items:center!important;gap:8px!important}.shell-nav-actions{display:flex!important;flex-direction:row!important;align-items:center!important;gap:20px!important}.shell-view-switcher{display:flex!important;flex-direction:row!important;align-items:center!important;gap:8px!important;padding:4px 8px!important;border-radius:999px!important;background-color:#00000008!important}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useShell.d.ts","sourceRoot":"","sources":["../../src/hooks/useShell.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAExD,wBAAgB,QAAQ,IAAI,iBAAiB,CAM5C"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,17 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @framework-m/desk
|
|
3
|
-
*
|
|
4
|
-
* Business components, hooks, views, and providers for Framework M applications.
|
|
5
|
-
*
|
|
6
|
-
* This package provides everything a plugin or shell app needs to build
|
|
7
|
-
* DocType-aware UIs: forms, tables, views, workflow actions, config system,
|
|
8
|
-
* and Refine data/auth/live providers.
|
|
9
|
-
*
|
|
10
|
-
* @example
|
|
11
|
-
* ```tsx
|
|
12
|
-
* import { AutoForm, AutoTable, useDocTypeMeta, frameworkMDataProvider } from "@framework-m/desk";
|
|
13
|
-
* ```
|
|
14
|
-
*/
|
|
15
1
|
export { frameworkMDataProvider } from './data';
|
|
16
2
|
export { authProvider } from './auth';
|
|
17
3
|
export { liveProvider, closeAllConnections } from './live';
|
|
@@ -65,4 +51,14 @@ export { default as FormView } from './pages/FormView';
|
|
|
65
51
|
export { default as LoginPage } from './pages/LoginPage';
|
|
66
52
|
export { getAuthConfig } from './authConfig';
|
|
67
53
|
export type { AuthConfig, AuthStrategy, OIDCConfig } from './authConfig';
|
|
54
|
+
export { ShellProvider } from './shell/ShellProvider';
|
|
55
|
+
export { ShellContext } from './shell/context';
|
|
56
|
+
export { createWebSocketRealtimeAdapter } from './shell/realtime';
|
|
57
|
+
export { useShell } from './hooks/useShell';
|
|
58
|
+
export { Sidebar } from './components/layout/Sidebar/Sidebar';
|
|
59
|
+
export { Navbar } from './components/layout/Navbar/Navbar';
|
|
60
|
+
export { FrameworkMShell } from './components/layout/FrameworkMShell';
|
|
61
|
+
export type { SidebarProps } from './components/layout/Sidebar/Sidebar';
|
|
62
|
+
export type { NavbarProps } from './components/layout/Navbar/Navbar';
|
|
63
|
+
export type { ShellSection, OmniSearchResult, RealtimeMessage, RealtimeSubscriber, RealtimeAdapter, OmniSearchProvider, ShellContextValue, } from './shell/types';
|
|
68
64
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAGH,OAAO,YAAY,CAAC;AAMpB,OAAO,EAAE,sBAAsB,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAExD,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,SAAS,GACV,MAAM,SAAS,CAAC;AAOjB,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC/E,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAGvD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGlD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAGnD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAG7D,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACnE,YAAY,EACV,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAM7C,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AACjE,YAAY,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAEpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAC7C,YAAY,EACV,wBAAwB,EACxB,cAAc,EACd,aAAa,GACd,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,WAAW,GACZ,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,YAAY,EACV,qBAAqB,EACrB,oBAAoB,EACpB,QAAQ,GACT,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAEvD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,YAAY,EACV,WAAW,EACX,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,kBAAkB,GACnB,MAAM,SAAS,CAAC;AAMjB,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,YAAY,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,YAAY,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,eAAe,EACf,eAAe,GAChB,MAAM,SAAS,CAAC;AAEjB,YAAY,EACV,QAAQ,EACR,SAAS,EACT,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,WAAW,EACX,UAAU,GACX,MAAM,SAAS,CAAC;AAMjB,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,YAAY,GACb,MAAM,UAAU,CAAC;AAElB,OAAO,EACL,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,GACf,MAAM,UAAU,CAAC;AAElB,YAAY,EACV,aAAa,EACb,UAAU,EACV,UAAU,EACV,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,mBAAmB,GACpB,MAAM,UAAU,CAAC;AAMlB,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAMjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAM/C,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAMzD,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAKzE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,qCAAqC,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,YAAY,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AACxE,YAAY,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AACrE,YAAY,EACV,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,eAAe,CAAC"}
|