Translation in progress
This page hasn't been translated into English yet, so the content below is in Chinese. The code examples work the same way.
Result 结果
用一个大图标、标题和说明告诉用户操作的结果,常用在提交成功、支付失败、权限不足这类整页反馈里。
引入
ts
import { NsResult } from '@ns/ui'
基础用法
status 决定图标和图标颜色,title、subtitle 是标题和说明文字。
vue
<script setup lang="ts">
import { NsResult } from '@ns/ui'
</script>
<template>
<NsResult status="success" title="操作成功" subtitle="您的请求已成功处理,请继续下一步操作" />
</template>
四种状态
status 有 success、error、warning、info 四种,默认 info。图标颜色分别是成功色、危险色、警告色和信息色。
vue
<template>
<div class="grid">
<NsResult status="success" title="成功(success)" subtitle="操作已完成" />
<NsResult status="error" title="错误(error)" subtitle="操作失败" />
<NsResult status="warning" title="警告(warning)" subtitle="请注意风险" />
<NsResult status="info" title="信息(info)" subtitle="普通提示" />
</div>
</template>
<style scoped>
.grid {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(220px, 1fr));
gap: var(--ns-spacing-4);
}
</style>
不写 status 时和 info 一样:
vue
<template>
<NsResult title="没有设置 status" subtitle="显示信息图标和信息色" />
</template>
操作区
extra 插槽放在说明文字下面,一般放返回、重试这类按钮。
vue
<script setup lang="ts">
import { NsButton, NsMessage, NsResult, NsSpace } from '@ns/ui'
const goHome = () => {
NsMessage('回到首页')
}
const viewDetail = () => {
NsMessage('打开审核进度')
}
</script>
<template>
<NsResult status="success" title="提交成功" subtitle="请等待审核,审核结果将通过邮件通知您">
<template #extra>
<NsSpace wrap>
<NsButton type="primary" @click="goHome">返回首页</NsButton>
<NsButton @click="viewDetail">查看进度</NsButton>
</NsSpace>
</template>
</NsResult>
</template>
切换状态
同一个结果页按接口返回切换状态,标题、说明和操作按钮跟着变。点上面的选项切换:
vue
<script setup lang="ts">
import { computed, ref } from 'vue'
import { NsButton, NsMessage, NsRadio, NsRadioGroup, NsResult, NsSpace } from '@ns/ui'
import type { ResultStatus } from '@ns/ui'
const status = ref<ResultStatus>('success')
const contents: Record<ResultStatus, { title: string; subtitle: string; action: string }> = {
success: { title: '支付成功', subtitle: '订单已支付,预计 3 天内发货', action: '查看订单' },
error: { title: '支付失败', subtitle: '银行卡余额不足,请更换支付方式', action: '重新支付' },
warning: {
title: '订单待确认',
subtitle: '部分商品库存紧张,请确认是否继续',
action: '继续下单'
},
info: { title: '订单处理中', subtitle: '支付结果确认中,请稍后刷新查看', action: '刷新' }
}
const content = computed(() => contents[status.value])
const handleAction = () => {
NsMessage(`点了“${content.value.action}”`)
}
</script>
<template>
<NsSpace direction="vertical" fill>
<div>
<NsRadioGroup v-model="status" type="button">
<NsRadio value="success" label="success" />
<NsRadio value="error" label="error" />
<NsRadio value="warning" label="warning" />
<NsRadio value="info" label="info" />
</NsRadioGroup>
</div>
<NsResult :status="status" :title="content.title" :subtitle="content.subtitle">
<template #extra>
<NsButton type="primary" @click="handleAction">{{ content.action }}</NsButton>
</template>
</NsResult>
</NsSpace>
</template>
自定义图标
icon 插槽替换默认图标。插槽里放的 NsIcon 默认也是 72px,颜色跟随当前状态,也可以自己写 style 覆盖。
vue
<script setup lang="ts">
import { NsIcon, NsResult } from '@ns/ui'
</script>
<template>
<NsResult title="自定义图标" subtitle="通过 icon 插槽替换默认图标">
<template #icon>
<NsIcon name="star" style="color: var(--ns-color-warning)" />
</template>
</NsResult>
</template>
下面左边没写颜色,图标跟随 status="success" 用成功色;右边在图标上写了颜色,不受状态影响:
vue
<template>
<div class="grid">
<NsResult status="success" title="跟随状态的颜色" subtitle="status 是 success">
<template #icon>
<NsIcon name="mail" />
</template>
</NsResult>
<NsResult status="success" title="自己写的颜色" subtitle="status 是 success">
<template #icon>
<NsIcon name="lock" color="var(--ns-color-help)" />
</template>
</NsResult>
</div>
</template>
<style scoped>
.grid {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(220px, 1fr));
gap: var(--ns-spacing-4);
}
</style>
自定义标题和说明
title、subtitle 插槽可以放带格式的内容,优先于同名属性。
vue
<template>
<NsResult status="error">
<template #title>支付失败</template>
<template #subtitle> 订单号 <strong>20261117001</strong> 支付超时,请重新下单 </template>
</NsResult>
</template>
放在卡片里
组件只负责居中排版,没有背景和边框。放进卡片或带背景的容器里,就是一块局部的结果提示:
vue
<script setup lang="ts">
import { NsButton, NsCard, NsResult } from '@ns/ui'
</script>
<template>
<NsCard>
<NsResult status="warning" title="没有访问权限" subtitle="请联系管理员开通“财务报表”的查看权限">
<template #extra>
<NsButton type="primary">申请权限</NsButton>
</template>
</NsResult>
</NsCard>
</template>
Props
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| status | 'success' | 'error' | 'warning' | 'info' | 'info' | 结果状态,决定图标和图标颜色 |
| title | string | '' | 标题,为空且没有标题插槽时不渲染 |
| subtitle | string | '' | 说明文字,为空且没有插槽时不渲染 |
Slots
| 插槽 | 说明 |
|---|---|
| icon | 自定义图标,替换默认的状态图标 |
| title | 自定义标题,优先于 title 属性 |
| subtitle | 自定义说明文字,优先于 subtitle 属性 |
| extra | 操作区,放在说明文字下面 |
类型
ts
import type { ResultStatus, ResultProps } from '@ns/ui'
type ResultStatus = 'success' | 'error' | 'warning' | 'info'
interface ResultProps {
status?: ResultStatus
title?: string
subtitle?: string
}
注意事项
- 主图标是 72px。
icon插槽里放的NsIcon会被同一条样式设成 72px;放其他元素时大小由你自己决定。 - 图标颜色写在
.ns-result__icon上,插槽里的内容默认继承这个颜色。 extra插槽没有内容时不渲染操作区。- 组件只负责居中排版,没有背景和边框,外层容器的高度、背景需要自己设置。
优化点
- [ ] 支持更多状态类型(如 403、404、500 插画)
- [ ] 支持结果动画效果
- [ ] 支持结果页面模板