@lius1314/visual-dashboard-scaffold 1.0.0 → 1.0.1

package/README.md

@@ -36,11 +36,29 @@ npm install react react-dom
 import { App } from '@lius1314/visual-dashboard-scaffold';
 import '@lius1314/visual-dashboard-scaffold/style.css';
 
+// 默认开启编辑模式（显示编辑开关 + 配置面板）
 function MyDashboard() {
   return <App />;
 }
+
+// 仅预览，禁用编辑
+function MyDashboardReadonly() {
+  return <App editable={false} />;
+}
+
+// 允许编辑，但初始为预览模式
+function MyDashboardPreview() {
+  return <App editable={true} defaultEditMode={false} />;
+}
 ```
 
+**App 组件 Props：**
+
+| Prop | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `editable` | `boolean` | `true` | 是否显示编辑开关和配置面板 |
+| `defaultEditMode` | `boolean` | `true` | 初始是否开启编辑模式 |
+
 ### 方式二：注册自定义区块组件
 
 ```tsx

package/dist/types/App.d.ts

@@ -1,3 +1,9 @@
 import './blocks';
 import './styles/grid-override.css';
-export default function App(): import("react/jsx-runtime").JSX.Element;
+export interface AppProps {
+    /** 是否允许编辑模式，默认 true（显示编辑开关和配置面板） */
+    editable?: boolean;
+    /** 初始是否开启编辑模式，默认 true */
+    defaultEditMode?: boolean;
+}
+export default function App({ editable, defaultEditMode }?: AppProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/index.d.ts

@@ -4,6 +4,7 @@
  * 导出所有公共组件、类型、工具函数，供外部使用。
  */
 export { default as App } from './App';
+export type { AppProps } from './App';
 export { OuterContainer } from './components/OuterContainer';
 export { HeaderSection } from './components/HeaderSection';
 export { MiddleSection } from './components/MiddleSection';