ASAM UI
v1.0.0

导航

回到顶部 AsamBacktop

在长内容中提供返回指定滚动容器顶部的操作。

使用场景 ​

在长内容中提供返回指定滚动容器顶部的操作。

基础用法与状态 ​

下列示例只使用本入口的实际公开能力。

基础用法与状态

展开源码

使用约定 ​

target 指定滚动容器，visibilityHeight 决定出现时机，right/bottom 指定位置，click 反馈点击。default 插槽定制内容；可用目标必须存在且自己产生滚动。它不自动修改路由。

完整使用场景 ​

基础用法 ​

通过滑动来查看容器右下角的按钮。

基础用法

展开源码

自定义显示内容 ​

显示区域被固定为 40px * 40px 的区域，其中的内容可支持自定义。

自定义显示内容

展开源码

API

属性 AsamBacktopProps

属性名说明类型默认值
visibilityHeight滚动高度达到此参数值才出现number | undefined200
target触发滚动的对象string | undefined""
right控制其显示位置，距离页面右边距number | undefined40
bottom控制其显示位置，距离页面底部距离number | undefined40
onClick—((evt: MouseEvent) => any) | undefined—
key—PropertyKey | undefined—
ref—VNodeRef | undefined—
ref_for—boolean | undefined—
ref_key—string | undefined—
onVnodeBeforeMount—(AsamBacktopProps)["onVnodeBeforeMount"]—
onVnodeMounted—(AsamBacktopProps)["onVnodeMounted"]—
onVnodeBeforeUpdate—(AsamBacktopProps)["onVnodeBeforeUpdate"]—
onVnodeUpdated—(AsamBacktopProps)["onVnodeUpdated"]—
onVnodeBeforeUnmount—(AsamBacktopProps)["onVnodeBeforeUnmount"]—
onVnodeUnmounted—(AsamBacktopProps)["onVnodeUnmounted"]—
class—unknown—
style—unknown—

实例方法与状态 AsamBacktopExpose

属性名说明类型默认值
$—AsamBacktopExpose["$"]—
$data—AsamTableColumnExpose—
$props—AsamBacktopProps—
$attrs—AsamBacktopExpose["$attrs"]—
$refs—AsamBacktopExpose["$refs"]—
$slots—AsamBacktopSlots—
$root—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$parent—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$host—Element | null—
$emit—(event: "click", evt: MouseEvent) => void—
$el—any—
$options—(AsamBacktopExpose)["$options"]—
$forceUpdate—() => void—
$nextTick—(AsamBacktopExpose)["$nextTick"]—
$watch—(AsamBacktopExpose)["$watch"]—
right—number—
bottom—number—
target—string—
visibilityHeight—number—
onClick—((evt: MouseEvent) => any) | undefined—
$route当前规范化路由位置，详见 RouteLocationNormalizedLoaded。AsamBacktopExpose["$route"]—
$router应用使用的 Router 实例。AsamBacktopExpose["$router"]—

类型 AsamBacktopInstance

属性名说明类型默认值
$—AsamBacktopExpose["$"]—
$data—AsamTableColumnExpose—
$props—AsamBacktopProps—
$attrs—AsamBacktopExpose["$attrs"]—
$refs—AsamBacktopExpose["$refs"]—
$slots—AsamBacktopSlots—
$root—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$parent—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$host—Element | null—
$emit—(event: "click", evt: MouseEvent) => void—
$el—any—
$options—(AsamBacktopInstance)["$options"]—
$forceUpdate—() => void—
$nextTick—(AsamBacktopInstance)["$nextTick"]—
$watch—(AsamBacktopInstance)["$watch"]—
right—number—
bottom—number—
target—string—
visibilityHeight—number—
onClick—((evt: MouseEvent) => any) | undefined—
$route当前规范化路由位置，详见 RouteLocationNormalizedLoaded。AsamBacktopExpose["$route"]—
$router应用使用的 Router 实例。AsamBacktopExpose["$router"]—

插槽 AsamBacktopSlots

属性名说明类型默认值
default—(AsamBacktopSlots)["default"]—

事件 AsamBacktopEmits

属性名说明类型默认值
click—(evt: MouseEvent) => boolean—

类型 AsamBacktopPropsPublic

属性名说明类型默认值
bottom控制其显示位置，距离页面底部距离number | undefined—
right控制其显示位置，距离页面右边距number | undefined—
target触发滚动的对象string | undefined—
visibilityHeight滚动高度达到此参数值才出现number | undefined—
滚动容器 AsamScrollbar
参数与事件补充说明

公开绑定参数，包含具备类型的事件监听器；默认值由运行时定义提供。

参数与事件说明

visibilityHeight

必填：否；声明来源：上游声明。

默认值与来源
200（已安装运行时；已安装组件）

固定上游文档默认：200（2.14.7；文档事实，实际默认以 ASAM 源码 / 安装包为准）

