鸿蒙5.0开发进阶:UI框架-ArkTS组件(ChipGroup)

鸿蒙5.0版开发:ArkTS高级组件-@ohos.arkui.advanced.ChipGroup (操作块组组件) ChipGroup高级组件,提供操作块群组,用于对文件或者资源内容进行分类等场景。 阅读详情

往期鸿蒙5.0全套实战文章必看:(文中附带全栈鸿蒙5.0学习资料)


ChipGroup

ChipGroup高级组件,提供操作块群组,用于对文件或者资源内容进行分类等场景。

说明

该组件从API Version 12开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

子组件

无

ChipGroup

ChipGroup({
  items: ChipGroupItemOptions[],
  itemStyle?: ChipItemStyle,
  selectedIndexes?: Array<number>,
  multiple?: boolean,
  chipGroupSpace?: ChipGroupSpaceOptions,
  chipGroupPadding?: ChipGroupPaddingOptions,
  onChange?: (selectedIndexes: Array<number>) => void,
  suffix?: Callback<void>
})

装饰器类型:@Component

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

名称类型必填描述
itemsChipGroupItemOptions[]是

每个chip特定的属性。

为undefined时,ChipGroup默认为空。

itemStyleChipItemStyle否

chip的style属性,比如颜色,大小等。

为undefined时,ChipGroup中的Chip式样为默认值。

selectedIndexesArray<number>否

被选中chip的索引。

为undefined时,默认第一个Chip被选中。

multipleboolean否

true:支持多个chip被选中;false:只能是单个chip被选中。

默认值:false

为undefined时,multiple走默认值。

chipGroupSpaceChipGroupSpaceOptions否

左右内边距,和chip与chip之间的间距。

为undefined时,chipGroupSpace走默认值。

chipGroupPaddingChipGroupPaddingOptions否

chipGroup的上下内边距,以便控制整体高度。

为undefined时,chipGroupPadding走默认值。

onChange(selectedIndexes: Array<number>) => void否

chip状态改变时候的回调方法。

为undefined时,表示解绑事件。

suffix()=>void否

最右侧的builder,由使用者自定义,使用时候需引入IconGroupSuffix接口。

默认值:不传入的情况,没有suffix。

说明

  1. 针对selectedIndexes和multiple接口,multiple等于false的时候,当没有传入selectedIndexes时候,默认是第一个chip被选中,当传入的selectedIndexes有一个以上的元素时候,默认第一个索引的chip被选中。

  2. 针对suffix接口,使用时候需要引入IconGroupSuffix接口,不传入的情况,没有suffix。

  3. 关于图标填充色(fillColor以及activedFillColor)的设置,跟随字体颜色(fontColor)保持一致。若想两者颜色不同,则需要在传入ChipGroupSpaceOptions时,使用prefixSymbol。

ChipGroupItemOptions

ChipGroupItemOptions定义每个chip的非共通属性。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

名称类型必填描述
prefixIconIconOptions否前缀Image图标属性。
prefixSymbolChipSymbolGlyphOptions否前缀SymbolGlyph图标属性。
labelLabelOptions是文本属性。
suffixIconIconOptions否后缀Image图标属性。
suffixSymbolChipSymbolGlyphOptions否后缀SymbolGlyph图标属性。
allowCloseboolean否

删除图标是否显示。

默认值:false。

说明

suffixIcon有传入参数时,allowClose不生效,suffixIcon没有传入参数时,allowClose决定是否显示删除图标。

ChipItemStyle

ChipItemStyle定义了chip的共通属性。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

名称类型必填描述
sizeChipSize | SizeOptions否

chip尺寸,使用时需要从chip组件引入ChipSize类型。

默认值:ChipSize:ChipSize.NORMAL。

为undefined时,ChipSize走默认值。

backgroundColorResourceColor否

chip背景颜色。

默认值:$r('sys.color.ohos_id_color_button_normal')。

为undefined时,backgroundColor走默认值。

fontColorResourceColor否

chip文字颜色。

默认值:$r('sys.color.ohos_id_color_text_primary')。

为undefined时,fontColor走默认值。

selectedFontColorResourceColor否

