展示

标签 AsamTag

显示状态、分类或可关闭的短文本。

使用场景 ​

显示状态、分类或可关闭的短文本。

基础用法与状态 ​

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

基础用法与状态

展开源码

使用约定 ​

type、effect、round、hit、color、closable 和 disableTransitions 设置呈现;close 只发出关闭意图,宿主负责从数据或视图移除。 完整说明。

完整使用场景 ​

基础用法 ​

由 type 属性来选择 tag 的类型。也可以通过 color 属性来自定义背景色。

基础用法

展开源码

可移除标签 ​

设置 closable 属性可以定义一个标签是否可移除。它接受一个 Boolean。默认的标签移除时会附带渐变动画。如果不想使用,可以设置 disable-transitions 属性,它接受一个 Boolean,true 为关闭。当 Tag 被移除时会触发 close 事件。

可移除标签

展开源码

动态编辑标签 ​

动态编辑标签可以通过点击标签关闭按钮后触发的 close 事件来实现。

动态编辑标签

展开源码

尺寸 ​

Tag 组件提供除了默认值以外的三种尺寸,可以在不同场景下选择合适的按钮尺寸。

使用 size 属性配置尺寸,可选的尺寸大小有: large, default 或 small

尺寸

展开源码

主题 ​

Tag 组件提供了三个不同的主题:dark、light 和 plain。

通过设置 effect 属性来改变主题,默认为 light。

主题

展开源码

圆角标签 ​

Tag 可以像按钮组件一样变为圆角。

圆角标签

展开源码

可选中的标签 ​

有时候因为业务需求,我们可能会需要用到类似复选框的标签,但是按钮式的复选框的样式又不满足需求,此时我们就可以用到 check-tag组件。您可以在2.5.4中使用 type 属性。

check-tag 的基础使用方法,check-tag 提供的 API 非常简单。

可选中的标签

展开源码

API

属性 AsamTagProps

属性名说明类型默认值
effectTag 的主题enum"light" | "dark" | "plain"完整类型:"light" | "dark" | "plain" | undefined—
typeTag 的类型enum"primary" | "success" | "danger" | "warning" | "info"完整类型:"primary" | "success" | "danger" | "warning" | "info" | undefined—
color背景色string | undefined—
roundTag 是否为圆角boolean | undefinedfalse
closable是否可关闭boolean | undefinedfalse
disableTransitions是否禁用渐变动画boolean | undefinedfalse
hit是否有边框描边boolean | undefinedfalse
sizeTag 的尺寸enum"large" | "big" | "default" | "small"完整类型:AsamControlSize | undefined—

插槽 AsamTagSlots

属性名说明类型默认值
default—(() => VNode[]) | undefined—

事件 AsamTagEmits

属性名说明类型默认值
close—[event: MouseEvent]—
click—[event: MouseEvent]—

实例方法与状态 AsamTagExpose

类型 AsamTagInstance

类型 AsamTagPropsPublic

属性名说明类型默认值
effect—enum"light" | "dark" | "plain"完整类型:(AsamTagPropsPublic)["effect"]—
type—enum"primary" | "success" | "danger" | "warning" | "info"完整类型:(AsamTagPropsPublic)["type"]—
color—string | undefined—
round—boolean | undefined—
closable—boolean | undefined—
disableTransitions—boolean | undefined—
hit—boolean | undefined—
size—enum"large" | "big" | "default" | "small"完整类型:AsamControlSize | undefined—

用法与契约补充说明 ​

使用约定 ​

type、effect、round、hit、color、closable 和 disableTransitions 设置呈现;close 只发出关闭意图,宿主负责从数据或视图移除。default 插槽放文本,click 反馈真实点击。ASAM size 支持 large/big/default/small 并继承上下文。

参数与事件补充说明

完整基础 API,并支持 ASAM 四档尺寸继承。

参数与事件说明

effect

必填:否;声明来源:上游声明。

effect 参数与事件数据

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

