使用场景 ​
用 24 列栅格组织响应式内容。
基础用法与状态 ​
下列示例只使用本入口的实际公开能力。
基础用法与状态
<template>
<AsamRow :gutter="16">
<AsamCol :xs="24" :sm="12">
<div class="panel">窄屏整行,宽屏半行</div>
</AsamCol>
<AsamCol :xs="24" :sm="12">
<div class="panel">响应式第二列</div>
</AsamCol>
</AsamRow>
</template>
<script lang="ts" setup>
defineOptions({ name: 'AsamColBasicDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style scoped>
.panel {
padding: var(--asam-space-md);
background: var(--asam-color-surface);
border: 1px solid var(--asam-color-border);
}
</style>
<template>
<AsamRow :gutter="16">
<AsamCol :xs="24" :sm="12">
<div class="panel">窄屏整行,宽屏半行</div>
</AsamCol>
<AsamCol :xs="24" :sm="12">
<div class="panel">响应式第二列</div>
</AsamCol>
</AsamRow>
</template>
<script setup>
defineOptions({ name: 'AsamColBasicDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style scoped>
.panel {
padding: var(--asam-space-md);
background: var(--asam-color-surface);
border: 1px solid var(--asam-color-border);
}
</style>
使用约定 ​
span/offset/push/pull 和 xs/sm/md/lg/xl 控制列宽、位置与断点。列应在 AsamRow 中使用,default 插槽放实际内容;断点是布局行为,没有四档控件 size。
完整使用场景 ​
基础布局 ​
使用列创建基础网格布局。
通过 row 和 col 组件,并通过 col 组件的 span 属性我们就可以自由地组合布局。
基础布局
<template>
<AsamRow>
<AsamCol :span="24">
<div class="grid-content ep-bg-purple-dark" />
</AsamCol>
</AsamRow>
<AsamRow>
<AsamCol :span="12">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="12">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
</AsamRow>
<AsamRow>
<AsamCol :span="8">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="8">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
<AsamCol :span="8">
<div class="grid-content ep-bg-purple" />
</AsamCol>
</AsamRow>
<AsamRow>
<AsamCol :span="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="6">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
<AsamCol :span="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="6">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
</AsamRow>
<AsamRow>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
</AsamRow>
</template>
<script lang="ts" setup>
defineOptions({ name: 'AsamColCapBasicLayoutDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-row {
margin-bottom: 20px;
}
.el-row:last-child {
margin-bottom: 0;
}
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
<template>
<AsamRow>
<AsamCol :span="24">
<div class="grid-content ep-bg-purple-dark" />
</AsamCol>
</AsamRow>
<AsamRow>
<AsamCol :span="12">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="12">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
</AsamRow>
<AsamRow>
<AsamCol :span="8">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="8">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
<AsamCol :span="8">
<div class="grid-content ep-bg-purple" />
</AsamCol>
</AsamRow>
<AsamRow>
<AsamCol :span="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="6">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
<AsamCol :span="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="6">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
</AsamRow>
<AsamRow>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="4">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
</AsamRow>
</template>
<script setup>
defineOptions({ name: 'AsamColCapBasicLayoutDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-row {
margin-bottom: 20px;
}
.el-row:last-child {
margin-bottom: 0;
}
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
分栏间隔 ​
支持列间距。
行提供 gutter 属性来指定列之间的间距,其默认值为0。
分栏间隔
<template>
<AsamRow :gutter="20">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
</template>
<script lang="ts" setup>
defineOptions({ name: 'AsamColCapColumnSpacingDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-row {
margin-bottom: 20px;
}
.el-row:last-child {
margin-bottom: 0;
}
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
<template>
<AsamRow :gutter="20">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
</template>
<script setup>
defineOptions({ name: 'AsamColCapColumnSpacingDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-row {
margin-bottom: 20px;
}
.el-row:last-child {
margin-bottom: 0;
}
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
混合布局 ​
通过基础的 1/24 分栏任意扩展组合形成较为复杂的混合布局。
混合布局
<template>
<AsamRow :gutter="20">
<AsamCol :span="16"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="8"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow :gutter="20">
<AsamCol :span="8"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="8"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="4"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="4"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow :gutter="20">
<AsamCol :span="4"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="16"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="4"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
</template>
<script lang="ts" setup>
defineOptions({ name: 'AsamColCapHybridLayoutDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-row {
margin-bottom: 20px;
}
.el-row:last-child {
margin-bottom: 0;
}
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
<template>
<AsamRow :gutter="20">
<AsamCol :span="16"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="8"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow :gutter="20">
<AsamCol :span="8"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="8"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="4"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="4"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow :gutter="20">
<AsamCol :span="4"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="16"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="4"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
</template>
<script setup>
defineOptions({ name: 'AsamColCapHybridLayoutDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-row {
margin-bottom: 20px;
}
.el-row:last-child {
margin-bottom: 0;
}
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
列偏移 ​
您可以指定列偏移量。
通过制定 col 组件的 offset 属性可以指定分栏偏移的栏数。
列偏移
<template>
<AsamRow :gutter="20">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6" :offset="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
</AsamRow>
<AsamRow :gutter="20">
<AsamCol :span="6" :offset="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="6" :offset="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
</AsamRow>
<AsamRow :gutter="20">
<AsamCol :span="12" :offset="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
</AsamRow>
</template>
<script lang="ts" setup>
defineOptions({ name: 'AsamColCapColumnOffsetDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-row {
margin-bottom: 20px;
}
.el-row:last-child {
margin-bottom: 0;
}
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
<template>
<AsamRow :gutter="20">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6" :offset="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
</AsamRow>
<AsamRow :gutter="20">
<AsamCol :span="6" :offset="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :span="6" :offset="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
</AsamRow>
<AsamRow :gutter="20">
<AsamCol :span="12" :offset="6">
<div class="grid-content ep-bg-purple" />
</AsamCol>
</AsamRow>
</template>
<script setup>
defineOptions({ name: 'AsamColCapColumnOffsetDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-row {
margin-bottom: 20px;
}
.el-row:last-child {
margin-bottom: 0;
}
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
对齐方式 ​
默认使用 flex 布局来对分栏进行灵活的对齐。
您可以通过justify 属性来定义子元素的排版方式,其取值为start、center、end、space-between、space-around或space-evenly。
对齐方式
<template>
<AsamRow class="row-bg">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow class="row-bg" justify="center">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow class="row-bg" justify="end">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow class="row-bg" justify="space-between">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow class="row-bg" justify="space-around">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow class="row-bg" justify="space-evenly">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
</template>
<script lang="ts" setup>
defineOptions({ name: 'AsamColCapAlignmentDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-row {
margin-bottom: 20px;
}
.el-row:last-child {
margin-bottom: 0;
}
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
<template>
<AsamRow class="row-bg">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow class="row-bg" justify="center">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow class="row-bg" justify="end">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow class="row-bg" justify="space-between">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow class="row-bg" justify="space-around">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
<AsamRow class="row-bg" justify="space-evenly">
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple-light" /></AsamCol>
<AsamCol :span="6"><div class="grid-content ep-bg-purple" /></AsamCol>
</AsamRow>
</template>
<script setup>
defineOptions({ name: 'AsamColCapAlignmentDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-row {
margin-bottom: 20px;
}
.el-row:last-child {
margin-bottom: 0;
}
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
响应式布局 ​
参考 Bootstrap 的响应式设计,预设以下五种断点:
xs、sm、md、lg 和 xl。
响应式布局
<template>
<AsamRow :gutter="10">
<AsamCol :xs="8" :sm="6" :md="4" :lg="3" :xl="1">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :xs="4" :sm="6" :md="8" :lg="9" :xl="11">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
<AsamCol :xs="4" :sm="6" :md="8" :lg="9" :xl="11">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :xs="8" :sm="6" :md="4" :lg="3" :xl="1">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
</AsamRow>
</template>
<script lang="ts" setup>
defineOptions({ name: 'AsamColCapResponsiveLayoutDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
<template>
<AsamRow :gutter="10">
<AsamCol :xs="8" :sm="6" :md="4" :lg="3" :xl="1">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :xs="4" :sm="6" :md="8" :lg="9" :xl="11">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
<AsamCol :xs="4" :sm="6" :md="8" :lg="9" :xl="11">
<div class="grid-content ep-bg-purple" />
</AsamCol>
<AsamCol :xs="8" :sm="6" :md="4" :lg="3" :xl="1">
<div class="grid-content ep-bg-purple-light" />
</AsamCol>
</AsamRow>
</template>
<script setup>
defineOptions({ name: 'AsamColCapResponsiveLayoutDemo' });
import { AsamRow, AsamCol } from '@asam-ui/ui';
</script>
<style>
.el-col {
border-radius: 4px;
}
.grid-content {
border-radius: 4px;
min-height: 36px;
}
</style>
API
属性 AsamColProps
| 属性名 | 说明 | 类型 | 默认值 |
|---|---|---|---|
tag | 自定义元素标签 | string | undefined | "div" |
span | 栅格占据的列数 | number | undefined | 24 |
offset | 栅格左侧的间隔格数 | number | undefined | 0 |
pull | 栅格向左移动格数 | number | undefined | 0 |
push | 栅格向右移动格数 | number | undefined | 0 |
xs | ≥768px 响应式栅格数或者栅格属性对象 | AsamColSize | undefined | 工厂函数(每个实例创建) |
sm | ≥768px 响应式栅格数或者栅格属性对象 | AsamColSize | undefined | 工厂函数(每个实例创建) |
md | ≥992px 响应式栅格数或者栅格属性对象 | AsamColSize | undefined | 工厂函数(每个实例创建) |
lg | ≥1200px 响应式栅格数或者栅格属性对象 | AsamColSize | undefined | 工厂函数(每个实例创建) |
xl | ≥1920px 响应式栅格数或者栅格属性对象 | AsamColSize | undefined | 工厂函数(每个实例创建) |
key | — | PropertyKey | undefined | — |
ref | — | VNodeRef | undefined | — |
ref_for | — | boolean | undefined | — |
ref_key | — | string | undefined | — |
onVnodeBeforeMount | — | (AsamColProps)["onVnodeBeforeMount"] | — |
onVnodeMounted | — | (AsamColProps)["onVnodeMounted"] | — |
onVnodeBeforeUpdate | — | (AsamColProps)["onVnodeBeforeUpdate"] | — |
onVnodeUpdated | — | (AsamColProps)["onVnodeUpdated"] | — |
onVnodeBeforeUnmount | — | (AsamColProps)["onVnodeBeforeUnmount"] | — |
onVnodeUnmounted | — | (AsamColProps)["onVnodeUnmounted"] | — |
class | — | unknown | — |
style | — | unknown | — |
实例方法与状态 AsamColExpose
| 属性名 | 说明 | 类型 | 默认值 |
|---|---|---|---|
$ | — | AsamColExpose["$"] | — |
$data | — | AsamTableColumnExpose | — |
$props | — | AsamColProps | — |
$attrs | — | AsamColExpose["$attrs"] | — |
$refs | — | AsamColExpose["$refs"] | — |
$slots | — | AsamColSlots | — |
$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: string, ...args: any[]) => void | — |
$el | — | any | — |
$options | — | (AsamColExpose)["$options"] | — |
$forceUpdate | — | () => void | — |
$nextTick | — | (AsamColExpose)["$nextTick"] | — |
$watch | — | (AsamColExpose)["$watch"] | — |
push | — | number | — |
tag | — | string | — |
span | — | number | — |
offset | — | number | — |
pull | — | number | — |
xs | — | AsamColSize | — |
sm | — | AsamColSize | — |
md | — | AsamColSize | — |
lg | — | AsamColSize | — |
xl | — | AsamColSize | — |
$route | 当前规范化路由位置,详见 RouteLocationNormalizedLoaded。 | AsamColExpose["$route"] | — |
$router | 应用使用的 Router 实例。 | AsamColExpose["$router"] | — |
类型 AsamColInstance
| 属性名 | 说明 | 类型 | 默认值 |
|---|---|---|---|
$ | — | AsamColExpose["$"] | — |
$data | — | AsamTableColumnExpose | — |
$props | — | AsamColProps | — |
$attrs | — | AsamColExpose["$attrs"] | — |
$refs | — | AsamColExpose["$refs"] | — |
$slots | — | AsamColSlots | — |
$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: string, ...args: any[]) => void | — |
$el | — | any | — |
$options | — | (AsamColInstance)["$options"] | — |
$forceUpdate | — | () => void | — |
$nextTick | — | (AsamColInstance)["$nextTick"] | — |
$watch | — | (AsamColInstance)["$watch"] | — |
push | — | number | — |
tag | — | string | — |
span | — | number | — |
offset | — | number | — |
pull | — | number | — |
xs | — | AsamColSize | — |
sm | — | AsamColSize | — |
md | — | AsamColSize | — |
lg | — | AsamColSize | — |
xl | — | AsamColSize | — |
$route | 当前规范化路由位置,详见 RouteLocationNormalizedLoaded。 | AsamColExpose["$route"] | — |
$router | 应用使用的 Router 实例。 | AsamColExpose["$router"] | — |
插槽 AsamColSlots
| 属性名 | 说明 | 类型 | 默认值 |
|---|---|---|---|
default | — | (AsamColSlots)["default"] | — |
类型 AsamColPropsPublic
| 属性名 | 说明 | 类型 | 默认值 |
|---|---|---|---|
offset | — | number | undefined | — |
push | — | number | undefined | — |
tag | — | string | undefined | — |
span | — | number | undefined | — |
pull | — | number | undefined | — |
xs | — | (AsamColPropsPublic)["xs"] | — |
sm | — | (AsamColPropsPublic)["sm"] | — |
md | — | (AsamColPropsPublic)["md"] | — |
lg | — | (AsamColPropsPublic)["lg"] | — |
xl | — | (AsamColPropsPublic)["xl"] | — |
类型 AsamColSize
| 属性名 | 说明 | 类型 | 默认值 |
|---|---|---|---|
span | — | number | undefined | — |
offset | — | number | undefined | — |
pull | — | number | undefined | — |
push | — | number | undefined | — |
类型 AsamColSizeObject
| 属性名 | 说明 | 类型 | 默认值 |
|---|---|---|---|
span | — | number | undefined | — |
offset | — | number | undefined | — |
pull | — | number | undefined | — |
push | — | number | undefined | — |
关联组件
参数与事件补充说明
公开绑定参数,包含具备类型的事件监听器;默认值由运行时定义提供。
参数与事件说明
tag
必填:否;声明来源:上游声明。
默认值与来源
"div"(已安装运行时;已安装组件)固定上游源码默认表达式:'div'(2.14.7;源码事实,未作为 ASAM 运行实测)
span
必填:否;声明来源:上游声明。
默认值与来源
24(已安装运行时;已安装组件)固定上游源码默认表达式:24(2.14.7;源码事实,未作为 ASAM 运行实测)
offset
必填:否;声明来源:上游声明。
默认值与来源
0(已安装运行时;已安装组件)固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
pull
必填:否;声明来源:上游声明。
默认值与来源
0(已安装运行时;已安装组件)固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
push
必填:否;声明来源:上游声明。
默认值与来源
0(已安装运行时;已安装组件)固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
xs
必填:否;声明来源:上游声明。
xs 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
xs.span:number | undefined— 上游声明xs.offset:number | undefined— 上游声明xs.pull:number | undefined— 上游声明xs.push:number | undefined— 上游声明
默认值与来源
工厂函数(每个实例创建)(实例工厂;已安装组件)固定上游源码工厂(未执行):() => mutable({} as const)(2.14.7;源码事实,未作为 ASAM 运行实测)
sm
必填:否;声明来源:上游声明。
sm 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
sm.span:number | undefined— 上游声明sm.offset:number | undefined— 上游声明sm.pull:number | undefined— 上游声明sm.push:number | undefined— 上游声明
默认值与来源
工厂函数(每个实例创建)(实例工厂;已安装组件)固定上游源码工厂(未执行):() => mutable({} as const)(2.14.7;源码事实,未作为 ASAM 运行实测)
md
必填:否;声明来源:上游声明。
md 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
md.span:number | undefined— 上游声明md.offset:number | undefined— 上游声明md.pull:number | undefined— 上游声明md.push:number | undefined— 上游声明
默认值与来源
工厂函数(每个实例创建)(实例工厂;已安装组件)固定上游源码工厂(未执行):() => mutable({} as const)(2.14.7;源码事实,未作为 ASAM 运行实测)
lg
必填:否;声明来源:上游声明。
lg 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
lg.span:number | undefined— 上游声明lg.offset:number | undefined— 上游声明lg.pull:number | undefined— 上游声明lg.push:number | undefined— 上游声明
默认值与来源
工厂函数(每个实例创建)(实例工厂;已安装组件)固定上游源码工厂(未执行):() => mutable({} as const)(2.14.7;源码事实,未作为 ASAM 运行实测)
xl
必填:否;声明来源:上游声明。
xl 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
xl.span:number | undefined— 上游声明xl.offset:number | undefined— 上游声明xl.pull:number | undefined— 上游声明xl.push:number | undefined— 上游声明
默认值与来源
工厂函数(每个实例创建)(实例工厂;已安装组件)固定上游源码工厂(未执行):() => mutable({} as const)(2.14.7;源码事实,未作为 ASAM 运行实测)
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
必填:否;声明来源:依赖声明。
AsamColProps 公开类型视图
import type { VNodeRef, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, VNode, RendererNode, RendererElement } from 'vue';
import type { AsamColProps, AsamColSize, AsamColExpose } from '@asam-ui/ui';
type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;
// AsamColProps
type PublicContract = {
readonly "tag"?: string | undefined;
readonly "span"?: number | undefined;
readonly "offset"?: number | undefined;
readonly "pull"?: number | undefined;
readonly "push"?: number | undefined;
readonly "xs"?: AsamColSize | undefined;
readonly "sm"?: AsamColSize | undefined;
readonly "md"?: AsamColSize | undefined;
readonly "lg"?: AsamColSize | undefined;
readonly "xl"?: AsamColSize | undefined;
"key"?: PropertyKey | undefined;
"ref"?: VNodeRef | undefined;
"ref_for"?: boolean | undefined;
"ref_key"?: string | undefined;
"onVnodeBeforeMount"?: (AsamColProps)["onVnodeBeforeMount"];
"onVnodeMounted"?: (AsamColProps)["onVnodeMounted"];
"onVnodeBeforeUpdate"?: (AsamColProps)["onVnodeBeforeUpdate"];
"onVnodeUpdated"?: (AsamColProps)["onVnodeUpdated"];
"onVnodeBeforeUnmount"?: (AsamColProps)["onVnodeBeforeUnmount"];
"onVnodeUnmounted"?: (AsamColProps)["onVnodeUnmounted"];
"class"?: unknown;
"style"?: unknown;
};
完整的上游实例,包含全部公开方法与响应式状态。
参数与事件说明
$
必填:是;声明来源:依赖声明。
$ 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$data
必填:是;声明来源:依赖声明。
$props
必填:是;声明来源:依赖声明。
$attrs
必填:是;声明来源:依赖声明。
$attrs 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$refs
必填:是;声明来源:依赖声明。
$refs 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$slots
必填:是;声明来源:依赖声明。
$root
必填:是;声明来源:依赖声明。
$parent
必填:是;声明来源:依赖声明。
$host
必填:是;声明来源:依赖声明。
$host 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
嵌套展开边界:大型实例类型;完整类型见公开类型视图。
$emit
必填:是;声明来源:依赖声明。
$emit 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
事件参数:(event: string, ...args: any[]): 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<(AsamColExpose)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
push
必填:是;声明来源:上游声明。
tag
必填:是;声明来源:上游声明。
span
必填:是;声明来源:上游声明。
offset
必填:是;声明来源:上游声明。
pull
必填:是;声明来源:上游声明。
xs
必填:是;声明来源:上游声明。
xs 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
xs.span:number | undefined— 上游声明xs.offset:number | undefined— 上游声明xs.pull:number | undefined— 上游声明xs.push:number | undefined— 上游声明
sm
必填:是;声明来源:上游声明。
sm 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
sm.span:number | undefined— 上游声明sm.offset:number | undefined— 上游声明sm.pull:number | undefined— 上游声明sm.push:number | undefined— 上游声明
md
必填:是;声明来源:上游声明。
md 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
md.span:number | undefined— 上游声明md.offset:number | undefined— 上游声明md.pull:number | undefined— 上游声明md.push:number | undefined— 上游声明
lg
必填:是;声明来源:上游声明。
lg 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
lg.span:number | undefined— 上游声明lg.offset:number | undefined— 上游声明lg.pull:number | undefined— 上游声明lg.push:number | undefined— 上游声明
xl
必填:是;声明来源:上游声明。
xl 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
xl.span:number | undefined— 上游声明xl.offset:number | undefined— 上游声明xl.pull:number | undefined— 上游声明xl.push:number | undefined— 上游声明
$route
必填:是;声明来源:依赖声明。
$route 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
$route.matched:(NonNullable<AsamColExpose["$route"]>)["matched"]— 依赖声明仅包含普通组件的 RouteLocationMatched 数组;懒加载组件已解析并替换 components 中的值,可直接展示路由,不包含重定向记录。此属性不可枚举。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$route.name:(NonNullable<AsamColExpose["$route"]>)["name"]— 依赖声明匹配路由记录的名称。
$route.fullPath:string— 依赖声明包含 search 和 hash 的完整位置字符串,使用百分号编码。
$route.query:(NonNullable<AsamColExpose["$route"]>)["query"]— 依赖声明当前位置 search 属性的对象表示。
$route.hash:string— 依赖声明当前位置的哈希片段;存在时以 # 开头。
$route.redirectedFrom:(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]— 依赖声明最终到达当前位置之前,最初尝试访问的位置。
$route.redirectedFrom.matched:PublicMember<NonNullable<(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]>, "matched">— 依赖声明包含添加路由时原始组件的 RouteRecord 数组,也可能包含重定向记录,不能直接用于展示。此属性不可枚举。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$route.redirectedFrom.fullPath:string— 依赖声明包含 search 和 hash 的完整位置字符串,使用百分号编码。
$route.redirectedFrom.query:PublicMember<NonNullable<(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]>, "query">— 依赖声明当前位置 search 属性的对象表示。
$route.redirectedFrom.hash:string— 依赖声明当前位置的哈希片段;存在时以 # 开头。
$route.redirectedFrom.redirectedFrom:PublicMember<NonNullable<(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]>, "redirectedFrom">— 依赖声明最终到达当前位置之前,最初尝试访问的位置。
嵌套展开边界:递归引用;完整类型见公开类型视图。
$route.redirectedFrom.name:PublicMember<NonNullable<(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]>, "name">— 依赖声明匹配路由记录的名称。
$route.redirectedFrom.meta:PublicMember<NonNullable<(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]>, "meta">— 依赖声明全部匹配路由记录合并后的 meta 属性。
$route.redirectedFrom.params:PublicMember<NonNullable<(NonNullable<AsamColExpose["$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<AsamColExpose["$route"]>)["redirectedFrom"]>, "state">— 依赖声明通过 History API 保存的状态;不能包含响应式值,也不允许 Symbol 等部分值。详情参见 https://developer.mozilla.org/zh-CN/docs/Web/API/History/state。
$route.meta:(NonNullable<AsamColExpose["$route"]>)["meta"]— 依赖声明全部匹配路由记录合并后的 meta 属性。
$route.params:(NonNullable<AsamColExpose["$route"]>)["params"]— 依赖声明从 path 提取并解码后的参数对象。
$route.path:string— 依赖声明URL 中经过百分号编码的路径部分。
$router
必填:是;声明来源:依赖声明。
$router 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
$router.options:(NonNullable<AsamColExpose["$router"]>)["options"]— 依赖声明创建路由器时传入的原始配置对象。
$router.options.routes:(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["routes"]— 依赖声明需要添加到路由器的初始路由列表。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$router.options.history:(NonNullable<(NonNullable<AsamColExpose["$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<AsamColExpose["$router"]>)["options"]>)["history"]>)["state"]— 依赖声明当前历史记录状态。
嵌套展开边界:深度上限;完整类型见公开类型视图。
$router.options.history.push:(NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["history"]>)["push"]— 依赖声明导航到指定位置;使用 HTML5 History 时,通过 history.pushState 实际更新 URL。
事件参数:
(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["history"]>)["push"]>, (...args: never[]) => unknown>>[1]): void嵌套展开边界:深度上限;完整类型见公开类型视图。
$router.options.history.replace:(NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["history"]>)["replace"]— 依赖声明与 RouterHistory.push 类似,但调用 history.replaceState,而非 history.pushState。
事件参数:
(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamColExpose["$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<AsamColExpose["$router"]>)["options"]>)["history"]>)["listen"]— 依赖声明为历史记录实现添加监听器;由浏览器前进、后退等外部导航,或传入 true 的 RouterHistory.back、RouterHistory.forward 触发。
事件参数:
(callback: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["history"]>)["listen"]>, (...args: never[]) => unknown>>[0]): () => void嵌套展开边界:深度上限;完整类型见公开类型视图。
$router.options.history.createHref:(location: AsamColExpose["tag"]) => string— 依赖声明生成用于链接元素的对应 href。
事件参数:
(location: string): string嵌套展开边界:深度上限;完整类型见公开类型视图。
$router.options.history.destroy:() => void— 依赖声明清除历史记录实现注册的全部事件监听器。
事件参数:
(): void嵌套展开边界:深度上限;完整类型见公开类型视图。
$router.options.scrollBehavior:(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["scrollBehavior"]— 依赖声明控制页面导航时滚动行为的函数;可返回 Promise 延迟滚动。
事件参数:
(to: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[0], from: AsamColExpose["$route"], savedPosition: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[2]): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>$router.options.parseQuery:(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["parseQuery"]— 依赖声明自定义查询参数解析函数;与 EXPERIMENTAL_RouterOptions_Base.stringifyQuery 配套。
事件参数:
(search: string): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["parseQuery"]>, (...args: never[]) => unknown>>$router.options.stringifyQuery:(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["stringifyQuery"]— 依赖声明自定义查询对象序列化函数;不要添加开头的 ?,与 parseQuery 的解析函数配套。
事件参数:
(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamColExpose["$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<AsamColExpose["$router"]>)["addRoute"]— 依赖声明向已有路由添加子路由,或向路由器添加新的 RouteRecordRaw 路由记录。
事件参数完整签名见公开类型视图。
事件参数完整签名见公开类型视图。
$router.removeRoute:(NonNullable<AsamColExpose["$router"]>)["removeRoute"]— 依赖声明按名称移除已有路由。
事件参数:
(name: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["removeRoute"]>, (...args: never[]) => unknown>>[0]): void$router.clearRoutes:() => void— 依赖声明从路由器中删除全部路由。
事件参数:
(): void$router.currentRoute:ShallowRef<AsamColExpose["$route"]>— 依赖声明当前 RouteLocationNormalized。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$router.listening:boolean— 依赖声明允许关闭历史事件监听,这是用于微前端的底层 API。
枚举:
false/true$router.hasRoute:(NonNullable<AsamColExpose["$router"]>)["hasRoute"]— 依赖声明检查指定名称的路由是否存在。
事件参数:
(name: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["hasRoute"]>, (...args: never[]) => unknown>>[0]): boolean$router.getRoutes:(NonNullable<AsamColExpose["$router"]>)["getRoutes"]— 依赖声明获取全部 RouteRecord 路由记录的完整列表。
事件参数:
(): ReturnType<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["getRoutes"]>, (...args: never[]) => unknown>>$router.resolve:(NonNullable<AsamColExpose["$router"]>)["resolve"]— 依赖声明返回 RouteLocationRaw 的规范化位置,包含带基础路径的 href;默认使用 router.currentRoute 作为 currentLocation,仅在高级场景中覆盖。
事件参数完整签名见公开类型视图。
事件参数完整签名见公开类型视图。
$router.push:(NonNullable<AsamColExpose["$router"]>)["push"]— 依赖声明通过向历史栈添加记录,以编程方式导航到新 URL。
事件参数:
(to: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>$router.replace:(NonNullable<AsamColExpose["$router"]>)["replace"]— 依赖声明通过替换历史栈中的当前记录,以编程方式导航到新 URL。
事件参数:
(to: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamColExpose["$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<AsamColExpose["$router"]>)["beforeEach"]— 依赖声明添加每次导航之前执行的守卫,并返回移除此守卫的函数。
事件参数:
(guard: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["beforeEach"]>, (...args: never[]) => unknown>>[0]): () => void$router.beforeResolve:(NonNullable<AsamColExpose["$router"]>)["beforeResolve"]— 依赖声明添加导航确认之前执行的守卫,此时组件已获取且其他导航守卫已通过;返回移除此守卫的函数。
事件参数:
(guard: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["beforeResolve"]>, (...args: never[]) => unknown>>[0]): () => void$router.afterEach:(NonNullable<AsamColExpose["$router"]>)["afterEach"]— 依赖声明添加每次导航结束后执行的钩子,并返回移除此钩子的函数。
事件参数:
(guard: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["afterEach"]>, (...args: never[]) => unknown>>[0]): () => void$router.onError:(NonNullable<AsamColExpose["$router"]>)["onError"]— 依赖声明添加导航期间未捕获错误的处理函数,涵盖同步和异步异常、守卫返回或传给 next 的错误,以及路由异步组件解析错误。
事件参数:
(handler: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$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
AsamColExpose 公开类型视图
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamColExpose, AsamTableColumnExpose, AsamColProps, AsamColSlots, AsamColSize } from '@asam-ui/ui';
type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;
// AsamColExpose
type PublicContract = {
"$": AsamColExpose["$"];
"$data": AsamTableColumnExpose;
"$props": AsamColProps;
"$attrs": AsamColExpose["$attrs"];
"$refs": AsamColExpose["$refs"];
"$slots": AsamColSlots;
"$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: string, ...args: any[]) => void;
"$el": any;
"$options": (AsamColExpose)["$options"];
"$forceUpdate": () => void;
"$nextTick": (AsamColExpose)["$nextTick"];
"$watch": (AsamColExpose)["$watch"];
readonly "push": number;
readonly "tag": string;
readonly "span": number;
readonly "offset": number;
readonly "pull": number;
readonly "xs": AsamColSize;
readonly "sm": AsamColSize;
readonly "md": AsamColSize;
readonly "lg": AsamColSize;
readonly "xl": AsamColSize;
"$route": AsamColExpose["$route"];
"$router": AsamColExpose["$router"];
};
参数与事件说明
$
必填:是;声明来源:依赖声明。
$ 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$data
必填:是;声明来源:依赖声明。
$props
必填:是;声明来源:依赖声明。
$attrs
必填:是;声明来源:依赖声明。
$attrs 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$refs
必填:是;声明来源:依赖声明。
$refs 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$slots
必填:是;声明来源:依赖声明。
$root
必填:是;声明来源:依赖声明。
$parent
必填:是;声明来源:依赖声明。
$host
必填:是;声明来源:依赖声明。
$host 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
嵌套展开边界:大型实例类型;完整类型见公开类型视图。
$emit
必填:是;声明来源:依赖声明。
$emit 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
事件参数:(event: string, ...args: any[]): 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<(AsamColInstance)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
push
必填:是;声明来源:上游声明。
tag
必填:是;声明来源:上游声明。
span
必填:是;声明来源:上游声明。
offset
必填:是;声明来源:上游声明。
pull
必填:是;声明来源:上游声明。
xs
必填:是;声明来源:上游声明。
xs 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
xs.span:number | undefined— 上游声明xs.offset:number | undefined— 上游声明xs.pull:number | undefined— 上游声明xs.push:number | undefined— 上游声明
sm
必填:是;声明来源:上游声明。
sm 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
sm.span:number | undefined— 上游声明sm.offset:number | undefined— 上游声明sm.pull:number | undefined— 上游声明sm.push:number | undefined— 上游声明
md
必填:是;声明来源:上游声明。
md 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
md.span:number | undefined— 上游声明md.offset:number | undefined— 上游声明md.pull:number | undefined— 上游声明md.push:number | undefined— 上游声明
lg
必填:是;声明来源:上游声明。
lg 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
lg.span:number | undefined— 上游声明lg.offset:number | undefined— 上游声明lg.pull:number | undefined— 上游声明lg.push:number | undefined— 上游声明
xl
必填:是;声明来源:上游声明。
xl 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
xl.span:number | undefined— 上游声明xl.offset:number | undefined— 上游声明xl.pull:number | undefined— 上游声明xl.push:number | undefined— 上游声明
$route
必填:是;声明来源:依赖声明。
$route 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
$route.matched:(NonNullable<AsamColExpose["$route"]>)["matched"]— 依赖声明仅包含普通组件的 RouteLocationMatched 数组;懒加载组件已解析并替换 components 中的值,可直接展示路由,不包含重定向记录。此属性不可枚举。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$route.name:(NonNullable<AsamColExpose["$route"]>)["name"]— 依赖声明匹配路由记录的名称。
$route.fullPath:string— 依赖声明包含 search 和 hash 的完整位置字符串,使用百分号编码。
$route.query:(NonNullable<AsamColExpose["$route"]>)["query"]— 依赖声明当前位置 search 属性的对象表示。
$route.hash:string— 依赖声明当前位置的哈希片段;存在时以 # 开头。
$route.redirectedFrom:(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]— 依赖声明最终到达当前位置之前,最初尝试访问的位置。
$route.redirectedFrom.matched:PublicMember<NonNullable<(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]>, "matched">— 依赖声明包含添加路由时原始组件的 RouteRecord 数组,也可能包含重定向记录,不能直接用于展示。此属性不可枚举。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$route.redirectedFrom.fullPath:string— 依赖声明包含 search 和 hash 的完整位置字符串,使用百分号编码。
$route.redirectedFrom.query:PublicMember<NonNullable<(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]>, "query">— 依赖声明当前位置 search 属性的对象表示。
$route.redirectedFrom.hash:string— 依赖声明当前位置的哈希片段;存在时以 # 开头。
$route.redirectedFrom.redirectedFrom:PublicMember<NonNullable<(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]>, "redirectedFrom">— 依赖声明最终到达当前位置之前,最初尝试访问的位置。
嵌套展开边界:递归引用;完整类型见公开类型视图。
$route.redirectedFrom.name:PublicMember<NonNullable<(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]>, "name">— 依赖声明匹配路由记录的名称。
$route.redirectedFrom.meta:PublicMember<NonNullable<(NonNullable<AsamColExpose["$route"]>)["redirectedFrom"]>, "meta">— 依赖声明全部匹配路由记录合并后的 meta 属性。
$route.redirectedFrom.params:PublicMember<NonNullable<(NonNullable<AsamColExpose["$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<AsamColExpose["$route"]>)["redirectedFrom"]>, "state">— 依赖声明通过 History API 保存的状态;不能包含响应式值,也不允许 Symbol 等部分值。详情参见 https://developer.mozilla.org/zh-CN/docs/Web/API/History/state。
$route.meta:(NonNullable<AsamColExpose["$route"]>)["meta"]— 依赖声明全部匹配路由记录合并后的 meta 属性。
$route.params:(NonNullable<AsamColExpose["$route"]>)["params"]— 依赖声明从 path 提取并解码后的参数对象。
$route.path:string— 依赖声明URL 中经过百分号编码的路径部分。
$router
必填:是;声明来源:依赖声明。
$router 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
$router.options:(NonNullable<AsamColExpose["$router"]>)["options"]— 依赖声明创建路由器时传入的原始配置对象。
$router.options.routes:(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["routes"]— 依赖声明需要添加到路由器的初始路由列表。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$router.options.history:(NonNullable<(NonNullable<AsamColExpose["$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<AsamColExpose["$router"]>)["options"]>)["history"]>)["state"]— 依赖声明当前历史记录状态。
嵌套展开边界:深度上限;完整类型见公开类型视图。
$router.options.history.push:(NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["history"]>)["push"]— 依赖声明导航到指定位置;使用 HTML5 History 时,通过 history.pushState 实际更新 URL。
事件参数:
(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["history"]>)["push"]>, (...args: never[]) => unknown>>[1]): void嵌套展开边界:深度上限;完整类型见公开类型视图。
$router.options.history.replace:(NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["history"]>)["replace"]— 依赖声明与 RouterHistory.push 类似,但调用 history.replaceState,而非 history.pushState。
事件参数:
(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamColExpose["$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<AsamColExpose["$router"]>)["options"]>)["history"]>)["listen"]— 依赖声明为历史记录实现添加监听器;由浏览器前进、后退等外部导航,或传入 true 的 RouterHistory.back、RouterHistory.forward 触发。
事件参数:
(callback: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["history"]>)["listen"]>, (...args: never[]) => unknown>>[0]): () => void嵌套展开边界:深度上限;完整类型见公开类型视图。
$router.options.history.createHref:(location: AsamColExpose["tag"]) => string— 依赖声明生成用于链接元素的对应 href。
事件参数:
(location: string): string嵌套展开边界:深度上限;完整类型见公开类型视图。
$router.options.history.destroy:() => void— 依赖声明清除历史记录实现注册的全部事件监听器。
事件参数:
(): void嵌套展开边界:深度上限;完整类型见公开类型视图。
$router.options.scrollBehavior:(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["scrollBehavior"]— 依赖声明控制页面导航时滚动行为的函数;可返回 Promise 延迟滚动。
事件参数:
(to: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[0], from: AsamColExpose["$route"], savedPosition: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[2]): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>$router.options.parseQuery:(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["parseQuery"]— 依赖声明自定义查询参数解析函数;与 EXPERIMENTAL_RouterOptions_Base.stringifyQuery 配套。
事件参数:
(search: string): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["parseQuery"]>, (...args: never[]) => unknown>>$router.options.stringifyQuery:(NonNullable<(NonNullable<AsamColExpose["$router"]>)["options"]>)["stringifyQuery"]— 依赖声明自定义查询对象序列化函数;不要添加开头的 ?,与 parseQuery 的解析函数配套。
事件参数:
(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamColExpose["$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<AsamColExpose["$router"]>)["addRoute"]— 依赖声明向已有路由添加子路由,或向路由器添加新的 RouteRecordRaw 路由记录。
事件参数完整签名见公开类型视图。
事件参数完整签名见公开类型视图。
$router.removeRoute:(NonNullable<AsamColExpose["$router"]>)["removeRoute"]— 依赖声明按名称移除已有路由。
事件参数:
(name: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["removeRoute"]>, (...args: never[]) => unknown>>[0]): void$router.clearRoutes:() => void— 依赖声明从路由器中删除全部路由。
事件参数:
(): void$router.currentRoute:ShallowRef<AsamColExpose["$route"]>— 依赖声明当前 RouteLocationNormalized。
嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。
$router.listening:boolean— 依赖声明允许关闭历史事件监听,这是用于微前端的底层 API。
枚举:
false/true$router.hasRoute:(NonNullable<AsamColExpose["$router"]>)["hasRoute"]— 依赖声明检查指定名称的路由是否存在。
事件参数:
(name: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["hasRoute"]>, (...args: never[]) => unknown>>[0]): boolean$router.getRoutes:(NonNullable<AsamColExpose["$router"]>)["getRoutes"]— 依赖声明获取全部 RouteRecord 路由记录的完整列表。
事件参数:
(): ReturnType<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["getRoutes"]>, (...args: never[]) => unknown>>$router.resolve:(NonNullable<AsamColExpose["$router"]>)["resolve"]— 依赖声明返回 RouteLocationRaw 的规范化位置,包含带基础路径的 href;默认使用 router.currentRoute 作为 currentLocation,仅在高级场景中覆盖。
事件参数完整签名见公开类型视图。
事件参数完整签名见公开类型视图。
$router.push:(NonNullable<AsamColExpose["$router"]>)["push"]— 依赖声明通过向历史栈添加记录,以编程方式导航到新 URL。
事件参数:
(to: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>$router.replace:(NonNullable<AsamColExpose["$router"]>)["replace"]— 依赖声明通过替换历史栈中的当前记录,以编程方式导航到新 URL。
事件参数:
(to: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamColExpose["$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<AsamColExpose["$router"]>)["beforeEach"]— 依赖声明添加每次导航之前执行的守卫,并返回移除此守卫的函数。
事件参数:
(guard: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["beforeEach"]>, (...args: never[]) => unknown>>[0]): () => void$router.beforeResolve:(NonNullable<AsamColExpose["$router"]>)["beforeResolve"]— 依赖声明添加导航确认之前执行的守卫,此时组件已获取且其他导航守卫已通过;返回移除此守卫的函数。
事件参数:
(guard: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["beforeResolve"]>, (...args: never[]) => unknown>>[0]): () => void$router.afterEach:(NonNullable<AsamColExpose["$router"]>)["afterEach"]— 依赖声明添加每次导航结束后执行的钩子,并返回移除此钩子的函数。
事件参数:
(guard: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$router"]>)["afterEach"]>, (...args: never[]) => unknown>>[0]): () => void$router.onError:(NonNullable<AsamColExpose["$router"]>)["onError"]— 依赖声明添加导航期间未捕获错误的处理函数,涵盖同步和异步异常、守卫返回或传给 next 的错误,以及路由异步组件解析错误。
事件参数:
(handler: Parameters<Extract<NonNullable<(NonNullable<AsamColExpose["$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
AsamColInstance 公开类型视图
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamColInstance, AsamColExpose, AsamTableColumnExpose, AsamColProps, AsamColSlots, AsamColSize } from '@asam-ui/ui';
type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;
// AsamColInstance
type PublicContract = {
"$": AsamColExpose["$"];
"$data": AsamTableColumnExpose;
"$props": AsamColProps;
"$attrs": AsamColExpose["$attrs"];
"$refs": AsamColExpose["$refs"];
"$slots": AsamColSlots;
"$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: string, ...args: any[]) => void;
"$el": any;
"$options": (AsamColInstance)["$options"];
"$forceUpdate": () => void;
"$nextTick": (AsamColInstance)["$nextTick"];
"$watch": (AsamColInstance)["$watch"];
readonly "push": number;
readonly "tag": string;
readonly "span": number;
readonly "offset": number;
readonly "pull": number;
readonly "xs": AsamColSize;
readonly "sm": AsamColSize;
readonly "md": AsamColSize;
readonly "lg": AsamColSize;
readonly "xl": AsamColSize;
"$route": AsamColExpose["$route"];
"$router": AsamColExpose["$router"];
};
作用域插槽保留上游实例契约。
参数与事件说明
default
必填:否;声明来源:上游声明。
default 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
事件参数:(props: AsamTableColumnExpose): any
AsamColSlots 公开类型视图
import type { AsamColSlots, AsamColExpose, AsamTableColumnExpose } from '@asam-ui/ui';
// AsamColSlots
type PublicContract = {
"default"?: (AsamColSlots)["default"];
readonly [key: string]: import("vue").Slot<any> | undefined;
};
参数与事件说明
offset
必填:否;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
push
必填:否;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
tag
必填:否;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:'div'(2.14.7;源码事实,未作为 ASAM 运行实测)
span
必填:否;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:24(2.14.7;源码事实,未作为 ASAM 运行实测)
pull
必填:否;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
xs
必填:否;声明来源:上游声明。
xs 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
xs.span:number | undefined— 上游声明xs.offset:number | undefined— 上游声明xs.pull:number | undefined— 上游声明xs.push:number | undefined— 上游声明
默认值与来源
未知 / 未声明固定上游源码工厂(未执行):() => mutable({} as const)(2.14.7;源码事实,未作为 ASAM 运行实测)
sm
必填:否;声明来源:上游声明。
sm 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
sm.span:number | undefined— 上游声明sm.offset:number | undefined— 上游声明sm.pull:number | undefined— 上游声明sm.push:number | undefined— 上游声明
默认值与来源
未知 / 未声明固定上游源码工厂(未执行):() => mutable({} as const)(2.14.7;源码事实,未作为 ASAM 运行实测)
md
必填:否;声明来源:上游声明。
md 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
md.span:number | undefined— 上游声明md.offset:number | undefined— 上游声明md.pull:number | undefined— 上游声明md.push:number | undefined— 上游声明
默认值与来源
未知 / 未声明固定上游源码工厂(未执行):() => mutable({} as const)(2.14.7;源码事实,未作为 ASAM 运行实测)
lg
必填:否;声明来源:上游声明。
lg 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
lg.span:number | undefined— 上游声明lg.offset:number | undefined— 上游声明lg.pull:number | undefined— 上游声明lg.push:number | undefined— 上游声明
默认值与来源
未知 / 未声明固定上游源码工厂(未执行):() => mutable({} as const)(2.14.7;源码事实,未作为 ASAM 运行实测)
xl
必填:否;声明来源:上游声明。
xl 参数与事件数据
下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。
xl.span:number | undefined— 上游声明xl.offset:number | undefined— 上游声明xl.pull:number | undefined— 上游声明xl.push:number | undefined— 上游声明
默认值与来源
未知 / 未声明固定上游源码工厂(未执行):() => mutable({} as const)(2.14.7;源码事实,未作为 ASAM 运行实测)
AsamColPropsPublic 公开类型视图
import type { AsamColPropsPublic, AsamColProps } from '@asam-ui/ui';
type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;
// AsamColPropsPublic
type PublicContract = {
readonly "offset"?: number | undefined;
readonly "push"?: number | undefined;
readonly "tag"?: string | undefined;
readonly "span"?: number | undefined;
readonly "pull"?: number | undefined;
readonly "xs"?: (AsamColPropsPublic)["xs"];
readonly "sm"?: (AsamColPropsPublic)["sm"];
readonly "md"?: (AsamColPropsPublic)["md"];
readonly "lg"?: (AsamColPropsPublic)["lg"];
readonly "xl"?: (AsamColPropsPublic)["xl"];
};
组合契约按分支生效;请同时查看公开类型。
参数与事件说明
span
必填:按分支;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:24(2.14.7;源码事实,未作为 ASAM 运行实测)
offset
必填:按分支;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
pull
必填:按分支;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
push
必填:按分支;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
AsamColSize 公开类型视图
import type { AsamColSize, AsamColProps } from '@asam-ui/ui';
type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;
// AsamColSize
type PublicContract = AsamColSize;
参数与事件说明
span
必填:否;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:24(2.14.7;源码事实,未作为 ASAM 运行实测)
offset
必填:否;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
pull
必填:否;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
push
必填:否;声明来源:上游声明。
默认值与来源
未知 / 未声明固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)
AsamColSizeObject 公开类型视图
import type { AsamColSizeObject, AsamColProps } from '@asam-ui/ui';
// AsamColSizeObject
type PublicContract = {
"span"?: number | undefined;
"offset"?: number | undefined;
"pull"?: number | undefined;
"push"?: number | undefined;
};