king-design-analyzer 1.0.0

package/components/layoutcontent.json

@@ -0,0 +1,210 @@
+{
+    "id": "layoutcontent",
+    "name": "LayoutContent",
+    "displayName": "内容布局",
+    "category": "layout",
+    "description": "标准页面布局组件，包含头部、面包屑、内容区和可选的底部操作栏。",
+    "importStatement": "import { LayoutContent } from '@ksyun-internal/versatile';",
+    "props": [
+        {
+            "name": "title",
+            "description": "定义顶部栏标题，也可通过 headerProps.title 定义标题",
+            "type": {
+                "raw": "string",
+                "kind": "string"
+            },
+            "required": false,
+            "default": "\"\""
+        },
+        {
+            "name": "back",
+            "description": "定义顶部栏是否支持返回按钮，也可通过 headerProps.back 定义返回内容",
+            "type": {
+                "raw": "() => any | RouteLocationRaw",
+                "kind": "custom"
+            },
+            "required": false,
+            "default": "undefined"
+        },
+        {
+            "name": "headerProps",
+            "description": "定义顶部栏，Header 组件支持的属性",
+            "type": {
+                "raw": "LayoutHeaderProps",
+                "kind": "object"
+            },
+            "required": false,
+            "default": "undefined"
+        },
+        {
+            "name": "tab",
+            "description": "当前选项卡",
+            "type": {
+                "raw": "string",
+                "kind": "string"
+            },
+            "required": false,
+            "default": "\"\""
+        },
+        {
+            "name": "tabs",
+            "description": "所有选项卡数据",
+            "type": {
+                "raw": "TabItem[]",
+                "kind": "array"
+            },
+            "required": false,
+            "default": "undefined"
+        },
+        {
+            "name": "tabsProps",
+            "description": "定义 tab 栏，LayoutTabs 组件支持的属性",
+            "type": {
+                "raw": "LayoutTabsProps",
+                "kind": "object"
+            },
+            "required": false,
+            "default": "undefined"
+        },
+        {
+            "name": "newable",
+            "description": "购买链路页面样式。UI 规范要求在浏览器新的 tab 中打开",
+            "type": {
+                "raw": "boolean",
+                "kind": "boolean"
+            },
+            "required": false,
+            "default": "false"
+        },
+        {
+            "name": "scroll",
+            "description": "内容超出范围是否支持滚动条",
+            "type": {
+                "raw": "boolean",
+                "kind": "boolean"
+            },
+            "required": false,
+            "default": "false"
+        },
+        {
+            "name": "topShadow",
+            "description": "顶部固定处是否加阴影，有返回操作的默认自带阴影",
+            "type": {
+                "raw": "boolean",
+                "kind": "boolean"
+            },
+            "required": false,
+            "default": "false"
+        },
+        {
+            "name": "initialized",
+            "description": "是否初始化完成，默认初始化已完成为 true，初始化未完成时会有 loading 效果",
+            "type": {
+                "raw": "boolean",
+                "kind": "boolean"
+            },
+            "required": false,
+            "default": "true"
+        },
+        {
+            "name": "loading",
+            "description": "是否为加载中状态",
+            "type": {
+                "raw": "boolean",
+                "kind": "boolean"
+            },
+            "required": false,
+            "default": "false"
+        },
+        {
+            "name": "isHasFooter",
+            "description": "是否有底部栏，可通过此参数强制进行设置。默认根据是否有 footer、footerLeft、footerRight 扩展点判断",
+            "type": {
+                "raw": "boolean",
+                "kind": "boolean"
+            },
+            "required": false,
+            "default": "undefined"
+        },
+        {
+            "name": "breadcrumb",
+            "description": "同 Header 组件的 breadcrumb 属性一致，定义面包屑导航，数组元素为 { to: string, label: string } 格式",
+            "type": {
+                "raw": "Array<{ to: string, label: string }>",
+                "kind": "array"
+            },
+            "required": false,
+            "default": "undefined"
+        }
+    ],
+    "slots": [
+        {
+            "name": "default",
+            "description": "扩展主体内容",
+            "vueTemplate": "<LayoutContent>Content</LayoutContent>",
+            "usageExample": "<LayoutContent>...</LayoutContent>"
+        },
+        {
+            "name": "headerTitle",
+            "description": "扩展顶部栏左侧标题处内容",
+            "vueTemplate": "<template #headerTitle>...</template>",
+            "usageExample": "<LayoutContent><template #headerTitle>自定义标题</template></LayoutContent>"
+        },
+        {
+            "name": "headerTitleAppend",
+            "description": "扩展顶部栏左侧标题后面追加内容",
+            "vueTemplate": "<template #headerTitleAppend>...</template>",
+            "usageExample": "<LayoutContent><template #headerTitleAppend><Tag>标签</Tag></template></LayoutContent>"
+        },
+        {
+            "name": "headerDocPrepend",
+            "description": "扩展顶部栏右侧文档前面追加内容",
+            "vueTemplate": "<template #headerDocPrepend>...</template>",
+            "usageExample": "<LayoutContent><template #headerDocPrepend><Button>操作</Button></template></LayoutContent>"
+        },
+        {
+            "name": "headerDoc",
+            "description": "扩展顶部栏右侧文档处内容",
+            "vueTemplate": "<template #headerDoc>...</template>",
+            "usageExample": "<LayoutContent><template #headerDoc><Link>文档链接</Link></template></LayoutContent>"
+        },
+        {
+            "name": "tab",
+            "description": "扩展选项卡处内容",
+            "vueTemplate": "<template #tab>...</template>",
+            "usageExample": "<LayoutContent><template #tab><Tabs>...</Tabs></template></LayoutContent>"
+        },
+        {
+            "name": "footerLeft",
+            "description": "扩展底部栏左侧处内容",
+            "vueTemplate": "<template #footerLeft>...</template>",
+            "usageExample": "<LayoutContent><template #footerLeft><span>提示信息</span></template></LayoutContent>"
+        },
+        {
+            "name": "footerRight",
+            "description": "扩展底部栏右侧处内容",
+            "vueTemplate": "<template #footerRight>...</template>",
+            "usageExample": "<LayoutContent><template #footerRight><Button>提交</Button></template></LayoutContent>"
+        },
+        {
+            "name": "footer",
+            "description": "扩展底部栏处的整体内容，底部栏没有左右之分的时候可使用此扩展",
+            "vueTemplate": "<template #footer>...</template>",
+            "usageExample": "<LayoutContent><template #footer><Button>保存</Button><Button>取消</Button></template></LayoutContent>"
+        }
+    ],
+    "events": [],
+    "methods": [],
+    "examples": [],
+    "searchKeywords": [
+        "layout",
+        "content",
+        "page",
+        "布局"
+    ],
+    "useCases": [
+        "详情页",
+        "列表页",
+        "表单页"
+    ]
+}