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

鸿蒙5.0版开发:ArkTS高级组件-@ohos.arkui.advanced.SelectionMenu (文本选择菜单) 文本选择菜单,适用于富文本组件通过bindSelectionMenu绑定自定义文本选择菜单....... 阅读详情

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


SelectionMenu

文本选择菜单,适用于富文本组件通过bindSelectionMenu绑定自定义文本选择菜单,建议绑定鼠标右键或者鼠标选中方式弹出,不支持作为普通组件单独使用。

说明

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

导入模块

import { SelectionMenu, EditorMenuOptions, ExpandedMenuOptions, EditorEventInfo, SelectionMenuOptions } from '@kit.ArkUI'

子组件

无。

SelectionMenu

SelectionMenu(options: SelectionMenuOptions)

入参为空时,文本选择菜单组件SelectionMenu内容区大小及组件大小为零。表现例如,富文本组件RichEditor使用bindSelectionMenu接口绑定一个SelectionMenu的右键菜单,则右键富文本组件区域时无任何菜单弹出。

装饰器类型:@Builder

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

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

参数:

名称参数类型必填说明
optionsSelectionMenuOptions是文本选择菜单可选项。

SelectionMenuOptions

SelectionMenuOptions定义SelectionMenu的可选菜单类型项及其具体配置参数。

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

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

名称参数类型必填说明
editorMenuOptionsArray<EditorMenuOptions>否

编辑菜单。

editorMenuOptions未配置时,不显示编辑菜单。

同时配置EditorMenuOptions中action和builder时,点击图标会同时响应。

点击编辑菜单图标默认不关闭整个菜单,应用可以通过action接口配置RichEditorController的closeSelectionMenu主动关闭菜单。

expandedMenuOptionsArray<ExpandedMenuOptions>否

扩展下拉菜单。

expandedMenuOptions参数为空时无更多按钮,不显示扩展下拉菜单。

expandedMenuOptions参数不为空时显示更多按钮,配置菜单项收起在更多按钮中,点击更多按钮展示。

controllerRichEditorController否

富文本控制器不为空时显示默认系统菜单(包含剪切复制粘贴等部分)且默认菜单功能内置。

controller为空时不显示更多按钮,expandedMenuOptions参数不为空则显示下拉菜单中。

系统默认只支持复制粘贴富文本文本内容,图文混排需要应用自定义onCopy、onPaste接口。应用自行配置onCopy | onPaste接口时,系统菜单默认复制粘贴失效,调用应用自定义函数。

说明:

点击自定义文本选择菜单内置复制功能选项后,自定义菜单消失选中文本高亮保留。

点击自定义文本选择菜单内置全选功能选项后,自定义菜单消失文本全选高亮。

点击自定义文本选择菜单内置粘贴功能选项后,空白处粘贴或者选中文本替换粘贴均是保留被复制文本的样式。

当富文本组件RichEditor的copyOptions属性设置为CopyOptions.None时,内置的复制剪切功能不会被限制。

onCopy(event?: EditorEventInfo) => void否

替代内置系统菜单复制项的事件回调。

生效前提是一定要有controller参数,有系统默认菜单才能替换内置复制功能。

说明:

event为返回信息。

onPaste(event?: EditorEventInfo) => void否

替代内置系统菜单粘贴项的事件回调。

生效前提是一定要有controller参数,有系统默认菜单才能替换内置粘贴功能。

说明:

event为返回信息。

onCut(event?: EditorEventInfo) => void否

替代内置系统菜单剪切项的事件回调。

生效前提是一定要有controller参数,有系统默认菜单才能替换内置剪切功能。

说明:

event为返回信息。

onSelectAll(event?: EditorEventInfo) => void否

替代内置系统菜单全选项的事件回调。

生效前提是一定要有controller参数,有系统默认菜单才能替换内置全选功能。

说明:

event为返回信息。

EditorMenuOptions

编辑菜单选项。

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

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

名称类型必填说明
iconResourceStr是图标资源。
builder() => void否点击时显示用户自定义组件,自定义组件在构造时结合@Builder使用。
action() => void否点击菜单项的事件回调。

ExpandedMenuOptions

扩展下拉菜单。

继承于MenuItemOptions。

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

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

名称类型必填说明
action() => void否点击菜单项的事件回调。

EditorEventInfo

选中内容信息。

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

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

名称类型必填说明
contentRichEditorSelection否选中内容信息。

属性

