固钉 AsamAffix

使用场景

在滚动时把一小段操作固定到指定位置。

基础用法与状态

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

基础用法与状态

vue

<template>
	<div ref="scroll" class="affix-scroll">
		<div class="doc010-affix-region">
			<AsamAffix target=".doc010-affix-region" :offset="offset" @change="fixed = $event">
				<AsamButton type="default" native-type="button">固定操作</AsamButton>
			</AsamAffix>
			<p class="example-paragraph">滚动查看固定范围</p>
		</div>
	</div>
	<p class="example-paragraph" role="status">{{ fixed ? '操作已固定' : '向下滚动本区域以固定操作' }}</p>
</template>

<script lang="ts" setup>
defineOptions({ name: 'AsamAffixBasicDemo' });
import { AsamButton, AsamAffix } from '@asam-ui/ui';
import { onBeforeUnmount, onMounted, ref } from 'vue';
const scroll = ref<HTMLElement>();
const offset = ref(0);
const fixed = ref(false);
const updateOffset = () => {
	offset.value = (scroll.value?.getBoundingClientRect().top ?? 0) + 8;
};
onMounted(() => {
	updateOffset();
	window.addEventListener('resize', updateOffset);
	window.addEventListener('scroll', updateOffset, { passive: true });
});
onBeforeUnmount(() => {
	window.removeEventListener('resize', updateOffset);
	window.removeEventListener('scroll', updateOffset);
});
</script>

<style scoped>
.affix-scroll {
	height: 200px;
	overflow: auto;
}

.doc010-affix-region {
	height: 500px;
	padding: var(--asam-space-md);
}
</style>

<style scoped>
p:where(.example-paragraph) {
	margin-block: 16px;
	line-height: 1.8;
	overflow-wrap: anywhere;
}
</style>

vue

<template>
	<div ref="scroll" class="affix-scroll">
		<div class="doc010-affix-region">
			<AsamAffix target=".doc010-affix-region" :offset="offset" @change="fixed = $event">
				<AsamButton type="default" native-type="button">固定操作</AsamButton>
			</AsamAffix>
			<p class="example-paragraph">滚动查看固定范围</p>
		</div>
	</div>
	<p class="example-paragraph" role="status">{{ fixed ? '操作已固定' : '向下滚动本区域以固定操作' }}</p>
</template>

<script setup>
defineOptions({ name: 'AsamAffixBasicDemo' });
import { AsamButton, AsamAffix } from '@asam-ui/ui';
import { onBeforeUnmount, onMounted, ref } from 'vue';
const scroll = ref();
const offset = ref(0);
const fixed = ref(false);
const updateOffset = () => {
	offset.value = (scroll.value?.getBoundingClientRect().top ?? 0) + 8;
};
onMounted(() => {
	updateOffset();
	window.addEventListener('resize', updateOffset);
	window.addEventListener('scroll', updateOffset, { passive: true });
});
onBeforeUnmount(() => {
	window.removeEventListener('resize', updateOffset);
	window.removeEventListener('scroll', updateOffset);
});
</script>

<style scoped>
.affix-scroll {
	height: 200px;
	overflow: auto;
}

.doc010-affix-region {
	height: 500px;
	padding: var(--asam-space-md);
}
</style>

<style scoped>
p:where(.example-paragraph) {
	margin-block: 16px;
	line-height: 1.8;
	overflow-wrap: anywhere;
}
</style>

使用约定

position 与 offset 设置固定方向和视窗偏移，target 限定有效目标范围，zIndex 管理层级。完整说明。

完整使用场景

基础用法

固钉默认固定在页面顶部。

通过设置 offset 属性来改变吸顶距离，默认值为 0。

基础用法

许可

vue

<template>
	<AsamAffix :offset="120">
		<AsamButton type="default">顶部偏移 120px</AsamButton>
	</AsamAffix>
</template>

<script lang="ts" setup>
defineOptions({ name: 'AsamAffixCapBasicDemo' });
import { AsamAffix, AsamButton } from '@asam-ui/ui';
</script>

许可

vue

<template>
	<AsamAffix :offset="120">
		<AsamButton type="default">顶部偏移 120px</AsamButton>
	</AsamAffix>
</template>

<script setup>
defineOptions({ name: 'AsamAffixCapBasicDemo' });
import { AsamAffix, AsamButton } from '@asam-ui/ui';
</script>

指定容器

通过设置 target 属性，让固钉始终保持在容器内，超过范围则隐藏。

请注意容器避免出现滚动条。

目标

许可

vue

<template>
	<div class="affix-container">
		<AsamAffix target=".affix-container" :offset="80">
			<AsamButton type="default">目标容器</AsamButton>
		</AsamAffix>
	</div>
</template>

<script lang="ts" setup>
defineOptions({ name: 'AsamAffixCapTargetDemo' });
import { AsamAffix, AsamButton } from '@asam-ui/ui';
</script>

<style scoped>
.affix-container {
	text-align: center;
	height: 400px;
	border-radius: 4px;
	background: var(--el-color-primary-light-9);
}
</style>

许可

vue

<template>
	<div class="affix-container">
		<AsamAffix target=".affix-container" :offset="80">
			<AsamButton type="default">目标容器</AsamButton>
		</AsamAffix>
	</div>
</template>

<script setup>
defineOptions({ name: 'AsamAffixCapTargetDemo' });
import { AsamAffix, AsamButton } from '@asam-ui/ui';
</script>

<style scoped>
.affix-container {
	text-align: center;
	height: 400px;
	border-radius: 4px;
	background: var(--el-color-primary-light-9);
}
</style>

固定位置

Affix 组件提供 2 个固定的位置参数 top 和 bottom。

通过设置 position 属性来改变固定位置，默认值为 top 。

固定位置

许可

vue

<template>
	<AsamAffix position="bottom" :offset="20">
		<AsamButton type="default">底部偏移 20px</AsamButton>
	</AsamAffix>