chip激活时的文字颜色。

默认值:$r('sys.color.ohos_id_color_text_primary_contrary')。

为undefined时,selectedFontColor走默认值。

selectedBackgroundColorResourceColor否

chip激活时的背景颜色。

默认值:$r('sys.color.ohos_id_color_emphasize')。

为undefined时,selectedBackgroundColor走默认值。

说明

1.操作块的大小可以是两种类型,一种是ChipSize,为方便使用,有两种尺寸可选分别是NORMAL和SMALL;另一种是SizeOptions。

2.backgroundColor、selectedBackgroundColor赋值undefined时,显示默认背景颜色,赋值非法值时,背景色透明。

ChipGroupSpaceOptions

ChipGroupSpaceOptions 定义了chipGroup左右内边距,以及chip与chip直接的间距。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

名称类型必填描述
itemSpacestring | number否

chip与chip之间的间距(不支持百分比)。

默认值:8

单位:vp

为undefined时,itemSpace走默认值。

startSpaceLength否

左侧内边距(不支持百分比)。

默认值:16

单位:vp

为undefined时,startSpace走默认值。

endSpaceLength否

右侧内边距(不支持百分比)。

默认值:16

单位:vp

为undefined时,endSpace走默认值。

ChipGroupPaddingOptions

ChipGroupPaddingOptions 定义了chipGroup上下内边距,以便控制chipGroup的整体高度。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

名称类型必填描述
topLength是

chipGroup的上方内边距(不支持百分比)。

默认值:14

为undefined时,top走默认值。

bottomLength是

chipGroup的上方内边距(不支持百分比)。

默认值:14

为undefined时,bottom走默认值。

IconGroupSuffix

装饰器类型:@Component

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

名称类型必填描述
itemsArray<IconItemOptions | SymbolGlyphModifier>是自定义builder items。

说明

传参SymbolGlyphModifier时,不支持通过symbolEffect修改动效类型和effectStrategy设置动效。

IconItemOptions

尾部builder接口定义,针对背板大小及颜色设置限制。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

名称类型必填描述
iconIconOptions是

自定义Builder icon。

chip大小是ChipSize.SMALL时,suffix默认值:{width: 16,height: 16}。

chip大小是ChipSize.NORMAL时,suffix默认值:{width: 24,height: 24}。

如果想动态修改size,那么必须在引入IconGroupSuffix时,使用SymbolGlyphModifier类型。

actionCallback<void>是

自定义Builder items 的Callback

为undefined时,表示解绑事件。

IconOptions

IconOptions定义图标的共通属性。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

名称类型必填说明
srcResourceStr是图标图片或图片地址引用。
sizeSizeOptions否图标大小,不支持百分比。

LabelOptions

Label定义图标的共通属性。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

名称类型必填说明
textstring是文本属性

示例

示例1(无最右侧的builder)

该示例实现了无最右侧的builder时效果。

import { ChipSize, ChipGroup } from '@kit.ArkUI'

@Entry
@Preview
@Component
struct Index {
  @State selected_index: Array<number> = [0, 1, 2, 3, 4, 5, 6]
  build() {
    Column() {
      ChipGroup({
        items: [
          {
            prefixIcon: { src: $r('app.media.icon') },
            label: { text: "操作块1" },
            suffixIcon: { src: $r('sys.media.ohos_ic_public_cut') },
            allowClose: false
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_copy') },
            label: { text: "操作块2" },
            allowClose: true
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_clock') },
            label: { text: "操作块3" },
            allowClose: true
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_cast_stream') },
            label: { text: "操作块4" },
            allowClose: true
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_cast_mirror') },
            label: { text: "操作块5" },
            allowClose: true
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_cast_stream') },
            label: { text: "操作块6" },
            allowClose: true
          },
        ],
        itemStyle: {
          size: ChipSize.SMALL,
          backgroundColor: $r('sys.color.ohos_id_color_button_normal'),
          fontColor: $r('sys.color.ohos_id_color_text_primary'),
          selectedBackgroundColor: $r('sys.color.ohos_id_color_emphasize'),
          selectedFontColor: $r('sys.color.ohos_id_color_text_primary_contrary'),
        },
        selectedIndexes: this.selected_index,
        multiple: false,
        chipGroupSpace: { itemSpace: 8, endSpace: 0 },
        chipGroupPadding: { top: 10, bottom: 10 },
        onChange: (activatedChipsIndex:Array<number>) => {
          console.log('chips on clicked, activated index ' + activatedChipsIndex)
        },
      })
    }
  }
}