不支持通用属性,宽度默认224vp, 高度自适应内容。

事件

不支持通用事件。

示例

该示例展示了文本绑定不同触发方式的自定义文本选择菜单的效果。

import { SelectionMenu, EditorMenuOptions, ExpandedMenuOptions, EditorEventInfo, SelectionMenuOptions } from '@kit.ArkUI'

@Entry
@Component
struct Index {
  @State select: boolean = true
  controller: RichEditorController = new RichEditorController();
  options: RichEditorOptions = { controller: this.controller }
  @State message: string = 'Hello world'
  @State textSize: number = 30
  @State fontWeight: FontWeight = FontWeight.Normal
  @State start: number = -1
  @State end: number = -1
  @State visibleValue: Visibility = Visibility.Visible
  @State colorTransparent: Color = Color.Transparent
  @State textStyle: RichEditorTextStyle = {}
  private editorMenuOptions: Array<EditorMenuOptions> =
    [
      { icon: $r("app.media.ic_notepad_textbold"), action: () => {
        if (this.controller) {
          let selection = this.controller.getSelection();
          let spans = selection.spans
          spans.forEach((item: RichEditorTextSpanResult | RichEditorImageSpanResult, index) => {
            if (typeof (item as RichEditorTextSpanResult)['textStyle'] != 'undefined') {
              let span = item as RichEditorTextSpanResult
              this.textStyle = span.textStyle
              let start = span.offsetInSpan[0]
              let end = span.offsetInSpan[1]
              let offset = span.spanPosition.spanRange[0]
              if (this.textStyle.fontWeight != 11) {
                this.textStyle.fontWeight = FontWeight.Bolder
              } else {
                this.textStyle.fontWeight = FontWeight.Normal
              }
              this.controller.updateSpanStyle({
                start: offset + start,
                end: offset + end,
                textStyle: this.textStyle
              })
            }
          })
        }
      } },
      { icon: $r("app.media.ic_notepad_texttilt"), action: () => {
        if (this.controller) {
          let selection = this.controller.getSelection();
          let spans = selection.spans
          spans.forEach((item: RichEditorTextSpanResult | RichEditorImageSpanResult, index) => {
            if (typeof (item as RichEditorTextSpanResult)['textStyle'] != 'undefined') {
              let span = item as RichEditorTextSpanResult
              this.textStyle = span.textStyle
              let start = span.offsetInSpan[0]
              let end = span.offsetInSpan[1]
              let offset = span.spanPosition.spanRange[0]
              if (this.textStyle.fontStyle == FontStyle.Italic) {
                this.textStyle.fontStyle = FontStyle.Normal
              } else {
                this.textStyle.fontStyle = FontStyle.Italic
              }
              this.controller.updateSpanStyle({
                start: offset + start,
                end: offset + end,
                textStyle: this.textStyle
              })
            }
          })
        }
      } },
      { icon: $r("app.media.ic_notepad_underline"),
        action: () => {
          if (this.controller) {
            let selection = this.controller.getSelection();
            let spans = selection.spans
            spans.forEach((item: RichEditorTextSpanResult | RichEditorImageSpanResult, index) => {
              if (typeof (item as RichEditorTextSpanResult)['textStyle'] != 'undefined') {
                let span = item as RichEditorTextSpanResult
                this.textStyle = span.textStyle
                let start = span.offsetInSpan[0]
                let end = span.offsetInSpan[1]
                let offset = span.spanPosition.spanRange[0]
                if (this.textStyle.decoration) {
                  if (this.textStyle.decoration.type == TextDecorationType.Underline) {
                    this.textStyle.decoration.type = TextDecorationType.None
                  } else {
                    this.textStyle.decoration.type = TextDecorationType.Underline
                  }
                } else {
                  this.textStyle.decoration = { type: TextDecorationType.Underline, color: Color.Black }
                }
                this.controller.updateSpanStyle({
                  start: offset + start,
                  end: offset + end,
                  textStyle: this.textStyle
                })
              }
            })
          }
        }
      },
      { icon: $r("app.media.app_icon"), action: () => {
      }, builder: (): void => this.sliderPanel() },
      { icon: $r("app.media.ic_notepad_textcolor"), action: () => {
        if (this.controller) {
          let selection = this.controller.getSelection();
          let spans = selection.spans
          spans.forEach((item: RichEditorTextSpanResult | RichEditorImageSpanResult, index) => {
            if (typeof (item as RichEditorTextSpanResult)['textStyle'] != 'undefined') {
              let span = item as RichEditorTextSpanResult
              this.textStyle = span.textStyle
              let start = span.offsetInSpan[0]
              let end = span.offsetInSpan[1]
              let offset = span.spanPosition.spanRange[0]
              if (this.textStyle.fontColor == Color.Orange || this.textStyle.fontColor == '#FFFFA500') {
                this.textStyle.fontColor = Color.Black
              } else {
                this.textStyle.fontColor = Color.Orange
              }
              this.controller.updateSpanStyle({
                start: offset + start,
                end: offset + end,
                textStyle: this.textStyle
              })
            }
          })
        }
      } }]
  private expandedMenuOptions: Array<ExpandedMenuOptions> =
    [{ startIcon: $r("app.media.icon"), content: '词典', action: () => {
    } }, { startIcon: $r("app.media.icon"), content: '翻译', action: () => {
    } }, { startIcon: $r("app.media.icon"), content: '搜索', action: () => {
    } }]
  private expandedMenuOptions1: Array<ExpandedMenuOptions> = []
  private editorMenuOptions1: Array<EditorMenuOptions> = []
  private selectionMenuOptions: SelectionMenuOptions = {
    editorMenuOptions: this.editorMenuOptions,
    expandedMenuOptions: this.expandedMenuOptions,
    controller: this.controller,
    onCut: (event?: EditorEventInfo) => {
      if (event && event.content) {
        event.content.spans.forEach((item: RichEditorTextSpanResult | RichEditorImageSpanResult, index) => {
          if (typeof (item as RichEditorTextSpanResult)['textStyle'] != 'undefined') {
            let span = item as RichEditorTextSpanResult
            console.info('test cut' + span.value)
            console.info('test start ' + span.offsetInSpan[0] + ' end: ' + span.offsetInSpan[1])
          }
        })
      }
    },
    onPaste: (event?: EditorEventInfo) => {
      if (event && event.content) {
        event.content.spans.forEach((item: RichEditorTextSpanResult | RichEditorImageSpanResult, index) => {
          if (typeof (item as RichEditorTextSpanResult)['textStyle'] != 'undefined') {
            let span = item as RichEditorTextSpanResult
            console.info('test onPaste' + span.value)
            console.info('test start ' + span.offsetInSpan[0] + ' end: ' + span.offsetInSpan[1])
          }
        })
      }
    },
    onCopy: (event?: EditorEventInfo) => {
      if (event && event.content) {
        event.content.spans.forEach((item: RichEditorTextSpanResult | RichEditorImageSpanResult, index) => {
          if (typeof (item as RichEditorTextSpanResult)['textStyle'] != 'undefined') {
            let span = item as RichEditorTextSpanResult
            console.info('test cut' + span.value)
            console.info('test start ' + span.offsetInSpan[0] + ' end: ' + span.offsetInSpan[1])
          }
        })
      }
    },
    onSelectAll: (event?: EditorEventInfo) => {
      if (event && event.content) {
        event.content.spans.forEach((item: RichEditorTextSpanResult | RichEditorImageSpanResult, index) => {
          if (typeof (item as RichEditorTextSpanResult)['textStyle'] != 'undefined') {
            let span = item as RichEditorTextSpanResult
            console.info('test onPaste' + span.value)
            console.info('test start ' + span.offsetInSpan[0] + ' end: ' + span.offsetInSpan[1])
          }
        })
      }
    }
  }