</template>

<script lang="ts" setup>
defineOptions({ name: 'AsamAffixCapFixedDemo' });
import { AsamAffix, AsamButton } from '@asam-ui/ui';
</script>

许可

vue

<template>
	<AsamAffix position="bottom" :offset="20">
		<AsamButton type="default">底部偏移 20px</AsamButton>
	</AsamAffix>
</template>

<script setup>
defineOptions({ name: 'AsamAffixCapFixedDemo' });
import { AsamAffix, AsamButton } from '@asam-ui/ui';
</script>

局部与全局挂载

向下滚动使固钉进入固定状态，再切换公开 teleported 参数观察固定元素的挂载位置。该参数改变 DOM 挂载，不改变 target 的固定边界。开关显示当前模式，两个模式均可操作；关闭后可以再次切换。

许可

vue

<template>
	<div ref="mountTarget" class="popup-stage" :class="{ local: !globalPopup }">
		<div class="popup-mode">
			<ContainerSwitch
				v-model="globalPopup"
				active-text="全局挂载到 body"
				inactive-text="局部挂载到当前区域"
			/>
		</div>
		<AsamAffix :offset="120" :teleported="globalPopup">
			<AsamButton type="default">顶部偏移 120px</AsamButton>
		</AsamAffix>
	</div>
</template>

<script lang="ts" setup>
defineOptions({ name: 'AsamAffixCapBasicDemo' });
import { AsamAffix, AsamButton } from '@asam-ui/ui';

import { ref as containerRef } from 'vue';
import { AsamSwitch as ContainerSwitch } from '@asam-ui/ui';
const globalPopup = containerRef(true);
const mountTarget = containerRef<HTMLElement>();
</script>

<style scoped>
.popup-stage {
	position: relative;
	isolation: isolate;
	min-height: 140px;
	padding: var(--asam-space-md);
	border: 1px dashed var(--asam-color-border);
}

.popup-mode {
	margin-bottom: var(--asam-space-lg);
}
</style>

许可

vue

<template>
	<div ref="mountTarget" class="popup-stage" :class="{ local: !globalPopup }">
		<div class="popup-mode">
			<ContainerSwitch
				v-model="globalPopup"
				active-text="全局挂载到 body"
				inactive-text="局部挂载到当前区域"
			/>
		</div>
		<AsamAffix :offset="120" :teleported="globalPopup">
			<AsamButton type="default">顶部偏移 120px</AsamButton>
		</AsamAffix>
	</div>
</template>

<script setup>
defineOptions({ name: 'AsamAffixCapBasicDemo' });
import { AsamAffix, AsamButton } from '@asam-ui/ui';

import { ref as containerRef } from 'vue';
import { AsamSwitch as ContainerSwitch } from '@asam-ui/ui';
const globalPopup = containerRef(true);
const mountTarget = containerRef();
</script>

<style scoped>
.popup-stage {
	position: relative;
	isolation: isolate;
	min-height: 140px;
	padding: var(--asam-space-md);
	border: 1px dashed var(--asam-color-border);
}

.popup-mode {
	margin-bottom: var(--asam-space-lg);
}
</style>

API

属性 `AsamAffixProps`

属性名	说明	类型	默认值
`zIndex`	固定元素的 zIndex 值。	`enum"auto" \| "-moz-initial" \| "inherit" \| "initial" \| "revert" \| "revert-layer" \| "unset"`完整类型：`(AsamAffixProps)["zIndex"]`	`100`
`target`	指定容器（CSS 选择器）	`string \| undefined`	`""`
`offset`	偏移距离	`number \| undefined`	`0`
`position`	固钉位置	`enum"top" \| "bottom"`完整类型：`"top" \| "bottom" \| undefined`	`"top"`
`teleported`	Affix 元素是否使用 teleport 特性，设置为 true 将会使得该元素“传送”至 append-to 设置的位置	`boolean \| undefined`	`false`
`appendTo`	Affix 元素将被挂载至哪个元素	`string \| HTMLElement \| undefined`	`"body"`
`onScroll`	—	`((args_0: { scrollTop: number; fixed: boolean; }) => any) \| undefined`	—
`onChange`	—	`((fixed: boolean) => any) \| undefined`	—
`key`	—	`PropertyKey \| undefined`	—
`ref`	—	`VNodeRef \| undefined`	—
`ref_for`	—	`boolean \| undefined`	—
`ref_key`	—	`string \| undefined`	—
`onVnodeBeforeMount`	—	`(AsamAffixProps)["onVnodeBeforeMount"]`	—
`onVnodeMounted`	—	`(AsamAffixProps)["onVnodeMounted"]`	—
`onVnodeBeforeUpdate`	—	`(AsamAffixProps)["onVnodeBeforeUpdate"]`	—
`onVnodeUpdated`	—	`(AsamAffixProps)["onVnodeUpdated"]`	—
`onVnodeBeforeUnmount`	—	`(AsamAffixProps)["onVnodeBeforeUnmount"]`	—
`onVnodeUnmounted`	—	`(AsamAffixProps)["onVnodeUnmounted"]`	—
`class`	—	`unknown`	—
`style`	—	`unknown`	—

实例方法与状态 `AsamAffixExpose`