示例2(有最右侧的builder)

该示例通过配置suffix实现最右侧的自定义组件效果。

import { ChipSize, ChipGroup, IconGroupSuffix  } from '@kit.ArkUI'

@Entry
@Preview
@Component
struct Index {
  @State selected_index: Array<number> = [0, 1, 2, 3, 4, 5, 6]
  @State selected_state: boolean = true;

  @LocalBuilder
  ChipGroupSuffix(): void {
    IconGroupSuffix({
      items: [{
        icon: { src: $r('sys.media.ohos_ic_public_search_filled'), size: { width: 36, height: 36 } },
        action: () => {
          if (this.selected_state == false) {
            this.selected_index = [0, 1, 2, 3, 4, 5, 6]
            this.selected_state = true
          } else {
            this.selected_index = []
            this.selected_state = false
          }
        }
      }
      ]
    })
  }

  build() {
    Column() {
      ChipGroup({
        items: [
          {
            prefixIcon: { src: $r('app.media.icon') },
            label: { text: "操作块1" },
            suffixIcon: { src: $r('sys.media.ohos_ic_public_cut') },
            allowClose: false
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_copy') },
            label: { text: "操作块2" },
            allowClose: true
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_clock') },
            label: { text: "操作块3" },
            allowClose: true
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_cast_stream') },
            label: { text: "操作块4" },
            allowClose: true
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_cast_mirror') },
            label: { text: "操作块5" },
            allowClose: true
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_cast_stream') },
            label: { text: "操作块6" },
            allowClose: true
          },
        ],
        itemStyle: {
          size: ChipSize.NORMAL,
          backgroundColor: $r('sys.color.ohos_id_color_button_normal'),
          fontColor: $r('sys.color.ohos_id_color_text_primary'),
          selectedBackgroundColor: $r('sys.color.ohos_id_color_emphasize'),
          selectedFontColor: $r('sys.color.ohos_id_color_text_primary_contrary'),
        },
        selectedIndexes: this.selected_index,
        multiple: true,
        chipGroupSpace: { itemSpace: 8, endSpace: 0 },
        chipGroupPadding: { top: 10, bottom: 10 },
        onChange: (activatedChipsIndex: Array<number>) => {
          console.log('chips on clicked, activated index ' + activatedChipsIndex)
        },
        suffix: this.ChipGroupSuffix
      })
    }
  }
}

示例3(设置Symbol类型图标)

该示例实现了IconGroupSuffix及ChipGroup传入SymbolGlyph资源。

import { ChipSize, ChipGroup, IconGroupSuffix, SymbolGlyphModifier } from '@kit.ArkUI'

@Entry
@Preview
@Component
struct Index {
  @State selected_index: Array<number> = [0, 1, 2, 3, 4, 5, 6];
  @State selected_state: boolean = true;
  @State prefixModifierNormal: SymbolGlyphModifier = new SymbolGlyphModifier($r('sys.symbol.ohos_star'));
  @State prefixModifierActivated: SymbolGlyphModifier = new SymbolGlyphModifier($r('sys.symbol.ohos_star')).fontColor([Color.Red]);
  @State suffixModifierNormal: SymbolGlyphModifier = new SymbolGlyphModifier($r('sys.symbol.ohos_wifi'));
  @State suffixModifierActivated: SymbolGlyphModifier = new SymbolGlyphModifier($r('sys.symbol.ohos_wifi')).fontColor([Color.Red]);

  @LocalBuilder
  ChipGroupSuffix(): void {
    IconGroupSuffix({
      items: [
        new SymbolGlyphModifier($r('sys.symbol.magnifyingglass'))
          .onClick(() => {
            if (this.selected_state == false) {
              this.selected_index = [0, 1, 2, 3, 4, 5, 6];
              this.selected_state = true;
            } else {
              this.selected_index = [];
              this.selected_state = false;
            }
          })
      ]
    })
  }

