往期鸿蒙全套实战文章必看:
@ohos.arkui.advanced.EditableTitleBar (编辑页面标题栏)
编辑型标题栏,适用于多选界面或者内容的编辑界面,一般采取左叉右勾的形式。
说明:
该组件从API Version 10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
导入模块
import { EditableTitleBar } from "@ohos.arkui.advanced.EditableTitleBar"
子组件
无
属性
不支持通用属性
EditableTitleBar
EditableTitleBar({leftIconStyle: EditableLeftIconType, imageItem?: EditableTitleBarItem, title: ResourceStr, subtitle?: ResourceStr, menuItems?: Array<EditableTitleBarMenuItem>, isSaveIconRequired?: boolean, onSave?: () => void, onCancel?: () =>void, options?: EditableTitleBarOptions})
装饰器类型:@Component
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
名称 | 参数类型 | 必填 | 说明 |
---|---|---|---|
leftIconStyle | EditableLeftIconType | 是 | 左侧按钮类型。 原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。 |
imageItem12+ | EditableTitleBarItem | 否 | 用于左侧头像的单个菜单项目。 |
title | ResourceStr | 是 | 标题。 原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。 |
subtitle12+ | ResourceStr | 否 | 副标题。 |
menuItems | Array<EditableTitleBarMenuItem> | 否 | 右侧菜单项目列表。 原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。 |
isSaveIconRequired12+ | boolean | 否 | 是否需要右侧的保存按钮。 默认值:true,表示需要右侧的保存按钮。 |
onSave | () => void | 否 | 保存时的动作闭包。 原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。 |
onCancel | () => void | 否 | 当左侧按钮类型为 Cancel,触发取消时的动作闭包。 从API version 12开始,当左侧按钮类型为 Back,触发返回时的动作闭包。 原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。 |
options12+ | EditableTitleBarOptions | 否 | 标题样式。 |
EditableLeftIconType
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
名称 | 值 | 说明 |
---|---|---|
Back | 0 | 返回按钮。 |
Cancel | 1 | 取消按钮。 |
EditableTitleBarMenuItem
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
value | ResourceStr | 是 | 图标资源。 |
isEnabled | boolean | 否 | 是否启用,默认禁用。 isEnabled为true时,表示为启用。 isEnabled为false时,表示为禁用。 |
action | () => void | 否 | 触发时的动作闭包。 |
EditableTitleBarItem12+
类型 | 说明 |
---|---|
EditableTitleBarMenuItem | 左侧头像的单个菜单类型。 |
EditableTitleBarOptions12+
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
backgroundColor | ResourceStr | 否 | 标题栏背景色。 |
backgroundBlurstyle | BlurStyle | 否 | 标题栏背景模糊样式。 |
safeAreaTypes | Array <SafeAreaType> | 否 | 非必填,配置扩展安全区域的类型。 默认值: [SafeAreaType.SYSTEM] |
safeAreaEdges | Array <SafeAreaEdge> | 否 | 非必填,配置扩展安全区域的方向。 默认值: [SafeAreaEdge.TOP] |
事件
不支持通用事件
示例
示例1
// 该示例主要演示EditableTitleBar设置左侧图标、主标题及自定义右侧图标区的效果。
import { EditableLeftIconType } from "@ohos.arkui.advanced.EditableTitleBar";
import { EditableTitleBar } from "@ohos.arkui.advanced.EditableTitleBar";
import promptAction from '@ohos.promptAction';
@Entry
@Component
struct Index {
build() {
Row() {
Column() {
Divider().height(2).color(0xCCCCCC)
EditableTitleBar({
leftIconStyle: EditableLeftIconType.Cancel,
title: '编辑页面',
menuItems: [],
onCancel: () => {
promptAction.showToast({ message: 'on cancel' });
},
onSave: () => {
promptAction.showToast({ message: 'on save' });
}
})
Divider().height(2).color(0xCCCCCC)
EditableTitleBar({
leftIconStyle: EditableLeftIconType.Back,
title: '编辑页面',
menuItems: [
{
value: $r('app.media.ic_public_reduce'),
isEnabled: false,
action: () => {
promptAction.showToast({ message: 'show toast index 2' });
}
}
],
onSave: () => {
promptAction.showToast({ message: 'on save' })
}
})
Divider().height(2).color(0xCCCCCC)
}.width('100%')
}.height('100%')
}
}
示例2
// 该示例主要演示EditableTitleBar设置背景模糊、头像和取消右侧保存图标的效果。
import { EditableLeftIconType, EditableTitleBar } from '@ohos.arkui.advanced.EditableTitleBar';
import promptAction from '@ohos.promptAction';
import router from '@ohos.router';
@Entry
@Component
struct Index {
build() {
Row() {
Column() {
EditableTitleBar({
leftIconStyle: EditableLeftIconType.Cancel,
title: '主标题',
subtitle: '副标题',
// 设置背景模糊效果
options: {
backgroundBlurStyle: BlurStyle.COMPONENT_THICK,
},
onSave: () => {
promptAction.showToast({ message: "on save" });
},
})
Divider().height(2).color(0xCCCCCC);
EditableTitleBar({
leftIconStyle: EditableLeftIconType.Cancel,
title: '主标题',
subtitle: '副标题',
// 取消右侧保存按钮
isSaveIconRequired: false,
})
Divider().height(2).color(0xCCCCCC);
EditableTitleBar({
leftIconStyle: EditableLeftIconType.Back,
title: '主标题',
subtitle: '副标题',
isSaveIconRequired: false,
onCancel: () => {
router.back();
},
})
Divider().height(2).color(0xCCCCCC);
EditableTitleBar({
leftIconStyle: EditableLeftIconType.Back,
title: '主标题',
subtitle: '副标题',
menuItems: [
{
value: $r('sys.media.ohos_ic_public_remove'),
isEnabled: true,
action: () => {
promptAction.showToast({ message: "show toast index 1" });
}
}
],
isSaveIconRequired: false,
// 点击左侧Back图标,触发的动作。
onCancel: () => {
router.back();
},
})
Divider().height(2).color(0xCCCCCC);
EditableTitleBar({
leftIconStyle: EditableLeftIconType.Back,
title: '主标题',
subtitle: '副标题',
// 设置可点击头像
imageItem: {
value: $r('app.media.img'),
isEnabled: true,
action: () => {
promptAction.showToast({ message: "show toast index 2" });
}
},
// 右侧图标配置
menuItems: [
{
value: $r('sys.media.ohos_ic_public_remove'),
isEnabled: true,
action: () => {
promptAction.showToast({ message: "show toast index 3" });
}
}
],
onCancel: () => {
router.back();
},
})
}
}
}
}