HarmonyOS:GridObjectSortComponent(两个Grid之间网格元素交换)

一、概述

网格对象的编辑排序是用于网格对象的编辑、拖动排序、新增和删除。
说明 该组件从API Version 11开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

二、导入模块

javascript 复制代码
import { GridObjectSortComponent, GridObjectSortComponentItem, GridObjectSortComponentOptions, GridObjectSortComponentType } from '@kit.ArkUI'

三、子组件

无

四、属性

不支持通用属性。

五、GridObjectSortComponent

GridObjectSortComponent({options: GridObjectSortComponentOptions, dataList: Array, onSave: (select: Array, unselect: Array) => void, onCancel: () => void })
装饰器类型: @Component
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 必填 装饰器类型 说明
options GridObjectSortComponentOptions 是 @Prop 组件配置信息。
dataList Array<GridObjectSortComponentItem> 是 - 传入的数据,最大长度为50,数据长度超过50,只会取前50的数据。
onSave (select: Array, unselect: Array<GridObjectSortComponentItem>) => void 是 - 保存编辑排序的回调函数,返回编辑后的数据。
onCancel () => void 是 - 取消保存数据的回调。

六、GridObjectSortComponentOptions

元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 必填 说明
type GridObjectSortComponentType 否 组件展示形态:文字|图片+文字。 默认:GridObjectSortComponentType.text。
imageSize number | Resource 否 图片的尺寸,单位vp。 取值范围:大于等于0。 默认值:56vp。
normalTitle ResourceStr 否 未编辑状态下显示的标题。 默认值:频道。
showAreaTitle ResourceStr 否 展示区域标题,第一个子标题。 默认值:长按拖动排序。
addAreaTitle ResourceStr 否 添加区域标题,第二个子标题。 默认值:点击添加。
editTitle ResourceStr 否 编辑状态下头部标题显示。 默认值:编辑。

七、GridObjectSortComponentType

元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 值 说明
IMAGE_TEXT 'image_text' 图片文字类型。
TEXT 'text' 文字类型。

八、GridObjectSortComponentItem

元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 必填 说明
id number | string 是 数据id序号,不可重复。 默认值:空字符串。
text ResourceStr 是 显示文本信息。
selected boolean 是 是否已经被添加,添加:true,未添加:false。
url ResourceStr 否 GridObjectSortComponentType类型为IMAGE_TEXT时,需要传入图片地址。
order number 是 顺序序号。 取值范围:大于等于0。 默认值:0。

九、事件

不支持通用事件。

十、示例

网格对象的编辑排序组件基础用法,涉及对组件配置信息初始化,数据初始化,保存、取消方法的使用。
效果图


示例TestGridObjectSortComponent.ets代码

typescript 复制代码
import { GridObjectSortComponent, GridObjectSortComponentItem, GridObjectSortComponentOptions, GridObjectSortComponentType } from '@kit.ArkUI'

@Entry
@Component
struct TestGridObjectSortComponent {
  // 组件数据初始化
  @State dataList: GridObjectSortComponentItem[] = [
    {
      id: 0,
      url: $r('sys.media.ohos_save_button_filled'),
      text: '下载',
      selected: true,
      order: 3
    },
    {
      id: 1,
      url: $r('sys.media.ohos_ic_public_web'),
      text: '网路',
      selected: true,
      order: 9
    },
    {
      id: 2,
      url: $r('sys.media.ohos_ic_public_video'),
      text: '视频',
      selected: false,
      order: 1
    }
  ]

  // 组件配置信息初始化
  @State option: GridObjectSortComponentOptions = {
    type: GridObjectSortComponentType.IMAGE_TEXT,
    imageSize: 45,
    normalTitle: '菜单',
    editTitle: '编辑',
    showAreaTitle: '长按拖动排序',
    addAreaTitle: '点击添加'
  }

  build() {
    Column() {
      GridObjectSortComponent({
        options: this.option,
        dataList: this.dataList,
        // 保存编辑排序的回调函数,返回编辑后的数据。
        onSave: (
          select: Array<GridObjectSortComponentItem>,
          unselect: Array<GridObjectSortComponentItem>
        ) => {
          // save ToDo
          console.log("保存编辑排序的回调函数 onSave")
        },
        // 取消保存数据的回调。
        onCancel: () =>{
          // cancel ToDo
          console.log("取消保存数据的回调 onCancel")
        }
      })
    }
  }
}
相关推荐
代码改善世界31 分钟前
鸿蒙电脑能被远程控制吗?ToDesk鸿蒙双向远控能力解析
华为·电脑·harmonyos
OH_TPC7 小时前
ImageKnifePro 源码解读(四):降采样策略族——按显示尺寸改衣服,不按原尺寸硬塞
harmonyos
民办二本的神7 小时前
AI 助手升级后聊天记录又丢了(二):数据一直都在,丢的是"看见"
harmonyos
huang_xiaoen1 天前
鸿蒙手机远程控制电脑哪个好用?2026鸿蒙远控软件横测推荐
华为·harmonyos·远程工作·远程工具·远程办公
爱写Bug的浮游2 天前
初识仓颉:5 分钟看懂核心语法
harmonyos·编程语言
程序猿追3 天前
鸿蒙 PC 的 Ionic 工单有两个错误,按下生成后光标该去哪儿
华为·harmonyos
KevinChaos3 天前
随手备忘录手记 04|HarmonyOS 7.0新特性实验:物品图鉴的加载逻辑
华为·harmonyos
Sirius_Ji3 天前
从硬解基座到字幕与滤镜链:ffmpeg-for-HarmonyOS v0.3.2
harmonyos
用户86194177207413 天前
uni-app 鸿蒙端提现点不动?我用 UTS 插件补上了微信"确认收款"
微信·harmonyos
码间留白3 天前
uni-app 鸿蒙端提现点不动?我用 UTS 插件补上了微信"确认收款"
uni-app·harmonyos·鸿蒙·uts插件·微信商家转账