固定上游源码默认表达式：200（2.14.7；源码事实，未作为 ASAM 运行实测）

target

必填：否；声明来源：上游声明。

默认值与来源
""（已安装运行时；已安装组件）

固定上游文档默认：未声明（2.14.7；文档事实，实际默认以 ASAM 源码 / 安装包为准）

固定上游源码默认表达式：''（2.14.7；源码事实，未作为 ASAM 运行实测）

right

必填：否；声明来源：上游声明。

默认值与来源
40（已安装运行时；已安装组件）

固定上游文档默认：40（2.14.7；文档事实，实际默认以 ASAM 源码 / 安装包为准）

固定上游源码默认表达式：40（2.14.7；源码事实，未作为 ASAM 运行实测）

bottom

必填：否；声明来源：上游声明。

默认值与来源
40（已安装运行时；已安装组件）

固定上游文档默认：40（2.14.7；文档事实，实际默认以 ASAM 源码 / 安装包为准）

固定上游源码默认表达式：40（2.14.7；源码事实，未作为 ASAM 运行实测）

onClick

必填：否；声明来源：上游声明。

onClick 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(evt: MouseEvent): any

key

必填：否；声明来源：依赖声明。

ref

必填：否；声明来源：依赖声明。

ref 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(ref: Element | ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null, refs: Record<string, any>): void

  • ref.value: any — 依赖声明
  • ref.__@RefSymbol@8854: true — 依赖声明

    仅用于区分类型：保留在公开声明中，通过私有 Symbol 避免出现在编辑器自动补全中。

    枚举：true

ref_for

必填：否；声明来源：依赖声明。

ref_for 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举：false / true

ref_key

必填：否；声明来源：依赖声明。

onVnodeBeforeMount

必填：否；声明来源：依赖声明。

onVnodeBeforeMount 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeMounted

必填：否；声明来源：依赖声明。

onVnodeMounted 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeBeforeUpdate

必填：否；声明来源：依赖声明。

onVnodeBeforeUpdate 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>, oldVNode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeUpdated

必填：否；声明来源：依赖声明。

onVnodeUpdated 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>, oldVNode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeBeforeUnmount

必填：否；声明来源：依赖声明。

onVnodeBeforeUnmount 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeUnmounted

必填：否；声明来源：依赖声明。

onVnodeUnmounted 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

class

必填：否；声明来源：依赖声明。

style

必填：否；声明来源：依赖声明。

AsamBacktopProps 公开类型视图
ts
import type { VNodeRef, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, VNode, RendererNode, RendererElement } from 'vue';
import type { AsamBacktopProps, AsamBacktopExpose } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamBacktopProps
type PublicContract = {
	readonly "visibilityHeight"?: number | undefined;
	readonly "target"?: string | undefined;
	readonly "right"?: number | undefined;
	readonly "bottom"?: number | undefined;
	readonly "onClick"?: ((evt: MouseEvent) => any) | undefined;
	"key"?: PropertyKey | undefined;
	"ref"?: VNodeRef | undefined;
	"ref_for"?: boolean | undefined;
	"ref_key"?: string | undefined;
	"onVnodeBeforeMount"?: (AsamBacktopProps)["onVnodeBeforeMount"];
	"onVnodeMounted"?: (AsamBacktopProps)["onVnodeMounted"];
	"onVnodeBeforeUpdate"?: (AsamBacktopProps)["onVnodeBeforeUpdate"];
	"onVnodeUpdated"?: (AsamBacktopProps)["onVnodeUpdated"];
	"onVnodeBeforeUnmount"?: (AsamBacktopProps)["onVnodeBeforeUnmount"];
	"onVnodeUnmounted"?: (AsamBacktopProps)["onVnodeUnmounted"];
	"class"?: unknown;
	"style"?: unknown;
};

完整的上游实例，包含全部公开方法与响应式状态。

参数与事件说明

$

必填：是；声明来源：依赖声明。

$ 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$data

必填：是；声明来源：依赖声明。

$props

必填：是；声明来源：依赖声明。

$attrs

必填：是；声明来源：依赖声明。

$attrs 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$refs

必填：是；声明来源：依赖声明。

$refs 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$slots

必填：是；声明来源：依赖声明。

$root

必填：是；声明来源：依赖声明。

$parent

必填：是；声明来源：依赖声明。

$host

必填：是；声明来源：依赖声明。

$host 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界：大型实例类型；完整类型见公开类型视图。

$emit

必填：是；声明来源：依赖声明。

$emit 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(event: "click", ...args: [evt: MouseEvent]): void

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$el

必填：是；声明来源：依赖声明。

$options

必填：是；声明来源：依赖声明。

$forceUpdate

必填：是；声明来源：依赖声明。

$forceUpdate 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(): void

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$nextTick

必填：是；声明来源：依赖声明。