  @Builder sliderPanel() {
    Column() {
      Flex({ justifyContent: FlexAlign.SpaceBetween, alignItems: ItemAlign.Center }) {
        Text('A').fontSize(15)
        Slider({ value: this.textSize, step: 10, style: SliderStyle.InSet })
          .width(210)
          .onChange((value: number, mode: SliderChangeMode) => {
            if (this.controller) {
              let selection = this.controller.getSelection();
              if (mode == SliderChangeMode.End) {
                if (this.textSize == undefined) {
                  this.textSize = 0
                }
                let spans = selection.spans
                spans.forEach((item: RichEditorTextSpanResult | RichEditorImageSpanResult, index) => {
                  if (typeof (item as RichEditorTextSpanResult)['textStyle'] != 'undefined') {
                    this.textSize = Math.max(this.textSize, (item as RichEditorTextSpanResult).textStyle.fontSize)
                  }
                })
              }
              if (mode == SliderChangeMode.Moving || mode == SliderChangeMode.Click) {
                this.start = selection.selection[0]
                this.end = selection.selection[1]
                this.textSize = value
                this.controller.updateSpanStyle({
                  start: this.start,
                  end: this.end,
                  textStyle: { fontSize: this.textSize }
                })
              }
            }
          })
        Text('A').fontSize(20).fontWeight(FontWeight.Medium)
      }.borderRadius($r('sys.float.ohos_id_corner_radius_card'))
    }
    .shadow(ShadowStyle.OUTER_DEFAULT_MD)
    .backgroundColor(Color.White)
    .borderRadius($r('sys.float.ohos_id_corner_radius_card'))
    .padding(15)
    .height(48)
  }