属性名	说明	类型	默认值
`$`	—	`AsamAffixExpose["$"]`	—
`$data`	—	`AsamTableColumnExpose`	—
`$props`	—	`AsamAffixProps`	—
`$attrs`	—	`AsamAffixExpose["$attrs"]`	—
`$refs`	—	`AsamAffixExpose["$refs"]`	—
`$slots`	—	`AsamAffixSlots`	—
`$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: "scroll", args_0: { scrollTop: number; fixed: boolean; }) => void) & ((event: "change", fixed: boolean) => void)`	—
`$el`	—	`any`	—
`$options`	—	`(AsamAffixExpose)["$options"]`	—
`$forceUpdate`	—	`() => void`	—
`$nextTick`	—	`(AsamAffixExpose)["$nextTick"]`	—
`$watch`	—	`(AsamAffixExpose)["$watch"]`	—
`position`	—	`enum"top" \| "bottom"`完整类型：`"top" \| "bottom"`	—
`target`	—	`string`	—
`zIndex`	—	`enum"auto" \| "-moz-initial" \| "inherit" \| "initial" \| "revert" \| "revert-layer" \| "unset"`完整类型：`(AsamAffixExpose)["zIndex"]`	—
`offset`	—	`number`	—
`appendTo`	—	`string \| HTMLElement`	—
`teleported`	Affix 元素是否使用 teleport 特性，设置为 true 将会使得该元素“传送”至 append-to 设置的位置	`boolean \| undefined`	—
`onScroll`	—	`((args_0: { scrollTop: number; fixed: boolean; }) => any) \| undefined`	—
`onChange`	—	`((fixed: boolean) => any) \| undefined`	—
`update`	更新固定状态。	`() => void`	—
`updateRoot`	—	`() => Promise<void>`	—
`$route`	当前规范化路由位置，详见 RouteLocationNormalizedLoaded。	`AsamAffixExpose["$route"]`	—
`$router`	应用使用的 Router 实例。	`AsamAffixExpose["$router"]`	—

类型 `AsamAffixInstance`

属性名	说明	类型	默认值
`$`	—	`AsamAffixExpose["$"]`	—
`$data`	—	`AsamTableColumnExpose`	—
`$props`	—	`AsamAffixProps`	—
`$attrs`	—	`AsamAffixExpose["$attrs"]`	—
`$refs`	—	`AsamAffixExpose["$refs"]`	—
`$slots`	—	`AsamAffixSlots`	—
`$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: "scroll", args_0: { scrollTop: number; fixed: boolean; }) => void) & ((event: "change", fixed: boolean) => void)`	—
`$el`	—	`any`	—
`$options`	—	`(AsamAffixInstance)["$options"]`	—
`$forceUpdate`	—	`() => void`	—
`$nextTick`	—	`(AsamAffixInstance)["$nextTick"]`	—
`$watch`	—	`(AsamAffixInstance)["$watch"]`	—
`position`	—	`enum"top" \| "bottom"`完整类型：`"top" \| "bottom"`	—
`target`	—	`string`	—
`zIndex`	—	`enum"auto" \| "-moz-initial" \| "inherit" \| "initial" \| "revert" \| "revert-layer" \| "unset"`完整类型：`(AsamAffixInstance)["zIndex"]`	—
`offset`	—	`number`	—
`appendTo`	—	`string \| HTMLElement`	—
`teleported`	Affix 元素是否使用 teleport 特性，设置为 true 将会使得该元素“传送”至 append-to 设置的位置	`boolean \| undefined`	—
`onScroll`	—	`((args_0: { scrollTop: number; fixed: boolean; }) => any) \| undefined`	—
`onChange`	—	`((fixed: boolean) => any) \| undefined`	—
`update`	更新固定状态。	`() => void`	—
`updateRoot`	—	`() => Promise<void>`	—
`$route`	当前规范化路由位置，详见 RouteLocationNormalizedLoaded。	`AsamAffixExpose["$route"]`	—
`$router`	应用使用的 Router 实例。	`AsamAffixExpose["$router"]`	—

插槽 `AsamAffixSlots`

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

事件 `AsamAffixEmits`

属性名	说明	类型	默认值
`scroll`	—	`({ scrollTop, fixed }: { scrollTop: number; fixed: boolean; }) => boolean`	—
`change`	—	`(fixed: boolean) => boolean`	—

类型 `AsamAffixPropsPublic`

属性名	说明	类型	默认值
`zIndex`	—	`enum"auto" \| "-moz-initial" \| "inherit" \| "initial" \| "revert" \| "revert-layer" \| "unset"`完整类型：`(AsamAffixPropsPublic)["zIndex"]`	—
`offset`	—	`number \| undefined`	—
`appendTo`	—	`(AsamAffixPropsPublic)["appendTo"]`	—
`teleported`	—	`boolean \| undefined`	—
`target`	—	`string \| undefined`	—
`position`	—	`enum"top" \| "bottom"`完整类型：`(AsamAffixPropsPublic)["position"]`	—

用法与契约补充说明

使用约定

position 与 offset 设置固定方向和视窗偏移，target 限定有效目标范围，zIndex 管理层级。示例把 offset 同步到滚动区域在视窗中的顶部，随页面滚动与窗口大小更新，并在卸载时清理监听。change/scroll 反馈固定和滚动状态，实例提供更新计算方法。固定内容应保持短小；宽高由内容布局决定，没有四档密度。

参数与事件补充说明

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

参数与事件说明

`zIndex`

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

zIndex 参数与事件数据

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

枚举："auto" / "-moz-initial" / "inherit" / "initial" / "revert" / "revert-layer" / "unset"

默认值与来源

100（已安装运行时；已安装组件）

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

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

`target`

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

默认值与来源

""（已安装运行时；已安装组件）

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

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

`offset`

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

默认值与来源

0（已安装运行时；已安装组件）

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

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

`position`

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

position 参数与事件数据

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

枚举："top" / "bottom"

默认值与来源

"top"（已安装运行时；已安装组件）

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

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

`teleported`

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

teleported 参数与事件数据

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

枚举：false / true

默认值与来源

false（隐式 Boolean 默认；已安装组件）

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

`appendTo`

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

appendTo 参数与事件数据

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

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

默认值与来源

"body"（已安装运行时；已安装组件）

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

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

`onScroll`

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

onScroll 参数与事件数据

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

事件参数：(args_0: { scrollTop: number; fixed: boolean; }): any

`onChange`

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

onChange 参数与事件数据

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

