McrbHttpClient.empty空状态组件
空状态组件用于在页面、区块或列表等数据容器中没有内容显示时,给予用户明确的视觉反馈和操作引导。避免用户产生“页面出错”或“加载卡死”的误解,并可通过内置按钮或链接引导用户进行下一步操作。 特色机制:组件内置了“图片优先加载,失败自动降级为 SVG”的机制。即使服务器上的空状态切图丢失或路径错误,也能自动降级显示内置的精美 SVG 矢量图标,保证组件永远有优雅的视觉呈现。
1.快速开始
// 首先需要在页面上准备一个承载空状态的 DOM 容器:
<div id="emptyBox"></div>
// 使用 McrbHttpClient.empty 实例化并渲染:
// 1. 初始化实例
var emptyIns = McrbHttpClient.empty({id: 'emptyBox',type: 'nodata',title: '暂无数据',description: '当前列表还没有任何数据'});
// 2. 渲染到页面
emptyIns.render();
2.配置项(options)说明:
| 参数名 | 类型 | 默认值 | 必填 | 说明 |
id | String | '' | 是 | 装载空状态内容的 DOM 容器 ID。 |
type | String | 'default' | 否 | 空状态类型,决定了默认图标和样式语义。 可选值:
|
image | String | '' | 否 | 自定义图片的绝对/相对路径。仅当 type: 'custom' 时生效。 |
title | String | '暂无数据' | 否 | 空状态的主标题。支持 HTML 标签(如加粗、换行)。 |
description | String | '' | 否 | 空状态的补充说明。支持 HTML。 |
showAction | Boolean | false | 否 | 是否显示操作按钮。 |
actionText | String | '去添加' | 否 | 操作按钮的文案。 |
actionCallback | Function | null | 否 | 操作按钮点击的回调函数。回调参数:(event, instance)。 |
showLink | Boolean | false | 否 | 是否显示文字链接。 |
linkText | String | '' | 否 | 文字链接的文案。 |
linkHref | String | '' | 否 | 文字链接的跳转地址。 |
imageSize | String | '120px' | 否 | 图标/图片的宽高尺寸(正方形)。 |
minHeight | String | '300px' | 否 | 容器的最小高度,用于撑开视觉空间。 |
bgColor | String | 'transparent' | 否 | 容器的背景颜色。 |
children | HTMLElement | null | 否 | 直接传入一段自定义的 DOM 节点。优先级最高,如果传入该参数, 将忽略 |
3.API 方法
实例化后的对象支持以下方法:
render()
将空状态渲染到指定 ID 的容器中。
返回:当前实例对象(支持链式调用)。
update(newOptions)
动态更新空状态的配置并重新渲染。常用于场景切换(例如:从“无数据”变更为“搜索无结果”)。
参数:newOptions (Object) 需要局部更新的配置项。
返回:当前实例对象。
destroy()
销毁空状态。清空容器内的 HTML,并移除组件附加的样式和高度限制,恢复容器原状。
4.常见使用场景与示例
https://mhc.ixiera.com/html/componentDemo/demo_emptyState.html
扫一扫