  @Builder
  MyMenu() {
    Column() {
      SelectionMenu(this.selectionMenuOptions)
    }
    .width(256)
    .backgroundColor(Color.Transparent)
  }

  @Builder
  MyMenu2() {
    Column() {
      SelectionMenu({
        editorMenuOptions: this.editorMenuOptions,
        expandedMenuOptions: this.expandedMenuOptions1,
        controller: this.controller,
      })
    }
    .width(256)
    .backgroundColor(Color.Transparent)
  }

  @Builder
  MyMenu3() {
    Column() {
      SelectionMenu({
        editorMenuOptions: this.editorMenuOptions1,
        expandedMenuOptions: this.expandedMenuOptions,
        controller: this.controller,
      })
    }
    .width(256)
    .backgroundColor(Color.Transparent)
  }

  build() {
    Column() {
      Button("SetSelection")
        .onClick((event: ClickEvent) => {
          if (this.controller) {
            this.controller.setSelection(0, 2)
          }
        })

      RichEditor(this.options)
        .onReady(() => {
          this.controller.addTextSpan(this.message, { style: { fontColor: Color.Orange, fontSize: 30 } })
          this.controller.addTextSpan(this.message, { style: { fontColor: Color.Black, fontSize: 25 } })
        })
        .onSelect((value: RichEditorSelection) => {
          if (value.selection[0] == -1 && value.selection[1] == -1) {
            return
          }
          this.start = value.selection[0]
          this.end = value.selection[1]
        })
        .bindSelectionMenu(RichEditorSpanType.TEXT, this.MyMenu3(), RichEditorResponseType.RIGHT_CLICK)
        .bindSelectionMenu(RichEditorSpanType.TEXT, this.MyMenu2(), RichEditorResponseType.SELECT)
        .borderWidth(1)
        .borderColor(Color.Red)
        .width(200)
        .height(200)
    }
  }
}

说明

系统暂未预置加粗、斜体等图标,示例代码使用本地资源图标,开发者使用时需自行替换editorMenuOptions中icon项的资源。

【HarmonyOS】ArkTS学习之二级菜单的实现 注意:官网上有说Menu组件不支持作为普通组件单独使用,不确定这样用会不会带来什么问题。 阅读详情

相关推荐

鸿蒙Harmony应用开发—ArkTS声明式开发(基础手势:Menu)

ArkTS声明式开发-基础手势:Menu

m0_64420071的博客 1381

【HarmonyOS NEXT】鸿蒙获取手势触摸点的屏幕全局坐标

通过平移手势,在动作开始前,动作中,动作后,三个回调触摸事件中,有fingerList属性,可以拿到FingerInfo对象,其中的global坐标可以拿到屏幕全局坐标。在Android和IOS中,使用手势触摸事件的x,y坐标,做一些逻辑处理。比如拖动小窗口,滑动触摸响应tips文字内容等。都需要拿到手势触摸点的屏幕全局坐标。根据业务需求的不同,可以挑选global,local,display三种类型的坐标使用。比如根据手势x坐标,去提示对应区域的文字内容。

路漫漫亦无涯 1071

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

以垂直列表形式显示的菜单。

m0_69424697的博客 847

第65节 ArkTS 中制作菜单

组件是一个灵活且强大的功能,它允许开发者为应用创建丰富的交互体验。通过合理配置菜单项和样式属性,开发者可以打造出符合用户需求的弹出式菜单。元素,它允许开发者为应用中的组件绑定弹出式菜单,增强用户交互体验。两个菜单项的弹出式菜单绑定到了该文本组件上。当用户点击文本组件时,菜单会显示出来。方法可以将一个弹出式菜单绑定到一个组件上。场景中,过多的菜单项可能会影响应用的性能。在上面的示例中,我们创建了一个简单的文本组件,并使用。如果设置了宽度,则菜单组件会对子组件设置减去。边框宽度,支持设置的最小宽度为。