  build() {
    Column() {
      ChipGroup({
        items: [
          {
            prefixSymbol: { normal: this.prefixModifierNormal, activated: this.prefixModifierActivated },
            label: { text: "操作块1" },
            suffixSymbol: { normal: this.suffixModifierNormal, activated: this.suffixModifierActivated },
            allowClose: false,
          },
          {
            prefixSymbol: { normal: this.prefixModifierNormal, activated: this.prefixModifierActivated },
            label: { text: "操作块2" },
            allowClose: true,
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_clock') },
            label: { text: "操作块3" },
            allowClose: true,
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_cast_stream') },
            label: { text: "操作块4" },
            allowClose: true,
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_cast_mirror') },
            label: { text: "操作块5" },
            allowClose: true,
          },
          {
            prefixIcon: { src: $r('sys.media.ohos_ic_public_cast_stream') },
            label: { text: "操作块6" },
            allowClose: true,
          },
        ],
        itemStyle: {
          size: ChipSize.NORMAL,
          backgroundColor: $r('sys.color.ohos_id_color_button_normal'),
          fontColor: $r('sys.color.ohos_id_color_text_primary'),
          selectedBackgroundColor: $r('sys.color.ohos_id_color_emphasize'),
          selectedFontColor: $r('sys.color.ohos_id_color_text_primary_contrary'),
        },
        selectedIndexes: this.selected_index,
        multiple: true,
        chipGroupSpace: { itemSpace: 8, endSpace: 0 },
        chipGroupPadding: { top: 10, bottom: 10 },
        onChange: (activatedChipsIndex: Array<number>) => {
          console.log('chips on clicked, activated index ' + activatedChipsIndex)
        },
        suffix: this.ChipGroupSuffix
      })
    }
  }
}

鸿蒙HarmonyOS NEXT开发:动态属性设置(ArkTS通用属性) 动态设置组件的属性,支持开发者在属性设置时使用if/else语法,且根据需要使用多态样式设置属性。 阅读详情

相关推荐

鸿蒙OpenHarmony【Chip】信息展示

操作块,用于搜索框历史记录或者邮件发送列表等场景。

asfn123123的博客 1159

鸿蒙界面开发——组件(5):菜单Menu & 绑定菜单

不支持作为普通组件单独使用。Menu 以垂直列表形式显示的菜单。包含MenuItem、MenuItemGroup子组件。布局过程中,期望每个菜单项的宽度一致。若子组件设置了宽度,则以尺寸计算规则为准。不设置宽度的情况:菜单组件会对子组件MenuItem、MenuItemGroup设置默认2栅格的宽度,若菜单项内容区比2栅格宽,则会自适应撑开。设置宽度的情况:菜单组件会对子组件MenuItem、MenuItemGroup设置减去padding后的固定宽度。

littleyy666的博客 1454

鸿蒙5.0版开发:ArkTS组件-SymbolGlyph

显示图标小符号的组件。

m0_69424697的博客 1171

鸿蒙5.0开发进阶:UI框架-图标小符号 (SymbolGlyph/SymbolSpan)

SymbolGlyph是图标小符号组件,便于使用精美的图标,如渲染多色图标。

Androidbye的博客 1007

鸿蒙5.0版开发:ArkTS高级组件-@ohos.arkui.advanced.ProgressButton (下载按钮)

文本下载按钮,可显示具体下载进度。

m0_69424697的博客 474

鸿蒙5.0版开发:ArkTS高级组件-@ohos.arkui.advanced.FormMenu (应用内添加卡片到桌面菜单)

通过桌面访问该应用快捷卡片,可以直接访问该组件功能。

m0_69424697的博客 1326

鸿蒙5.0版开发:ArkTS高级组件-@ohos.arkui.advanced.Popup (气泡组件)

Popup是用于显示特定样式气泡。

m0_69424697的博客 1031

鸿蒙5.0版开发:ArkTS高级组件-@ohos.arkui.advanced.ExceptionPrompt (异常提示)

