Appearance
xtf-notice-bar
组件说明
xtf-notice-bar 是通知栏,用于滚动或静态展示重要通知内容。当前实现通过 click 等事件反馈交互。
- 实际 Demo 路由:
#/pages/components/xtf-notice-bar/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfNoticeBar text="示例内容" />
</view>
</template>
<script setup lang="uts">
import XtfNoticeBar from "@/uni_modules/xtf-linkuiunix/components/xtf-notice-bar/xtf-notice-bar.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfNoticeBar text="示例内容" @click="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfNoticeBar from "@/uni_modules/xtf-linkuiunix/components/xtf-notice-bar/xtf-notice-bar.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-notice-bar:click", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
3. 动态 single 状态
运行时切换 single,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfNoticeBar text="示例内容" :single="state" />
<button class="doc-action-button" @click="toggleState">切换 single</button>
<text class="doc-state-text">single: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfNoticeBar from "@/uni_modules/xtf-linkuiunix/components/xtf-notice-bar/xtf-notice-bar.uvue"
import { ref } from "vue"
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("single", state.value) }
</script>
<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
text | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 5、template 行 6 | 需要提供业务文案或图标内容时设置。 |
backgroundColor | string | "#FFF9EA" | 设置对应区域的颜色;消费位置:script 行 15 | 需要调整布局或视觉表现时设置。 |
color | string | "#FF9A43" | 参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 15、template 行 3、template 行 5、template 行 8 | 需要覆盖组件默认业务值时设置。 |
speed | string | number | 48 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 5 | 需要覆盖组件默认业务值时设置。 |
single | boolean | string | false | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 11 | 需要覆盖组件默认业务值时设置。 |
scrollable | boolean | string | false | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 12 | 需要覆盖组件默认业务值时设置。 |
showIcon | boolean | string | false | 设置对应区域的图标名称;消费位置:script 行 8 | 需要控制显示、可用性或交互状态时设置。 |
showGetMore | boolean | string | false | 开关对应显示或交互行为;消费位置:script 行 9 | 需要控制显示、可用性或交互状态时设置。 |
moreText | string | "" | 设置对应区域的显示文案;消费位置:template 行 8 | 需要提供业务文案或图标内容时设置。 |
showClose | boolean | string | false | 开关对应显示或交互行为;消费位置:script 行 10 | 需要控制显示、可用性或交互状态时设置。 |
icon | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 3 | 需要提供业务文案或图标内容时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 13 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 15 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
click | handleClick 内触发(script 行 17);参数表达式:无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
getmore | handleGetMore 内触发(script 行 18);参数表达式:无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
close | handleClose 内触发(script 行 19);参数表达式:无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
| - | - | 当前组件没有公开实例方法。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-notice-bg):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-notice-color):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。
平台与实现边界
- 基线为 HBuilderX 5.26+ 与 uni-app x;当前报告已验证 Web Chromium 的对应 Demo,不据此承诺 Safari、小程序或 App 原生端等价。
- Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力,只有源码或完整性报告明确覆盖的部分才可视为已验证。
- 本文按当前源码生成,不补入旧版
xtf-linkui存在但迁移版未实现的 props、事件、slot 或方法。 - 详细公共边界见 平台与实现边界,逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。