事件参数：(fixed: boolean): 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`

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

AsamAffixProps 公开类型视图

import type { VNodeRef, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, VNode, RendererNode, RendererElement } from 'vue';
import type { AsamAffixProps, AsamAffixExpose } from '@asam-ui/ui';

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

// AsamAffixProps
type PublicContract = {
	readonly "zIndex"?: (AsamAffixProps)["zIndex"];
	readonly "target"?: string | undefined;
	readonly "offset"?: number | undefined;
	readonly "position"?: "top" | "bottom" | undefined;
	readonly "teleported"?: boolean | undefined;
	readonly "appendTo"?: string | HTMLElement | undefined;
	readonly "onScroll"?: ((args_0: { scrollTop: number; fixed: boolean; }) => any) | undefined;
	readonly "onChange"?: ((fixed: boolean) => any) | undefined;
	"key"?: PropertyKey | undefined;
	"ref"?: VNodeRef | undefined;
	"ref_for"?: boolean | undefined;
	"ref_key"?: string | undefined;
	"onVnodeBeforeMount"?: (AsamAffixProps)["onVnodeBeforeMount"];
	"onVnodeMounted"?: (AsamAffixProps)["onVnodeMounted"];
	"onVnodeBeforeUpdate"?: (AsamAffixProps)["onVnodeBeforeUpdate"];
	"onVnodeUpdated"?: (AsamAffixProps)["onVnodeUpdated"];
	"onVnodeBeforeUnmount"?: (AsamAffixProps)["onVnodeBeforeUnmount"];
	"onVnodeUnmounted"?: (AsamAffixProps)["onVnodeUnmounted"];
	"class"?: unknown;
	"style"?: unknown;
};

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

参数与事件说明

`$`

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

$ 参数与事件数据

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

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

`$data`

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

`$props`

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

`$attrs`

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

$attrs 参数与事件数据

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

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

`$refs`

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

$refs 参数与事件数据

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

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

`$slots`

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

`$root`

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

`$parent`

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

`$host`

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

$host 参数与事件数据

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

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

`$emit`

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

$emit 参数与事件数据

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

事件参数：(event: "scroll", ...args: [args_0: { scrollTop: number; fixed: boolean; }]): void

事件参数：(event: "change", ...args: [fixed: boolean]): 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<(AsamAffixExpose)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

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

`position`

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

position 参数与事件数据

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

枚举："top" / "bottom"

`target`

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

`zIndex`

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

zIndex 参数与事件数据

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

枚举："auto" / "-moz-initial" / "inherit" / "initial" / "revert" / "revert-layer" / "unset"

`offset`

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

`appendTo`

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

appendTo 参数与事件数据

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

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

`teleported`

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

teleported 参数与事件数据

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

枚举：false / true

`onScroll`

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

onScroll 参数与事件数据

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

事件参数：(args_0: { scrollTop: number; fixed: boolean; }): any

`onChange`

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

onChange 参数与事件数据

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

事件参数：(fixed: boolean): any

`update`

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

update 参数与事件数据

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

事件参数：(): void

`updateRoot`

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

updateRoot 参数与事件数据

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

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

`$route`

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

$route 参数与事件数据

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

$route.matched: (NonNullable<AsamAffixExpose["$route"]>)["matched"] — 依赖声明
仅包含普通组件的 RouteLocationMatched 数组；懒加载组件已解析并替换 components 中的值，可直接展示路由，不包含重定向记录。此属性不可枚举。
嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。
$route.name: (NonNullable<AsamAffixExpose["$route"]>)["name"] — 依赖声明
匹配路由记录的名称。
$route.fullPath: string — 依赖声明
包含 search 和 hash 的完整位置字符串，使用百分号编码。
$route.query: (NonNullable<AsamAffixExpose["$route"]>)["query"] — 依赖声明
当前位置 search 属性的对象表示。
$route.hash: string — 依赖声明
当前位置的哈希片段；存在时以 # 开头。
$route.redirectedFrom: (NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"] — 依赖声明
最终到达当前位置之前，最初尝试访问的位置。
- $route.redirectedFrom.matched: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "matched"> — 依赖声明
  包含添加路由时原始组件的 RouteRecord 数组，也可能包含重定向记录，不能直接用于展示。此属性不可枚举。
  嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。
- $route.redirectedFrom.fullPath: string — 依赖声明
  包含 search 和 hash 的完整位置字符串，使用百分号编码。
- $route.redirectedFrom.query: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "query"> — 依赖声明
  当前位置 search 属性的对象表示。
- $route.redirectedFrom.hash: string — 依赖声明
  当前位置的哈希片段；存在时以 # 开头。
- $route.redirectedFrom.redirectedFrom: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "redirectedFrom"> — 依赖声明
  最终到达当前位置之前，最初尝试访问的位置。
  嵌套展开边界：递归引用；完整类型见公开类型视图。
- $route.redirectedFrom.name: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "name"> — 依赖声明
  匹配路由记录的名称。
- $route.redirectedFrom.meta: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "meta"> — 依赖声明
  全部匹配路由记录合并后的 meta 属性。
- $route.redirectedFrom.params: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$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<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "state"> — 依赖声明
  通过 History API 保存的状态；不能包含响应式值，也不允许 Symbol 等部分值。详情参见 https://developer.mozilla.org/zh-CN/docs/Web/API/History/state。
$route.meta: (NonNullable<AsamAffixExpose["$route"]>)["meta"] — 依赖声明
全部匹配路由记录合并后的 meta 属性。
$route.params: (NonNullable<AsamAffixExpose["$route"]>)["params"] — 依赖声明
从 path 提取并解码后的参数对象。
$route.path: string — 依赖声明
URL 中经过百分号编码的路径部分。

`$router`

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

$router 参数与事件数据

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

$router.options: (NonNullable<AsamAffixExpose["$router"]>)["options"] — 依赖声明
创建路由器时传入的原始配置对象。
- $router.options.routes: (NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["routes"] — 依赖声明
  需要添加到路由器的初始路由列表。
  嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。
- $router.options.history: (NonNullable<(NonNullable<AsamAffixExpose["$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<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["state"] — 依赖声明
    当前历史记录状态。
    嵌套展开边界：深度上限；完整类型见公开类型视图。
  - $router.options.history.push: (NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["push"] — 依赖声明
    导航到指定位置；使用 HTML5 History 时，通过 history.pushState 实际更新 URL。
    事件参数：(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["push"]>, (...args: never[]) => unknown>>[1]): void
    嵌套展开边界：深度上限；完整类型见公开类型视图。
  - $router.options.history.replace: (NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["replace"] — 依赖声明
    与 RouterHistory.push 类似，但调用 history.replaceState，而非 history.pushState。
    事件参数：(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$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<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["listen"] — 依赖声明
    为历史记录实现添加监听器；由浏览器前进、后退等外部导航，或传入 true 的 RouterHistory.back、RouterHistory.forward 触发。
    事件参数：(callback: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["listen"]>, (...args: never[]) => unknown>>[0]): () => void
    嵌套展开边界：深度上限；完整类型见公开类型视图。
  - $router.options.history.createHref: (location: AsamAffixExpose["target"]) => string — 依赖声明
    生成用于链接元素的对应 href。
    事件参数：(location: string): string
    嵌套展开边界：深度上限；完整类型见公开类型视图。
  - $router.options.history.destroy: () => void — 依赖声明
    清除历史记录实现注册的全部事件监听器。
    事件参数：(): void
    嵌套展开边界：深度上限；完整类型见公开类型视图。
- $router.options.scrollBehavior: (NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["scrollBehavior"] — 依赖声明
  控制页面导航时滚动行为的函数；可返回 Promise 延迟滚动。
  事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[0], from: AsamAffixExpose["$route"], savedPosition: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[2]): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>
- $router.options.parseQuery: (NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["parseQuery"] — 依赖声明
  自定义查询参数解析函数；与 EXPERIMENTAL_RouterOptions_Base.stringifyQuery 配套。
  事件参数：(search: string): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["parseQuery"]>, (...args: never[]) => unknown>>
- $router.options.stringifyQuery: (NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["stringifyQuery"] — 依赖声明
  自定义查询对象序列化函数；不要添加开头的 ?，与 parseQuery 的解析函数配套。
  事件参数：(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$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<AsamAffixExpose["$router"]>)["addRoute"] — 依赖声明
向已有路由添加子路由，或向路由器添加新的 RouteRecordRaw 路由记录。
事件参数完整签名见公开类型视图。
事件参数完整签名见公开类型视图。
$router.removeRoute: (NonNullable<AsamAffixExpose["$router"]>)["removeRoute"] — 依赖声明
按名称移除已有路由。
事件参数：(name: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["removeRoute"]>, (...args: never[]) => unknown>>[0]): void
$router.clearRoutes: () => void — 依赖声明
从路由器中删除全部路由。
事件参数：(): void
$router.currentRoute: ShallowRef<AsamAffixExpose["$route"]> — 依赖声明
当前 RouteLocationNormalized。
嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。
$router.listening: boolean — 依赖声明
允许关闭历史事件监听，这是用于微前端的底层 API。
枚举：false / true
$router.hasRoute: (NonNullable<AsamAffixExpose["$router"]>)["hasRoute"] — 依赖声明
检查指定名称的路由是否存在。
事件参数：(name: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["hasRoute"]>, (...args: never[]) => unknown>>[0]): boolean
$router.getRoutes: (NonNullable<AsamAffixExpose["$router"]>)["getRoutes"] — 依赖声明
获取全部 RouteRecord 路由记录的完整列表。
事件参数：(): ReturnType<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["getRoutes"]>, (...args: never[]) => unknown>>
$router.resolve: (NonNullable<AsamAffixExpose["$router"]>)["resolve"] — 依赖声明
返回 RouteLocationRaw 的规范化位置，包含带基础路径的 href；默认使用 router.currentRoute 作为 currentLocation，仅在高级场景中覆盖。
事件参数完整签名见公开类型视图。
事件参数完整签名见公开类型视图。
$router.push: (NonNullable<AsamAffixExpose["$router"]>)["push"] — 依赖声明
通过向历史栈添加记录，以编程方式导航到新 URL。
事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>
$router.replace: (NonNullable<AsamAffixExpose["$router"]>)["replace"] — 依赖声明
通过替换历史栈中的当前记录，以编程方式导航到新 URL。
事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamAffixExpose["$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<AsamAffixExpose["$router"]>)["beforeEach"] — 依赖声明
添加每次导航之前执行的守卫，并返回移除此守卫的函数。
事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["beforeEach"]>, (...args: never[]) => unknown>>[0]): () => void
$router.beforeResolve: (NonNullable<AsamAffixExpose["$router"]>)["beforeResolve"] — 依赖声明
添加导航确认之前执行的守卫，此时组件已获取且其他导航守卫已通过；返回移除此守卫的函数。
事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["beforeResolve"]>, (...args: never[]) => unknown>>[0]): () => void
$router.afterEach: (NonNullable<AsamAffixExpose["$router"]>)["afterEach"] — 依赖声明
添加每次导航结束后执行的钩子，并返回移除此钩子的函数。
事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["afterEach"]>, (...args: never[]) => unknown>>[0]): () => void
$router.onError: (NonNullable<AsamAffixExpose["$router"]>)["onError"] — 依赖声明
添加导航期间未捕获错误的处理函数，涵盖同步和异步异常、守卫返回或传给 next 的错误，以及路由异步组件解析错误。
事件参数：(handler: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$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

AsamAffixExpose 公开类型视图

import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamAffixExpose, AsamTableColumnExpose, AsamAffixProps, AsamAffixSlots } from '@asam-ui/ui';

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

// AsamAffixExpose
type PublicContract = {
	"$": AsamAffixExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamAffixProps;
	"$attrs": AsamAffixExpose["$attrs"];
	"$refs": AsamAffixExpose["$refs"];
	"$slots": AsamAffixSlots;
	"$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: "scroll", args_0: { scrollTop: number; fixed: boolean; }) => void) & ((event: "change", fixed: boolean) => void);
	"$el": any;
	"$options": (AsamAffixExpose)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamAffixExpose)["$nextTick"];
	"$watch": (AsamAffixExpose)["$watch"];
	readonly "position": "top" | "bottom";
	readonly "target": string;
	readonly "zIndex": (AsamAffixExpose)["zIndex"];
	readonly "offset": number;
	readonly "appendTo": string | HTMLElement;
	readonly "teleported"?: boolean | undefined;
	readonly "onScroll"?: ((args_0: { scrollTop: number; fixed: boolean; }) => any) | undefined;
	readonly "onChange"?: ((fixed: boolean) => any) | undefined;
	"update": () => void;
	"updateRoot": () => Promise<void>;
	"$route": AsamAffixExpose["$route"];
	"$router": AsamAffixExpose["$router"];
};

参数与事件说明

`$`

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

$ 参数与事件数据

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

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

`$data`

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

`$props`

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

`$attrs`

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

$attrs 参数与事件数据

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

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

`$refs`

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

$refs 参数与事件数据

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

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

`$slots`

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

`$root`

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

`$parent`

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

`$host`

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

$host 参数与事件数据

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

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

`$emit`

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

$emit 参数与事件数据

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

事件参数：(event: "scroll", ...args: [args_0: { scrollTop: number; fixed: boolean; }]): void

事件参数：(event: "change", ...args: [fixed: boolean]): 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<(AsamAffixInstance)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

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

`position`

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

position 参数与事件数据

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

枚举："top" / "bottom"

`target`

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

`zIndex`

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

zIndex 参数与事件数据

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

枚举："auto" / "-moz-initial" / "inherit" / "initial" / "revert" / "revert-layer" / "unset"

`offset`

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

`appendTo`

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

appendTo 参数与事件数据

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

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

`teleported`

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

teleported 参数与事件数据

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

枚举：false / true

`onScroll`

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

onScroll 参数与事件数据

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

事件参数：(args_0: { scrollTop: number; fixed: boolean; }): any

`onChange`

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

onChange 参数与事件数据

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

事件参数：(fixed: boolean): any

`update`

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

update 参数与事件数据

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

事件参数：(): void

`updateRoot`

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

updateRoot 参数与事件数据

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

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

`$route`

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

$route 参数与事件数据

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

$route.matched: (NonNullable<AsamAffixExpose["$route"]>)["matched"] — 依赖声明
仅包含普通组件的 RouteLocationMatched 数组；懒加载组件已解析并替换 components 中的值，可直接展示路由，不包含重定向记录。此属性不可枚举。
嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。
$route.name: (NonNullable<AsamAffixExpose["$route"]>)["name"] — 依赖声明
匹配路由记录的名称。
$route.fullPath: string — 依赖声明
包含 search 和 hash 的完整位置字符串，使用百分号编码。
$route.query: (NonNullable<AsamAffixExpose["$route"]>)["query"] — 依赖声明
当前位置 search 属性的对象表示。
$route.hash: string — 依赖声明
当前位置的哈希片段；存在时以 # 开头。
$route.redirectedFrom: (NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"] — 依赖声明
最终到达当前位置之前，最初尝试访问的位置。
- $route.redirectedFrom.matched: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "matched"> — 依赖声明
  包含添加路由时原始组件的 RouteRecord 数组，也可能包含重定向记录，不能直接用于展示。此属性不可枚举。
  嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。
- $route.redirectedFrom.fullPath: string — 依赖声明
  包含 search 和 hash 的完整位置字符串，使用百分号编码。
- $route.redirectedFrom.query: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "query"> — 依赖声明
  当前位置 search 属性的对象表示。
- $route.redirectedFrom.hash: string — 依赖声明
  当前位置的哈希片段；存在时以 # 开头。
- $route.redirectedFrom.redirectedFrom: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "redirectedFrom"> — 依赖声明
  最终到达当前位置之前，最初尝试访问的位置。
  嵌套展开边界：递归引用；完整类型见公开类型视图。
- $route.redirectedFrom.name: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "name"> — 依赖声明
  匹配路由记录的名称。
- $route.redirectedFrom.meta: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "meta"> — 依赖声明
  全部匹配路由记录合并后的 meta 属性。
- $route.redirectedFrom.params: PublicMember<NonNullable<(NonNullable<AsamAffixExpose["$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<AsamAffixExpose["$route"]>)["redirectedFrom"]>, "state"> — 依赖声明
  通过 History API 保存的状态；不能包含响应式值，也不允许 Symbol 等部分值。详情参见 https://developer.mozilla.org/zh-CN/docs/Web/API/History/state。
$route.meta: (NonNullable<AsamAffixExpose["$route"]>)["meta"] — 依赖声明
全部匹配路由记录合并后的 meta 属性。
$route.params: (NonNullable<AsamAffixExpose["$route"]>)["params"] — 依赖声明
从 path 提取并解码后的参数对象。
$route.path: string — 依赖声明
URL 中经过百分号编码的路径部分。

`$router`

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

$router 参数与事件数据

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

$router.options: (NonNullable<AsamAffixExpose["$router"]>)["options"] — 依赖声明
创建路由器时传入的原始配置对象。
- $router.options.routes: (NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["routes"] — 依赖声明
  需要添加到路由器的初始路由列表。
  嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。
- $router.options.history: (NonNullable<(NonNullable<AsamAffixExpose["$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<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["state"] — 依赖声明
    当前历史记录状态。
    嵌套展开边界：深度上限；完整类型见公开类型视图。
  - $router.options.history.push: (NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["push"] — 依赖声明
    导航到指定位置；使用 HTML5 History 时，通过 history.pushState 实际更新 URL。
    事件参数：(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["push"]>, (...args: never[]) => unknown>>[1]): void
    嵌套展开边界：深度上限；完整类型见公开类型视图。
  - $router.options.history.replace: (NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["replace"] — 依赖声明
    与 RouterHistory.push 类似，但调用 history.replaceState，而非 history.pushState。
    事件参数：(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$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<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["listen"] — 依赖声明
    为历史记录实现添加监听器；由浏览器前进、后退等外部导航，或传入 true 的 RouterHistory.back、RouterHistory.forward 触发。
    事件参数：(callback: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["history"]>)["listen"]>, (...args: never[]) => unknown>>[0]): () => void
    嵌套展开边界：深度上限；完整类型见公开类型视图。
  - $router.options.history.createHref: (location: AsamAffixExpose["target"]) => string — 依赖声明
    生成用于链接元素的对应 href。
    事件参数：(location: string): string
    嵌套展开边界：深度上限；完整类型见公开类型视图。
  - $router.options.history.destroy: () => void — 依赖声明
    清除历史记录实现注册的全部事件监听器。
    事件参数：(): void
    嵌套展开边界：深度上限；完整类型见公开类型视图。
- $router.options.scrollBehavior: (NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["scrollBehavior"] — 依赖声明
  控制页面导航时滚动行为的函数；可返回 Promise 延迟滚动。
  事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[0], from: AsamAffixExpose["$route"], savedPosition: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[2]): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>
- $router.options.parseQuery: (NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["parseQuery"] — 依赖声明
  自定义查询参数解析函数；与 EXPERIMENTAL_RouterOptions_Base.stringifyQuery 配套。
  事件参数：(search: string): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["parseQuery"]>, (...args: never[]) => unknown>>
- $router.options.stringifyQuery: (NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["options"]>)["stringifyQuery"] — 依赖声明
  自定义查询对象序列化函数；不要添加开头的 ?，与 parseQuery 的解析函数配套。
  事件参数：(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamAffixExpose["$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<AsamAffixExpose["$router"]>)["addRoute"] — 依赖声明
向已有路由添加子路由，或向路由器添加新的 RouteRecordRaw 路由记录。
事件参数完整签名见公开类型视图。
事件参数完整签名见公开类型视图。
$router.removeRoute: (NonNullable<AsamAffixExpose["$router"]>)["removeRoute"] — 依赖声明
按名称移除已有路由。
事件参数：(name: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["removeRoute"]>, (...args: never[]) => unknown>>[0]): void
$router.clearRoutes: () => void — 依赖声明
从路由器中删除全部路由。
事件参数：(): void
$router.currentRoute: ShallowRef<AsamAffixExpose["$route"]> — 依赖声明
当前 RouteLocationNormalized。
嵌套展开边界：框架 / 平台类型；完整类型见公开类型视图。
$router.listening: boolean — 依赖声明
允许关闭历史事件监听，这是用于微前端的底层 API。
枚举：false / true
$router.hasRoute: (NonNullable<AsamAffixExpose["$router"]>)["hasRoute"] — 依赖声明
检查指定名称的路由是否存在。
事件参数：(name: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["hasRoute"]>, (...args: never[]) => unknown>>[0]): boolean
$router.getRoutes: (NonNullable<AsamAffixExpose["$router"]>)["getRoutes"] — 依赖声明
获取全部 RouteRecord 路由记录的完整列表。
事件参数：(): ReturnType<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["getRoutes"]>, (...args: never[]) => unknown>>
$router.resolve: (NonNullable<AsamAffixExpose["$router"]>)["resolve"] — 依赖声明
返回 RouteLocationRaw 的规范化位置，包含带基础路径的 href；默认使用 router.currentRoute 作为 currentLocation，仅在高级场景中覆盖。
事件参数完整签名见公开类型视图。
事件参数完整签名见公开类型视图。
$router.push: (NonNullable<AsamAffixExpose["$router"]>)["push"] — 依赖声明
通过向历史栈添加记录，以编程方式导航到新 URL。
事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>
$router.replace: (NonNullable<AsamAffixExpose["$router"]>)["replace"] — 依赖声明
通过替换历史栈中的当前记录，以编程方式导航到新 URL。
事件参数：(to: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamAffixExpose["$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<AsamAffixExpose["$router"]>)["beforeEach"] — 依赖声明
添加每次导航之前执行的守卫，并返回移除此守卫的函数。
事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["beforeEach"]>, (...args: never[]) => unknown>>[0]): () => void
$router.beforeResolve: (NonNullable<AsamAffixExpose["$router"]>)["beforeResolve"] — 依赖声明
添加导航确认之前执行的守卫，此时组件已获取且其他导航守卫已通过；返回移除此守卫的函数。
事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["beforeResolve"]>, (...args: never[]) => unknown>>[0]): () => void
$router.afterEach: (NonNullable<AsamAffixExpose["$router"]>)["afterEach"] — 依赖声明
添加每次导航结束后执行的钩子，并返回移除此钩子的函数。
事件参数：(guard: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$router"]>)["afterEach"]>, (...args: never[]) => unknown>>[0]): () => void
$router.onError: (NonNullable<AsamAffixExpose["$router"]>)["onError"] — 依赖声明
添加导航期间未捕获错误的处理函数，涵盖同步和异步异常、守卫返回或传给 next 的错误，以及路由异步组件解析错误。
事件参数：(handler: Parameters<Extract<NonNullable<(NonNullable<AsamAffixExpose["$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

AsamAffixInstance 公开类型视图

import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamAffixInstance, AsamAffixExpose, AsamTableColumnExpose, AsamAffixProps, AsamAffixSlots } from '@asam-ui/ui';

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

// AsamAffixInstance
type PublicContract = {
	"$": AsamAffixExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamAffixProps;
	"$attrs": AsamAffixExpose["$attrs"];
	"$refs": AsamAffixExpose["$refs"];
	"$slots": AsamAffixSlots;
	"$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: "scroll", args_0: { scrollTop: number; fixed: boolean; }) => void) & ((event: "change", fixed: boolean) => void);
	"$el": any;
	"$options": (AsamAffixInstance)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamAffixInstance)["$nextTick"];
	"$watch": (AsamAffixInstance)["$watch"];
	readonly "position": "top" | "bottom";
	readonly "target": string;
	readonly "zIndex": (AsamAffixInstance)["zIndex"];
	readonly "offset": number;
	readonly "appendTo": string | HTMLElement;
	readonly "teleported"?: boolean | undefined;
	readonly "onScroll"?: ((args_0: { scrollTop: number; fixed: boolean; }) => any) | undefined;
	readonly "onChange"?: ((fixed: boolean) => any) | undefined;
	"update": () => void;
	"updateRoot": () => Promise<void>;
	"$route": AsamAffixExpose["$route"];
	"$router": AsamAffixExpose["$router"];
};

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

参数与事件说明

`default`

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

default 参数与事件数据

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

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

AsamAffixSlots 公开类型视图

import type { AsamAffixSlots, AsamAffixExpose, AsamTableColumnExpose } from '@asam-ui/ui';

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

参数与事件说明

`scroll`

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

scroll 参数与事件数据

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

事件参数：(__0: { scrollTop: number; fixed: boolean; }): boolean

`change`

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

change 参数与事件数据

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

事件参数：(fixed: boolean): boolean

AsamAffixEmits 公开类型视图

import type { AsamAffixEmits } from '@asam-ui/ui';

// AsamAffixEmits
type PublicContract = {
	"scroll": ({ scrollTop, fixed }: { scrollTop: number; fixed: boolean; }) => boolean;
	"change": (fixed: boolean) => boolean;
};

参数与事件说明

`zIndex`

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

zIndex 参数与事件数据

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

枚举："auto" / "-moz-initial" / "inherit" / "initial" / "revert" / "revert-layer" / "unset"

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

默认值与来源

未知 / 未声明

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

`offset`

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

默认值与来源

未知 / 未声明

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

`appendTo`

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

appendTo 参数与事件数据

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

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

默认值与来源

未知 / 未声明

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

`teleported`

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

teleported 参数与事件数据

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

枚举：false / true

`target`

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

默认值与来源

未知 / 未声明

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

`position`

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

position 参数与事件数据

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

枚举："top" / "bottom"

默认值与来源

未知 / 未声明

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

AsamAffixPropsPublic 公开类型视图

import type { AsamAffixPropsPublic, AsamAffixProps } from '@asam-ui/ui';

// AsamAffixPropsPublic
type PublicContract = {
	readonly "zIndex"?: (AsamAffixPropsPublic)["zIndex"];
	readonly "offset"?: number | undefined;
	readonly "appendTo"?: (AsamAffixPropsPublic)["appendTo"];
	readonly "teleported"?: boolean | undefined;
	readonly "target"?: string | undefined;
	readonly "position"?: (AsamAffixPropsPublic)["position"];
};

使用场景 ​

基础用法与状态 ​

基础用法与状态

使用约定 ​

完整使用场景 ​

基础用法 ​

基础用法

指定容器 ​

目标

固定位置 ​

固定位置

局部与全局挂载 ​

局部与全局挂载

API

属性 AsamAffixProps

实例方法与状态 AsamAffixExpose

类型 AsamAffixInstance

插槽 AsamAffixSlots

事件 AsamAffixEmits

类型 AsamAffixPropsPublic

用法与契约补充说明 ​

使用约定 ​

关联组件

参数与事件说明

zIndex

默认值与来源

target

默认值与来源

offset

默认值与来源

position

默认值与来源

teleported

默认值与来源

appendTo

默认值与来源

onScroll

onChange

key

ref

ref_for

ref_key

onVnodeBeforeMount

onVnodeMounted

onVnodeBeforeUpdate

onVnodeUpdated

onVnodeBeforeUnmount

onVnodeUnmounted

class

style

参数与事件说明

$

$data

$props

$attrs

$refs

$slots

$root

$parent

$host

$emit

$el

$options

$forceUpdate

$nextTick

$watch

position

target

zIndex

offset

appendTo

teleported

onScroll

onChange

update

updateRoot

$route

$router

参数与事件说明

使用场景

基础用法与状态

使用约定

完整使用场景

基础用法

指定容器

固定位置

局部与全局挂载

属性 `AsamAffixProps`

实例方法与状态 `AsamAffixExpose`

类型 `AsamAffixInstance`

插槽 `AsamAffixSlots`

事件 `AsamAffixEmits`

类型 `AsamAffixPropsPublic`

用法与契约补充说明

使用约定

`zIndex`

`target`

`offset`

`position`

`teleported`

`appendTo`

`onScroll`

`onChange`

`key`

`ref`

`ref_for`

`ref_key`

`onVnodeBeforeMount`

`onVnodeMounted`

`onVnodeBeforeUpdate`

`onVnodeUpdated`

`onVnodeBeforeUnmount`

`onVnodeUnmounted`

`class`

`style`

`$`

`$data`

`$props`

`$attrs`

`$refs`

`$slots`

`$root`

`$parent`

`$host`

`$emit`

`$el`

`$options`

`$forceUpdate`

`$nextTick`

`$watch`

`position`

`target`

`zIndex`

`offset`

`appendTo`

`teleported`

`onScroll`

`onChange`

`update`

`updateRoot`

`$route`

`$router`

`$`

`$data`

`$props`

`$attrs`

`$refs`

`$slots`

`$root`

`$parent`

`$host`

`$emit`

`$el`

`$options`

`$forceUpdate`

`$nextTick`

`$watch`

`position`

`target`