异常提示,适用于有异常需要提示异常内容的情况。

m0_69424697的博客 977

HarmonyOS应用开发:鸿蒙自定义组件slot插槽,体现的更强大!

自定义组件中通过slot标签来承载父组件中定义的内容,使用slot标签可以更加灵活的控制自定义组件的内容元素

1299

鸿蒙HarmonyOS NEXT开发:自定义绘制设置(ArkTS通用属性)

自定义组件绘制提供了自定义绘制修改器,来实现更自由地组件绘制。

shudaoshanBBQ的博客 1296

鸿蒙Harmony应用开发—ArkTS-高级组件:@ohos.arkui.advanced.Chip(操作块组件)

操作块,用于搜索框历史记录或者邮件发送列表等场景。

m0_64420071的博客 1834

Material Design 进阶(十一)——Chip,ChipGroup,ChipDrawable使用

Chip 可以被放置在 ChipGroup 中,以实现流式布局。该组件合 RadioGroup 很相似,都是用来管理多个子 View 的,可以控制内部子 View 的布局方式。Chip 没有像其他组件一样具有 4 个参数的构造函数,因为它扩展了不支持 4 参数构造函数的 AppCompatCheckbox。但是你可以使用不同的方式。通过xml添加比较简单就不再阐述。重点关注下动态添加,可以为以后做复杂的布局效果做铺垫;

小欣儿的专栏 3050

鸿蒙OpenHarmony【AtomicServiceTabs】元服务

AtomicServiceTabs高级组件,对Tabs组件一些不需提供给用户自定义设计的属性进行简化,限制最多显示5个页签,固定页签样式,位置和大小。

hhhhhh2323的博客 1014

鸿蒙API14开发【ChipGroup】ArkTS组件

ChipGroup是ArkUI提供的高级组件(API Version 12+),用于文件或资源分类等场景。主要特性包括: 支持单选/多选模式,可设置默认选中项 可自定义样式(颜色、大小等)和布局(间距、边距) 提供状态变化回调 支持右侧自定义扩展内容(需引入IconGroupSuffix接口) 通过items数组配置每个选项项,支持设置选中索引、多选开关等属性 默认单选模式下未指定选中项时自动选中首项 该组件适用于需要分组操作的场景,如标签选择、分类筛选等。

bbq的博客 1064

鸿蒙5.0版开发:ArkTS组件-SwipeRefresher

内容加载指获取内容并加载出来,常用于衔接展示下拉加载的内容。

m0_69424697的博客 523

鸿蒙5.0版开发:ArkTS高级组件-@ohos.arkui.advanced.GridObjectSortComponent (网格对象的编辑排序)

网格对象的编辑排序是用于网格对象的编辑、拖动排序、新增和删除。

m0_69424697的博客 1121

arkUI:布局的属性(margin、padding、border、borderRadius)

我们可以在ArkUI 中使用内外边距(padding 和 margin)、边框(border)以及圆角(borderRadius)来调整组件的布局和外观。这些样式是前端开发中常用的布局技巧,能够大幅提升界面的美观性和可用性。每个组件的常见用法都有必要记录一下,后续有不懂的可以回顾查看。毕竟官方文档,有些繁杂的。自己积累自己的文本库。碰到啥记录啥,这些都是经验的积累。没想到不难的内容,编写也要耗费这么多时间。

小蜗牛764号的博客 2230

鸿蒙界面开发——组件(4):图标小符号 (SymbolGlyph/SymbolSpan) & 气泡提示Popup

开发者可以使用构建器CustomPopupOptions创建自定义气泡,@Builder中可以放自定义的内容。除此之外,还可以通过popupColor等参数控制气泡样式。// popup构造器定义弹框内容build() {Column() {})builder: this.popupBuilder, // 气泡的内容*******************************placement:Placement.Bottom, // 气泡的弹出位置。

littleyy666的博客 1360
上一篇: 鸿蒙5.0开发进阶:UI框架-ArkTS组件(Chip)
下一篇: 鸿蒙5.0开发进阶:UI框架-ArkTS组件(Counter)
懂你的大海
博客等级 码龄6年 9049粉丝 1381原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值