往期鸿蒙全套实战文章必看:
SymbolGlyph
显示图标小符号的组件。
说明:
该组件从API Version 11开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
不支持子组件。
接口
SymbolGlyph(value: Resource)
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
---|---|---|---|
value | Resource | 是 | SymbolGlyph组件的资源名,如 $r(‘sys.symbol.ohos_wifi’)。 |
说明:
$r(‘sys.symbol.ohos_wifi’)中引用的资源为系统预置,SymbolGlyph仅支持系统预置的symbol资源名,引用非symbol资源将显示异常。
属性
支持通用属性,不支持文本通用属性,仅支持以下特有属性:
fontColor
fontColor(value: Array<ResourceColor>)
设置SymbolGlyph组件颜色。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | Array<ResourceColor> | 是 | SymbolGlyph组件颜色。 默认值:不同渲染策略下默认值不同。 |
fontSize
fontSize(value: number | string | Resource)
设置SymbolGlyph组件大小。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | number | string | Resource | 是 | SymbolGlyph组件大小。 默认值:系统默认值。 |
fontWeight
fontWeight(value: number | FontWeight | string)
设置SymbolGlyph组件粗细。number类型取值[100,900],取值间隔为100,默认为400,取值越大,字体越粗。string类型仅支持number类型取值的字符串形式,例如“400”,以及“bold”、“bolder”、“lighter”、“regular” 、“medium”分别对应FontWeight中相应的枚举值。
sys.symbol.ohos_lungs图标不支持设置fontWeight。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | number | string | FontWeight | 是 | SymbolGlyph组件粗细。 默认值:FontWeight.Normal |
renderingStrategy
renderingStrategy(value: SymbolRenderingStrategy)
设置SymbolGlyph组件渲染策略。$r(‘sys.symbol.ohos_*’)中引用的资源仅ohos_folder_badge_plus支持分层与多色模式。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | SymbolRenderingStrategy | 是 | SymbolGlyph组件渲染策略。 默认值:SymbolRenderingStrategy.SINGLE |
不同渲染策略效果可参考以下示意图。
effectStrategy
effectStrategy(value: SymbolEffectStrategy)
设置SymbolGlyph组件动效策略。$r(‘sys.symbol.ohos_*’)中引用的资源仅ohos_wifi支持层级动效模式。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | SymbolEffectStrategy | 是 | SymbolGlyph组件动效策略。 默认值:SymbolEffectStrategy.NONE |
symbolEffect12+
symbolEffect(symbolEffect: SymbolEffect, isActive?: boolean)
设置SymbolGlyph组件动效策略及播放状态。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
symbolEffect | SymbolEffect|ScaleSymbolEffect|HierarchicalSymbolEffect| AppearSymbolEffect|DisappearSymbolEffect|BounceSymbolEffect| ReplaceSymbolEffect|PulseSymbolEffect | 是 | SymbolGlyph组件动效策略。 默认值:SymbolEffect |
isActive | boolean | 否 | SymbolGlyph组件动效播放状态。 默认值:false |
symbolEffect12+
symbolEffect(symbolEffect: SymbolEffect, triggerValue?: number)
设置SymbolGlyph组件动效策略及播放触发器。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
symbolEffect | SymbolEffect|ScaleSymbolEffect|HierarchicalSymbolEffect| AppearSymbolEffect|DisappearSymbolEffect|BounceSymbolEffect| ReplaceSymbolEffect|PulseSymbolEffect | 是 | SymbolGlyph组件动效策略。 默认值:SymbolEffect |
triggerValue | number | 否 | SymbolGlyph组件动效播放触发器,在数值变更时触发动效。 如果首次不希望触发动效,设置-1。 |
说明:
动效属性,仅支持使用effectStrategy属性或单个symbolEffect属性,不支持多种动效属性混合使用。
SymbolEffect12+
constructor12+
constructor()
SymbolEffect的构造函数,无动效。
ScaleSymbolEffect12+
constructor12+
constructor(scope?: EffectScope, direction?: EffectDirection)
ScaleSymbolEffect的构造函数,缩放动效。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
---|---|---|---|
scope | EffectScope | 否 | 动效范围。 默认值:EffectScope.LAYER |
direction | EffectDirection | 否 | 动效方向。 默认值:EffectDirection.DOWN |
属性
名称 | 参数类型 | 描述 |
---|---|---|
scope | EffectScope | 动效范围。 默认值:EffectScope.LAYER |
direction | EffectDirection | 动效方向。 默认值:EffectDirection.DOWN |
HierarchicalSymbolEffect12+
constructor12+
constructor(fillStyle?: EffectFillStyle)
HierarchicalSymbolEffect的构造函数,层级动效。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
---|---|---|---|
fillStyle | EffectFillStyle | 否 | 动效模式。 默认值:EffectFillStyle.CUMULATIVE |
属性
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
fillStyle | EffectFillStyle | 否 | 动效模式。 默认值:EffectFillStyle.CUMULATIVE |
AppearSymbolEffect12+
constructor12+
constructor(scope?: EffectScope)
AppearSymbolEffect的构造函数,出现动效。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
---|---|---|---|
scope | EffectScope | 否 | 动效范围。 默认值:EffectScope.LAYER |
属性
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
scope | EffectScope | 否 | 动效范围。 默认值:EffectScope.LAYER |
DisappearSymbolEffect12+
constructor12+
constructor(scope?: EffectScope)
DisappearSymbolEffect的构造函数,消失动效。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
---|---|---|---|
scope | EffectScope | 否 | 动效范围。 默认值:EffectScope.LAYER |
属性
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
scope | EffectScope | 否 | 动效范围。 默认值:EffectScope.LAYER |
BounceSymbolEffect12+
constructor12+
constructor(scope?: EffectScope, direction?: EffectDirection)
BounceSymbolEffect的构造函数,弹跳动效。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
---|---|---|---|
scope | EffectScope | 否 | 动效范围。 默认值:EffectScope.LAYER |
direction | EffectDirection | 否 | 动效方向。 默认值:EffectDirection.DOWN |
属性
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
scope | EffectScope | 否 | 动效范围。 默认值:EffectScope.LAYER |
direction | EffectDirection | 否 | 动效方向。 默认值:EffectDirection.DOWN |
ReplaceSymbolEffect12+
constructor12+
constructor(scope?: EffectScope)
ReplaceSymbolEffect的构造函数,替换动效。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
---|---|---|---|
scope | EffectScope | 否 | 动效范围。 默认值:EffectScope.LAYER |
属性
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
scope | EffectScope | 否 | 动效范围。 默认值:EffectScope.LAYER |
PulseSymbolEffect12+
constructor12+
constructor()
PulseSymbolEffect的构造函数,脉冲动效。
EffectDirection12+
名称 | 值 | 说明 |
---|---|---|
DOWN | 0 | 图标缩小再复原。 |
UP | 1 | 图标放大再复原。 |
EffectScope12+
名称 | 值 | 说明 |
---|---|---|
LAYER | 0 | 分层模式。 |
WHOLE | 1 | 整体模式。 |
EffectFillStyle12+
名称 | 值 | 说明 |
---|---|---|
CUMULATIVE | 0 | 累加模式。 |
ITERATIVE | 1 | 迭代模式。 |
事件
支持通用事件。
示例
示例1
// xxx.ets
@Entry
@Component
struct Index {
build() {
Column() {
Row() {
Column() {
Text("Light")
SymbolGlyph($r('sys.symbol.ohos_trash'))
.fontWeight(FontWeight.Lighter)
.fontSize(96)
}
Column() {
Text("Normal")
SymbolGlyph($r('sys.symbol.ohos_trash'))
.fontWeight(FontWeight.Normal)
.fontSize(96)
}
Column() {
Text("Bold")
SymbolGlyph($r('sys.symbol.ohos_trash'))
.fontWeight(FontWeight.Bold)
.fontSize(96)
}
}
Row() {
Column() {
Text("单色")
SymbolGlyph($r('sys.symbol.ohos_folder_badge_plus'))
.fontSize(96)
.renderingStrategy(SymbolRenderingStrategy.SINGLE)
.fontColor([Color.Black, Color.Green, Color.White])
}
Column() {
Text("多色")
SymbolGlyph($r('sys.symbol.ohos_folder_badge_plus'))
.fontSize(96)
.renderingStrategy(SymbolRenderingStrategy.MULTIPLE_COLOR)
.fontColor([Color.Black, Color.Green, Color.White])
}
Column() {
Text("分层")
SymbolGlyph($r('sys.symbol.ohos_folder_badge_plus'))
.fontSize(96)
.renderingStrategy(SymbolRenderingStrategy.MULTIPLE_OPACITY)
.fontColor([Color.Black, Color.Green, Color.White])
}
}
Row() {
Column() {
Text("无动效")
SymbolGlyph($r('sys.symbol.ohos_wifi'))
.fontSize(96)
.effectStrategy(SymbolEffectStrategy.NONE)
}
Column() {
Text("整体缩放动效")
SymbolGlyph($r('sys.symbol.ohos_wifi'))
.fontSize(96)
.effectStrategy(1)
}
Column() {
Text("层级动效")
SymbolGlyph($r('sys.symbol.ohos_wifi'))
.fontSize(96)
.effectStrategy(2)
}
}
}
}
}
示例2
SymbolGlyph使用symbolEffect属性实现可变颜色动效和替换动效。
// xxx.ets
@Entry
@Component
struct Index {
@State isActive: boolean = true;
@State triggerValueReplace: number = 0;
replaceFlag: boolean = true;
build() {
Column() {
Row() {
Column() {
Text("可变颜色动效")
SymbolGlyph($r('sys.symbol.ohos_wifi'))
.fontSize(96)
.symbolEffect(new HierarchicalSymbolEffect(EffectFillStyle.ITERATIVE), this.isActive)
Button(this.isActive ? '关闭' : '播放').onClick(() => {
this.isActive = !this.isActive;
})
}.margin({right:20})
Column() {
Text("替换动效")
SymbolGlyph(this.replaceFlag ? $r('sys.symbol.checkmark_circle') : $r('sys.symbol.repeat_1'))
.fontSize(96)
.symbolEffect(new ReplaceSymbolEffect(EffectScope.WHOLE), this.triggerValueReplace)
Button('trigger').onClick(() => {
this.replaceFlag = !this.replaceFlag;
this.triggerValueReplace = this.triggerValueReplace + 1;
})
}
}
}.margin({
left:30,
top:50
})
}
}
看完三件事❤️
- 如果你觉得这篇内容对你还蛮有帮助,我想邀请你帮我三个小忙:
- 点赞,转发,有你们的 『点赞和评论』,才是我创造的动力。
- 关注作者,不定期分享原创知识。
- 同时可以期待后续文章ing🚀。