$nextTick 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(): Promise<void>

事件参数：<T, R>(this: T, fn: (this: T) => R | Promise<R>): Promise<R>

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$watch

必填：是；声明来源：依赖声明。

$watch 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：<T extends string | ((...args: any) => any)>(source: T, cb: Parameters<Extract<NonNullable<(AsamBacktopExpose)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

right

必填：是；声明来源：上游声明。

bottom

必填：是；声明来源：上游声明。

target

必填：是；声明来源：上游声明。

visibilityHeight

必填：是；声明来源：上游声明。

onClick

必填：否；声明来源：上游声明。

onClick 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(evt: MouseEvent): any

$route

必填：是；声明来源：依赖声明。

$route 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $route.matched: (NonNullable<AsamBacktopExpose["$route"]>)["matched"] — 依赖声明

    仅包含普通组件的 RouteLocationMatched 数组；懒加载组件已解析并替换 components 中的值，可直接展示路由，不包含重定向记录。此属性不可枚举。

    嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

  • $route.name: (NonNullable<AsamBacktopExpose["$route"]>)["name"] — 依赖声明

    匹配路由记录的名称。

  • $route.fullPath: string — 依赖声明

    包含 search 和 hash 的完整位置字符串，使用百分号编码。

  • $route.query: (NonNullable<AsamBacktopExpose["$route"]>)["query"] — 依赖声明

    当前位置 search 属性的对象表示。

  • $route.hash: string — 依赖声明

    当前位置的哈希片段；存在时以 # 开头。

  • $route.redirectedFrom: (NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"] — 依赖声明

    最终到达当前位置之前，最初尝试访问的位置。

    • $route.redirectedFrom.matched: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "matched"> — 依赖声明

      包含添加路由时原始组件的 RouteRecord 数组，也可能包含重定向记录，不能直接用于展示。此属性不可枚举。

      嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

    • $route.redirectedFrom.fullPath: string — 依赖声明

      包含 search 和 hash 的完整位置字符串，使用百分号编码。

    • $route.redirectedFrom.query: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "query"> — 依赖声明

      当前位置 search 属性的对象表示。

    • $route.redirectedFrom.hash: string — 依赖声明

      当前位置的哈希片段；存在时以 # 开头。

    • $route.redirectedFrom.redirectedFrom: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "redirectedFrom"> — 依赖声明

      最终到达当前位置之前，最初尝试访问的位置。

      嵌套展开边界：递归引用；完整类型见公开类型视图。

    • $route.redirectedFrom.name: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "name"> — 依赖声明

      匹配路由记录的名称。

    • $route.redirectedFrom.meta: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "meta"> — 依赖声明

      全部匹配路由记录合并后的 meta 属性。

    • $route.redirectedFrom.params: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "params"> — 依赖声明

      从 path 提取并解码后的参数对象。

    • $route.redirectedFrom.path: string — 依赖声明

      URL 中经过百分号编码的路径部分。

    • $route.redirectedFrom.replace: boolean | undefined — 依赖声明

      替换当前历史记录，而不是添加新记录。

      枚举：false / true

    • $route.redirectedFrom.force: boolean | undefined — 依赖声明

      即使目标与当前位置相同，也触发导航；除非传入 replace: true，否则会添加一条历史记录。

      枚举：false / true

    • $route.redirectedFrom.state: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "state"> — 依赖声明

      通过 History API 保存的状态；不能包含响应式值，也不允许 Symbol 等部分值。详情参见 https://developer.mozilla.org/zh-CN/docs/Web/API/History/state。

  • $route.meta: (NonNullable<AsamBacktopExpose["$route"]>)["meta"] — 依赖声明

    全部匹配路由记录合并后的 meta 属性。

  • $route.params: (NonNullable<AsamBacktopExpose["$route"]>)["params"] — 依赖声明

    从 path 提取并解码后的参数对象。

  • $route.path: string — 依赖声明

    URL 中经过百分号编码的路径部分。

$router

必填：是；声明来源：依赖声明。

$router 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $router.options: (NonNullable<AsamBacktopExpose["$router"]>)["options"] — 依赖声明

    创建路由器时传入的原始配置对象。

    • $router.options.routes: (NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["routes"] — 依赖声明

      需要添加到路由器的初始路由列表。

      嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

    • $router.options.history: (NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"] — 依赖声明

      路由器使用的历史记录实现。通常使用 createWebHistory，并配置服务器回退；createWebHashHistory 无需服务器配置，但搜索引擎无法处理其哈希路由，影响搜索优化。

      • $router.options.history.base: string — 依赖声明

        添加到每个 URL 前的基础路径；例如 base 为 /sub-folder 时，可将单页应用部署在域名的对应子目录。

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.location: string — 依赖声明

        当前历史记录位置。

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.state: (NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["state"] — 依赖声明

        当前历史记录状态。

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.push: (NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["push"] — 依赖声明

        导航到指定位置；使用 HTML5 History 时，通过 history.pushState 实际更新 URL。

        事件参数：(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["push"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.replace: (NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["replace"] — 依赖声明

        与 RouterHistory.push 类似，但调用 history.replaceState，而非 history.pushState。

        事件参数：(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["replace"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.go: (delta: number, triggerListeners?: boolean) => void — 依赖声明

        按指定方向遍历历史记录。

        事件参数：(delta: number, triggerListeners?: boolean | undefined): void

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.listen: (NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["listen"] — 依赖声明

        为历史记录实现添加监听器；由浏览器前进、后退等外部导航，或传入 true 的 RouterHistory.back、RouterHistory.forward 触发。

        事件参数：(callback: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["listen"]>, (...args: never[]) => unknown>>[0]): () => void

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.createHref: (location: AsamBacktopExpose["target"]) => string — 依赖声明

        生成用于链接元素的对应 href。

        事件参数：(location: string): string

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.destroy: () => void — 依赖声明

        清除历史记录实现注册的全部事件监听器。

        事件参数：(): void

        嵌套展开边界：深度上限；完整类型见公开类型视图。

    • $router.options.scrollBehavior: (NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["scrollBehavior"] — 依赖声明

      控制页面导航时滚动行为的函数；可返回 Promise 延迟滚动。

      事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[0], from: AsamBacktopExpose["$route"], savedPosition: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[2]): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>

    • $router.options.parseQuery: (NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["parseQuery"] — 依赖声明

      自定义查询参数解析函数；与 EXPERIMENTAL_RouterOptions_Base.stringifyQuery 配套。

      事件参数：(search: string): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["parseQuery"]>, (...args: never[]) => unknown>>

    • $router.options.stringifyQuery: (NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["stringifyQuery"] — 依赖声明

      自定义查询对象序列化函数；不要添加开头的 ?，与 parseQuery 的解析函数配套。

      事件参数：(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["stringifyQuery"]>, (...args: never[]) => unknown>>[0]): string

    • $router.options.linkActiveClass: string | undefined — 依赖声明

      应用于激活 RouterLink 的默认类名；未指定时使用 router-link-active。

    • $router.options.linkExactActiveClass: string | undefined — 依赖声明

      应用于精确激活 RouterLink 的默认类名；未指定时使用 router-link-exact-active。

    • $router.options.end: boolean | undefined — 依赖声明

      是否在表达式末尾添加 $，使其匹配到路径结尾。

      声明默认：`true`（注释，实际运行默认以源码/安装包为准）

      枚举：false / true

    • $router.options.sensitive: boolean | undefined — 依赖声明

      使正则表达式区分大小写。

      声明默认：`false`（注释，实际运行默认以源码/安装包为准）

      枚举：false / true

    • $router.options.strict: boolean | undefined — 依赖声明

      是否禁止路径末尾的斜杠。

      声明默认：`false`（注释，实际运行默认以源码/安装包为准）

      枚举：false / true

  • $router.addRoute: (NonNullable<AsamBacktopExpose["$router"]>)["addRoute"] — 依赖声明

    向已有路由添加子路由，或向路由器添加新的 RouteRecordRaw 路由记录。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.removeRoute: (NonNullable<AsamBacktopExpose["$router"]>)["removeRoute"] — 依赖声明

    按名称移除已有路由。

    事件参数：(name: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["removeRoute"]>, (...args: never[]) => unknown>>[0]): void

  • $router.clearRoutes: () => void — 依赖声明

    从路由器中删除全部路由。

    事件参数：(): void

  • $router.currentRoute: ShallowRef<AsamBacktopExpose["$route"]> — 依赖声明

    当前 RouteLocationNormalized。

    嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

  • $router.listening: boolean — 依赖声明

    允许关闭历史事件监听，这是用于微前端的底层 API。

    枚举：false / true

  • $router.hasRoute: (NonNullable<AsamBacktopExpose["$router"]>)["hasRoute"] — 依赖声明

    检查指定名称的路由是否存在。

    事件参数：(name: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["hasRoute"]>, (...args: never[]) => unknown>>[0]): boolean

  • $router.getRoutes: (NonNullable<AsamBacktopExpose["$router"]>)["getRoutes"] — 依赖声明

    获取全部 RouteRecord 路由记录的完整列表。

    事件参数：(): ReturnType<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["getRoutes"]>, (...args: never[]) => unknown>>

  • $router.resolve: (NonNullable<AsamBacktopExpose["$router"]>)["resolve"] — 依赖声明

    返回 RouteLocationRaw 的规范化位置，包含带基础路径的 href；默认使用 router.currentRoute 作为 currentLocation，仅在高级场景中覆盖。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.push: (NonNullable<AsamBacktopExpose["$router"]>)["push"] — 依赖声明

    通过向历史栈添加记录，以编程方式导航到新 URL。

    事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>

  • $router.replace: (NonNullable<AsamBacktopExpose["$router"]>)["replace"] — 依赖声明

    通过替换历史栈中的当前记录，以编程方式导航到新 URL。

    事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>

  • $router.back: () => void — 依赖声明

    通过 history.back() 在可用时后退，等价于 router.go(-1)。

    事件参数：(): void

  • $router.forward: () => void — 依赖声明

    通过 history.forward() 在可用时前进，等价于 router.go(1)。

    事件参数：(): void

  • $router.go: (delta: number) => void — 依赖声明

    通过调用 history.go() 在历史记录中前进或后退。

    事件参数：(delta: number): void

  • $router.beforeEach: (NonNullable<AsamBacktopExpose["$router"]>)["beforeEach"] — 依赖声明

    添加每次导航之前执行的守卫，并返回移除此守卫的函数。

    事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["beforeEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.beforeResolve: (NonNullable<AsamBacktopExpose["$router"]>)["beforeResolve"] — 依赖声明

    添加导航确认之前执行的守卫，此时组件已获取且其他导航守卫已通过；返回移除此守卫的函数。

    事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["beforeResolve"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.afterEach: (NonNullable<AsamBacktopExpose["$router"]>)["afterEach"] — 依赖声明

    添加每次导航结束后执行的钩子，并返回移除此钩子的函数。

    事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["afterEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.onError: (NonNullable<AsamBacktopExpose["$router"]>)["onError"] — 依赖声明

    添加导航期间未捕获错误的处理函数，涵盖同步和异步异常、守卫返回或传给 next 的错误，以及路由异步组件解析错误。

    事件参数：(handler: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["onError"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.isReady: () => Promise<void> — 依赖声明

    返回在初次导航完成后兑现的 Promise，此时关联的异步进入钩子与异步组件均已解析；导航已完成时立即兑现。可用于保持服务端与客户端渲染一致；服务端需手动推入初始位置，客户端从 URL 自动读取。

    事件参数：(): Promise<void>

  • $router.install: (app: App) => void — 依赖声明

    由 app.use(router) 自动调用，用户不应手动调用；客户端调用时会触发初次导航。

    事件参数：(app: App<any>): void

AsamBacktopExpose 公开类型视图
ts
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamBacktopExpose, AsamTableColumnExpose, AsamBacktopProps, AsamBacktopSlots } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamBacktopExpose
type PublicContract = {
	"$": AsamBacktopExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamBacktopProps;
	"$attrs": AsamBacktopExpose["$attrs"];
	"$refs": AsamBacktopExpose["$refs"];
	"$slots": AsamBacktopSlots;
	"$root": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$parent": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$host": Element | null;
	"$emit": (event: "click", evt: MouseEvent) => void;
	"$el": any;
	"$options": (AsamBacktopExpose)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamBacktopExpose)["$nextTick"];
	"$watch": (AsamBacktopExpose)["$watch"];
	readonly "right": number;
	readonly "bottom": number;
	readonly "target": string;
	readonly "visibilityHeight": number;
	readonly "onClick"?: ((evt: MouseEvent) => any) | undefined;
	"$route": AsamBacktopExpose["$route"];
	"$router": AsamBacktopExpose["$router"];
};

参数与事件说明

$

必填：是；声明来源：依赖声明。

$ 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$data

必填：是；声明来源：依赖声明。

$props

必填：是；声明来源：依赖声明。

$attrs

必填：是；声明来源：依赖声明。

$attrs 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$refs

必填：是；声明来源：依赖声明。

$refs 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$slots

必填：是；声明来源：依赖声明。

$root

必填：是；声明来源：依赖声明。

$parent

必填：是；声明来源：依赖声明。

$host

必填：是；声明来源：依赖声明。

$host 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界：大型实例类型；完整类型见公开类型视图。

$emit

必填：是；声明来源：依赖声明。

$emit 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(event: "click", ...args: [evt: MouseEvent]): void

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$el

必填：是；声明来源：依赖声明。

$options

必填：是；声明来源：依赖声明。

$forceUpdate

必填：是；声明来源：依赖声明。

$forceUpdate 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(): void

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$nextTick

必填：是；声明来源：依赖声明。

$nextTick 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(): Promise<void>

事件参数：<T, R>(this: T, fn: (this: T) => R | Promise<R>): Promise<R>

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

$watch

必填：是；声明来源：依赖声明。

$watch 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：<T extends string | ((...args: any) => any)>(source: T, cb: Parameters<Extract<NonNullable<(AsamBacktopInstance)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

right

必填：是；声明来源：上游声明。

bottom

必填：是；声明来源：上游声明。

target

必填：是；声明来源：上游声明。

visibilityHeight

必填：是；声明来源：上游声明。

onClick

必填：否；声明来源：上游声明。

onClick 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(evt: MouseEvent): any

$route

必填：是；声明来源：依赖声明。

$route 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $route.matched: (NonNullable<AsamBacktopExpose["$route"]>)["matched"] — 依赖声明

    仅包含普通组件的 RouteLocationMatched 数组；懒加载组件已解析并替换 components 中的值，可直接展示路由，不包含重定向记录。此属性不可枚举。

    嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

  • $route.name: (NonNullable<AsamBacktopExpose["$route"]>)["name"] — 依赖声明

    匹配路由记录的名称。

  • $route.fullPath: string — 依赖声明

    包含 search 和 hash 的完整位置字符串，使用百分号编码。

  • $route.query: (NonNullable<AsamBacktopExpose["$route"]>)["query"] — 依赖声明

    当前位置 search 属性的对象表示。

  • $route.hash: string — 依赖声明

    当前位置的哈希片段；存在时以 # 开头。

  • $route.redirectedFrom: (NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"] — 依赖声明

    最终到达当前位置之前，最初尝试访问的位置。

    • $route.redirectedFrom.matched: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "matched"> — 依赖声明

      包含添加路由时原始组件的 RouteRecord 数组，也可能包含重定向记录，不能直接用于展示。此属性不可枚举。

      嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

    • $route.redirectedFrom.fullPath: string — 依赖声明

      包含 search 和 hash 的完整位置字符串，使用百分号编码。

    • $route.redirectedFrom.query: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "query"> — 依赖声明

      当前位置 search 属性的对象表示。

    • $route.redirectedFrom.hash: string — 依赖声明

      当前位置的哈希片段；存在时以 # 开头。

    • $route.redirectedFrom.redirectedFrom: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "redirectedFrom"> — 依赖声明

      最终到达当前位置之前，最初尝试访问的位置。

      嵌套展开边界：递归引用；完整类型见公开类型视图。

    • $route.redirectedFrom.name: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "name"> — 依赖声明

      匹配路由记录的名称。

    • $route.redirectedFrom.meta: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "meta"> — 依赖声明

      全部匹配路由记录合并后的 meta 属性。

    • $route.redirectedFrom.params: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "params"> — 依赖声明

      从 path 提取并解码后的参数对象。

    • $route.redirectedFrom.path: string — 依赖声明

      URL 中经过百分号编码的路径部分。

    • $route.redirectedFrom.replace: boolean | undefined — 依赖声明

      替换当前历史记录，而不是添加新记录。

      枚举：false / true

    • $route.redirectedFrom.force: boolean | undefined — 依赖声明

      即使目标与当前位置相同，也触发导航；除非传入 replace: true，否则会添加一条历史记录。

      枚举：false / true

    • $route.redirectedFrom.state: PublicMember<NonNullable<(NonNullable<AsamBacktopExpose["$route"]>)["redirectedFrom"]>, "state"> — 依赖声明

      通过 History API 保存的状态；不能包含响应式值，也不允许 Symbol 等部分值。详情参见 https://developer.mozilla.org/zh-CN/docs/Web/API/History/state。

  • $route.meta: (NonNullable<AsamBacktopExpose["$route"]>)["meta"] — 依赖声明

    全部匹配路由记录合并后的 meta 属性。

  • $route.params: (NonNullable<AsamBacktopExpose["$route"]>)["params"] — 依赖声明

    从 path 提取并解码后的参数对象。

  • $route.path: string — 依赖声明

    URL 中经过百分号编码的路径部分。

$router

必填：是；声明来源：依赖声明。

$router 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $router.options: (NonNullable<AsamBacktopExpose["$router"]>)["options"] — 依赖声明

    创建路由器时传入的原始配置对象。

    • $router.options.routes: (NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["routes"] — 依赖声明

      需要添加到路由器的初始路由列表。

      嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

    • $router.options.history: (NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"] — 依赖声明

      路由器使用的历史记录实现。通常使用 createWebHistory，并配置服务器回退；createWebHashHistory 无需服务器配置，但搜索引擎无法处理其哈希路由，影响搜索优化。

      • $router.options.history.base: string — 依赖声明

        添加到每个 URL 前的基础路径；例如 base 为 /sub-folder 时，可将单页应用部署在域名的对应子目录。

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.location: string — 依赖声明

        当前历史记录位置。

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.state: (NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["state"] — 依赖声明

        当前历史记录状态。

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.push: (NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["push"] — 依赖声明

        导航到指定位置；使用 HTML5 History 时，通过 history.pushState 实际更新 URL。

        事件参数：(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["push"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.replace: (NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["replace"] — 依赖声明

        与 RouterHistory.push 类似，但调用 history.replaceState，而非 history.pushState。

        事件参数：(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["replace"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.go: (delta: number, triggerListeners?: boolean) => void — 依赖声明

        按指定方向遍历历史记录。

        事件参数：(delta: number, triggerListeners?: boolean | undefined): void

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.listen: (NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["listen"] — 依赖声明

        为历史记录实现添加监听器；由浏览器前进、后退等外部导航，或传入 true 的 RouterHistory.back、RouterHistory.forward 触发。

        事件参数：(callback: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["history"]>)["listen"]>, (...args: never[]) => unknown>>[0]): () => void

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.createHref: (location: AsamBacktopExpose["target"]) => string — 依赖声明

        生成用于链接元素的对应 href。

        事件参数：(location: string): string

        嵌套展开边界：深度上限；完整类型见公开类型视图。

      • $router.options.history.destroy: () => void — 依赖声明

        清除历史记录实现注册的全部事件监听器。

        事件参数：(): void

        嵌套展开边界：深度上限；完整类型见公开类型视图。

    • $router.options.scrollBehavior: (NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["scrollBehavior"] — 依赖声明

      控制页面导航时滚动行为的函数；可返回 Promise 延迟滚动。

      事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[0], from: AsamBacktopExpose["$route"], savedPosition: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[2]): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>

    • $router.options.parseQuery: (NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["parseQuery"] — 依赖声明

      自定义查询参数解析函数；与 EXPERIMENTAL_RouterOptions_Base.stringifyQuery 配套。

      事件参数：(search: string): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["parseQuery"]>, (...args: never[]) => unknown>>

    • $router.options.stringifyQuery: (NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["stringifyQuery"] — 依赖声明

      自定义查询对象序列化函数；不要添加开头的 ?，与 parseQuery 的解析函数配套。

      事件参数：(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["options"]>)["stringifyQuery"]>, (...args: never[]) => unknown>>[0]): string

    • $router.options.linkActiveClass: string | undefined — 依赖声明

      应用于激活 RouterLink 的默认类名；未指定时使用 router-link-active。

    • $router.options.linkExactActiveClass: string | undefined — 依赖声明

      应用于精确激活 RouterLink 的默认类名；未指定时使用 router-link-exact-active。

    • $router.options.end: boolean | undefined — 依赖声明

      是否在表达式末尾添加 $，使其匹配到路径结尾。

      声明默认：`true`（注释，实际运行默认以源码/安装包为准）

      枚举：false / true

    • $router.options.sensitive: boolean | undefined — 依赖声明

      使正则表达式区分大小写。

      声明默认：`false`（注释，实际运行默认以源码/安装包为准）

      枚举：false / true

    • $router.options.strict: boolean | undefined — 依赖声明

      是否禁止路径末尾的斜杠。

      声明默认：`false`（注释，实际运行默认以源码/安装包为准）

      枚举：false / true

  • $router.addRoute: (NonNullable<AsamBacktopExpose["$router"]>)["addRoute"] — 依赖声明

    向已有路由添加子路由，或向路由器添加新的 RouteRecordRaw 路由记录。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.removeRoute: (NonNullable<AsamBacktopExpose["$router"]>)["removeRoute"] — 依赖声明

    按名称移除已有路由。

    事件参数：(name: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["removeRoute"]>, (...args: never[]) => unknown>>[0]): void

  • $router.clearRoutes: () => void — 依赖声明

    从路由器中删除全部路由。

    事件参数：(): void

  • $router.currentRoute: ShallowRef<AsamBacktopExpose["$route"]> — 依赖声明

    当前 RouteLocationNormalized。

    嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。

  • $router.listening: boolean — 依赖声明

    允许关闭历史事件监听，这是用于微前端的底层 API。

    枚举：false / true

  • $router.hasRoute: (NonNullable<AsamBacktopExpose["$router"]>)["hasRoute"] — 依赖声明

    检查指定名称的路由是否存在。

    事件参数：(name: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["hasRoute"]>, (...args: never[]) => unknown>>[0]): boolean

  • $router.getRoutes: (NonNullable<AsamBacktopExpose["$router"]>)["getRoutes"] — 依赖声明

    获取全部 RouteRecord 路由记录的完整列表。

    事件参数：(): ReturnType<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["getRoutes"]>, (...args: never[]) => unknown>>

  • $router.resolve: (NonNullable<AsamBacktopExpose["$router"]>)["resolve"] — 依赖声明

    返回 RouteLocationRaw 的规范化位置，包含带基础路径的 href；默认使用 router.currentRoute 作为 currentLocation，仅在高级场景中覆盖。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.push: (NonNullable<AsamBacktopExpose["$router"]>)["push"] — 依赖声明

    通过向历史栈添加记录，以编程方式导航到新 URL。

    事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>

  • $router.replace: (NonNullable<AsamBacktopExpose["$router"]>)["replace"] — 依赖声明

    通过替换历史栈中的当前记录，以编程方式导航到新 URL。

    事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>

  • $router.back: () => void — 依赖声明

    通过 history.back() 在可用时后退，等价于 router.go(-1)。

    事件参数：(): void

  • $router.forward: () => void — 依赖声明

    通过 history.forward() 在可用时前进，等价于 router.go(1)。

    事件参数：(): void

  • $router.go: (delta: number) => void — 依赖声明

    通过调用 history.go() 在历史记录中前进或后退。

    事件参数：(delta: number): void

  • $router.beforeEach: (NonNullable<AsamBacktopExpose["$router"]>)["beforeEach"] — 依赖声明

    添加每次导航之前执行的守卫，并返回移除此守卫的函数。

    事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["beforeEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.beforeResolve: (NonNullable<AsamBacktopExpose["$router"]>)["beforeResolve"] — 依赖声明

    添加导航确认之前执行的守卫，此时组件已获取且其他导航守卫已通过；返回移除此守卫的函数。

    事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["beforeResolve"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.afterEach: (NonNullable<AsamBacktopExpose["$router"]>)["afterEach"] — 依赖声明

    添加每次导航结束后执行的钩子，并返回移除此钩子的函数。

    事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["afterEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.onError: (NonNullable<AsamBacktopExpose["$router"]>)["onError"] — 依赖声明

    添加导航期间未捕获错误的处理函数，涵盖同步和异步异常、守卫返回或传给 next 的错误，以及路由异步组件解析错误。

    事件参数：(handler: Parameters<Extract<NonNullable<(NonNullable<AsamBacktopExpose["$router"]>)["onError"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.isReady: () => Promise<void> — 依赖声明

    返回在初次导航完成后兑现的 Promise，此时关联的异步进入钩子与异步组件均已解析；导航已完成时立即兑现。可用于保持服务端与客户端渲染一致；服务端需手动推入初始位置，客户端从 URL 自动读取。

    事件参数：(): Promise<void>

  • $router.install: (app: App) => void — 依赖声明

    由 app.use(router) 自动调用，用户不应手动调用；客户端调用时会触发初次导航。

    事件参数：(app: App<any>): void

AsamBacktopInstance 公开类型视图
ts
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamBacktopInstance, AsamBacktopExpose, AsamTableColumnExpose, AsamBacktopProps, AsamBacktopSlots } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamBacktopInstance
type PublicContract = {
	"$": AsamBacktopExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamBacktopProps;
	"$attrs": AsamBacktopExpose["$attrs"];
	"$refs": AsamBacktopExpose["$refs"];
	"$slots": AsamBacktopSlots;
	"$root": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$parent": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$host": Element | null;
	"$emit": (event: "click", evt: MouseEvent) => void;
	"$el": any;
	"$options": (AsamBacktopInstance)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamBacktopInstance)["$nextTick"];
	"$watch": (AsamBacktopInstance)["$watch"];
	readonly "right": number;
	readonly "bottom": number;
	readonly "target": string;
	readonly "visibilityHeight": number;
	readonly "onClick"?: ((evt: MouseEvent) => any) | undefined;
	"$route": AsamBacktopExpose["$route"];
	"$router": AsamBacktopExpose["$router"];
};

作用域插槽保留上游实例契约。

参数与事件说明

default

必填：否；声明来源：上游声明。

default 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(props: AsamTableColumnExpose): any

AsamBacktopSlots 公开类型视图
ts
import type { AsamBacktopSlots, AsamBacktopExpose, AsamTableColumnExpose } from '@asam-ui/ui';

// AsamBacktopSlots
type PublicContract = {
	"default"?: (AsamBacktopSlots)["default"];
	readonly [key: string]: import("vue").Slot<any> | undefined;
};

参数与事件说明

click

必填：是；声明来源：上游声明。

click 参数与事件数据

下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数：(evt: MouseEvent): boolean

AsamBacktopEmits 公开类型视图
ts
import type { AsamBacktopEmits } from '@asam-ui/ui';

// AsamBacktopEmits
type PublicContract = {
	"click": (evt: MouseEvent) => boolean;
};

参数与事件说明

bottom

必填：否；声明来源：上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式：40（2.14.7；源码事实，未作为 ASAM 运行实测）

right

必填：否；声明来源：上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式：40（2.14.7；源码事实，未作为 ASAM 运行实测）

target

必填：否；声明来源：上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式：''（2.14.7；源码事实，未作为 ASAM 运行实测）

visibilityHeight

必填：否；声明来源：上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式：200（2.14.7；源码事实，未作为 ASAM 运行实测）

AsamBacktopPropsPublic 公开类型视图
ts
import type { AsamBacktopPropsPublic, AsamBacktopProps } from '@asam-ui/ui';

// AsamBacktopPropsPublic
type PublicContract = {
	readonly "bottom"?: number | undefined;
	readonly "right"?: number | undefined;
	readonly "target"?: string | undefined;
	readonly "visibilityHeight"?: number | undefined;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