枚举:"light" / "dark" / "plain"

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

固定上游文档默认:light(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:'light'(2.14.7;源码事实,未作为 ASAM 运行实测)

type

必填:否;声明来源:上游声明。

type 参数与事件数据

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

枚举:"primary" / "success" / "danger" / "warning" / "info"

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

固定上游文档默认:primary(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:'primary'(2.14.7;源码事实,未作为 ASAM 运行实测)

color

必填:否;声明来源:上游声明。

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

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

round

必填:否;声明来源:上游声明。

round 参数与事件数据

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

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

closable

必填:否;声明来源:上游声明。

closable 参数与事件数据

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

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

disableTransitions

必填:否;声明来源:上游声明。

disableTransitions 参数与事件数据

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

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

hit

必填:否;声明来源:上游声明。

hit 参数与事件数据

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

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

size

必填:否;声明来源:ASAM 声明。

size 参数与事件数据

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

枚举:"large" / "big" / "default" / "small"

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

// AsamTagProps
type PublicContract = {
	"effect"?: "light" | "dark" | "plain" | undefined;
	"type"?: "primary" | "success" | "danger" | "warning" | "info" | undefined;
	"color"?: string | undefined;
	"round"?: boolean | undefined;
	"closable"?: boolean | undefined;
	"disableTransitions"?: boolean | undefined;
	"hit"?: boolean | undefined;
	"size"?: AsamControlSize | undefined;
};

参数与事件说明

default

必填:否;声明来源:ASAM 声明。

default 参数与事件数据

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

事件参数:(): VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>[]

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

// AsamTagSlots
type PublicContract = {
	"default"?: (() => VNode[]) | undefined;
};

参数与事件说明

close

必填:是;声明来源:ASAM 声明。

click

必填:是;声明来源:ASAM 声明。

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

// AsamTagEmits
type PublicContract = {
	"close": [event: MouseEvent];
	"click": [event: MouseEvent];
};
AsamTagExpose 公开类型视图
ts
import type { AsamTagExpose } from '@asam-ui/ui';

// AsamTagExpose
type PublicContract = AsamTagExpose;
AsamTagInstance 公开类型视图
ts
import type { AsamTagInstance } from '@asam-ui/ui';

// AsamTagInstance
type PublicContract = AsamTagInstance;

用于回调、渲染器数据和组件专用配置的具名基础类型。

参数与事件说明

effect

必填:否;声明来源:上游声明。

effect 参数与事件数据

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

枚举:"light" / "dark" / "plain"

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

固定上游源码默认表达式:'light'(2.14.7;源码事实,未作为 ASAM 运行实测)

type

必填:否;声明来源:上游声明。

type 参数与事件数据

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

枚举:"primary" / "success" / "danger" / "warning" / "info"

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

固定上游源码默认表达式:'primary'(2.14.7;源码事实,未作为 ASAM 运行实测)

color

必填:否;声明来源:上游声明。

round

必填:否;声明来源:上游声明。

round 参数与事件数据

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

枚举:false / true

closable

必填:否;声明来源:上游声明。

closable 参数与事件数据

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

枚举:false / true

disableTransitions

必填:否;声明来源:上游声明。

disableTransitions 参数与事件数据

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

枚举:false / true

hit

必填:否;声明来源:上游声明。

hit 参数与事件数据

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

枚举:false / true

size

必填:否;声明来源:ASAM 声明。

size 参数与事件数据

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

枚举:"large" / "big" / "default" / "small"

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

// AsamTagPropsPublic
type PublicContract = {
	readonly "effect"?: (AsamTagPropsPublic)["effect"];
	readonly "type"?: (AsamTagPropsPublic)["type"];
	readonly "color"?: string | undefined;
	readonly "round"?: boolean | undefined;
	readonly "closable"?: boolean | undefined;
	readonly "disableTransitions"?: boolean | undefined;
	readonly "hit"?: boolean | undefined;
	"size"?: AsamControlSize | undefined;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