m0_60889254的博客 798

ArkTS 下拉菜单总结

鸿蒙有中文的开发文档,对于初次使用ArkTS的开发者来说很友好。有过Flutter开发经验的会较快上手。1、List的edgeEffect、LazyForEach。3、容器的.markAnchor可以和offset搭配使用。2、opacity属性可以设置整个组件的透明度。半成品代码实例、仿京东首页差一部分内容。

weixin_38622593的博客 1454

HarmonyOS Next开发学习手册——菜单(Menu)

当默认样式不满足开发需求时,可使用@Builder自定义菜单内容,通过bindMenu接口进行菜单的自定义。

maniuT的博客 933

鸿蒙ArkTS声明式组件:【Menu】

以垂直列表形式显示的菜单。

2401_82772199的博客 492

鸿蒙Harmony应用开发—ArkTS声明式开发(基础手势:Search)

ArkTS声明式开发(基础手势:Search)

m0_64420071的博客 2108

ArkTS开发系列之气泡(Popup)和菜单(Menu)学习(2.4)

【代码】ArkTS开发系列之气泡(Popup)和菜单(Menu)学习(2.4)

jay_chess的博客 960

鸿蒙ArkTS声明式组件:【RichText】

定义段落。这是一个段落插入一个简单的换行符。这是一个段落这是换行段落规定文本的字体、字体尺寸、字体颜色。在标签中font size能够设置的值只有1到7的数字,默认值是3,由于标签在HTML 4.01中不建议使用,在XHTML1.0 Strict DTD中不支持,所以不建议使用此标签,请使用CSS代替。这是一段红色字体。定义HTML页面中的主题变化(比如话题的转移),并显示为一条水平线。这个一个段落这是一个段落用来定义图片。常用于组合块级元素,以便通过CSS来对这些元素进行格式化。

2401_82772199的博客 1584

鸿蒙HarmonyOS开发:渲染展示图片组件-image

image是图片组件,用来渲染展示图片。

2401_84917132的博客 1139

鸿蒙next版开发:ArkTS组件通用属性(菜单控制)

开发者可以通过自定义Menu@BuilderFlex({}) {Column() {Row() {.width(20)`);});});build() {Column() {在这个示例中,我们创建了一个包含图像和文本的复杂菜单项,并通过ForEach循环来生成多个菜单项。通过本文的介绍,你应该对HarmonyOS 5.0中ArkTS组件的菜单控制有了基本的了解。菜单控制是UI开发中的重要工具,合理利用这些属性可以使你的应用界面更加友好和互动。

小淼淼的博客 609

鸿蒙5.0版开发:ArkTS基础组件(RichText)

富文本组件,解析并显示HTML格式文本。

m0_69424697的博客 1523

鸿蒙UI系统组件10——菜单(Menu)

当默认样式不满足开发需求时,可使用@Builder自定义菜单内容。可通过bindMenu接口进行菜单的自定义。step1: @Builder开发菜单内的内容​​​​​​​。

harmonyClassRoom的博客 1276

鸿蒙OpenHarmony【SelectionMenu】ArkTS文本与输入

文本选择菜单,适用于富文本组件通过[bindSelectionMenu]绑定自定义文本选择菜单,建议绑定鼠标右键或者鼠标选中方式弹出,不支持作为普通组件单独使用。

asfn123123的博客 1271

HarmonyOS NEXT实战开发:全屏模态转场(bindContentCover)

通过bindContentCover属性为组件绑定全屏模态页面,在组件插入和删除时可通过设置转场参数ModalTransition显示过渡动效。

hanyanyou的博客 1556

【鸿蒙软件开发】ArkTS基础组件之Rating(评分组件)、RichText(富文本显示)

Rating组件:提供在给定范围内选择评分的组件。 RichText组件:富文本组件,解析并显示HTML格式文本。提供在给定范围内选择评分的组件。说明 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。无 从API version 9开始,该接口支持在ArkTS卡片中使用。参数名:rating,参数类型:number,参数是否必填:是,参数作用:设置并接收评分值。默认值:0 取值范围: [0, stars],规定:小于0取0,大于stars取最大值sta

m0_62599305的博客 2246

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

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明:

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

余额充值