纯血鸿蒙ArkUI按钮组件详解
Button是按钮组件,通常用于响应用户的点击操作,其类型包括胶囊按钮、圆形按钮、普通按钮。Button做为容器使用时可以通过添加子组件实现包含文字、图片等元素的按钮。
创建按钮
Button通过调用接口来创建,接口调用有以下两种形式:
1. 创建不包含子组件的按钮。
Button(label?: ResourceStr, options?: {
type?: ButtonType,
stateEffect?: boolean
})
其中,label用来设置按钮文字,type用于设置Button类型,stateEffect属性设置Button是否开启点击效果。
@Entry
@Component
struct ButtonSample {
build() {
Column() {
// 按钮组件,第一个参数设置按钮显示的文本
// 第二个参数设置按钮的类型为普通按钮,设置点击动效为true
Button('Ok', { type: ButtonType.Normal, stateEffect: true })
// 设置按钮的边框圆角半径
.borderRadius(8)
// 设置按钮的背景色
.backgroundColor(0x317aff)
// 设置按钮的宽度
.width(90)
// 设置按钮的高度
.height(40)
}.alignItems(HorizontalAlign.Center)
.height('100%').width('100%')
}
}
显示效果如下图所示:
2. 创建包含子组件的按钮。
Button(options?: {type?: ButtonType, stateEffect?: boolean})
只支持包含一个子组件,子组件可以是基础组件或者容器组件。
@Entry
@Component
struct ButtonSample {
build() {
Column() {
// 设置按钮的效果为普通按钮
// 设置带有按钮的点按动效
Button({ type: ButtonType.Normal, stateEffect: true }) {
// 按钮的子组件
Row() {
// 图片
Image($r('app.media.loading'))
// 设置图片的宽度为20vp,设置图片的高度为40vp,设置图片的左外边距为12vp
.width(20).height(20).margin({ left: 10 })
// 文本显示组件
Text('loading')
// 设置文本字号为12vp,设置字体颜色为白色,设置左外边距为5vp,右外边距为12vp
.fontSize(12).fontColor(0xffffff).margin({ left: 5, right: 10 })
}
// 行容器组件的子组件垂直方向排列方式为垂直居中
.alignItems(VerticalAlign.Center)
}
// 设置按钮的边框圆角半径为8vp,设置背景色,设置宽度为90vp高度为40vp
.borderRadius(8).backgroundColor(0x317aff).width(90).height(40)
}
// 设置子组件水平方向居中对齐
.alignItems(HorizontalAlign.Center)
.height('100%').width('100%')
}
}
显示效果如下图所示:
设置按钮类型
Button有三种可选类型,分别为胶囊类型(Capsule)、圆形按钮(Circle)和普通按钮(Normal),通过type进行设置。
1. 胶囊按钮(默认类型)
此类型按钮的圆角自动设置为高度的一半,不支持通过borderRadius属性重新设置圆角。
@Entry
@Component
struct ButtonSample {
build() {
Column() {
// 设置按钮显示的文本
// 设置按钮的样式为胶囊样式,设置按钮不包含点按动效
Button('Disable', { type: ButtonType.Capsule, stateEffect: false })
// 设置背景色,设置宽度为90vp高度40vp
.backgroundColor(0x317aff).width(90).height(40)
}
// 设置子组件水平方向居中对齐
.alignItems(HorizontalAlign.Center)
.height('100%').width('100%')
}
}
显示效果如下图所示:
2. 圆形按钮
此类型按钮为圆形,不支持通过borderRadius属性重新设置圆角。
@Entry
@Component
struct ButtonSample {
build() {
Column() {
// 设置按钮显示的文本
// 设置按钮的样式为圆形,设置不包含点按动效
Button('Circle', { type: ButtonType.Circle, stateEffect: false })
// 设置按钮的背景色,设置按钮的宽度和高度都是90vp
.backgroundColor(0x317aff).width(90).height(90)
}
// 设置子组件水平方向居中对齐
.alignItems(HorizontalAlign.Center)
.height('100%').width('100%')
}
}
显示的效果如下图所示:
3. 普通按钮
此类型的按钮默认圆角为0,支持通过borderRadius属性重新设置圆角。
@Entry
@Component
struct ButtonSample {
build() {
Column() {
// 设置按钮显示的文本
// 设置按钮的样式为普通样式
// 设置按钮包含点按动效
Button('Ok', { type: ButtonType.Normal, stateEffect: true })
// 设置按钮的边框圆角半径
.borderRadius(8)
// 设置按钮的背景色
.backgroundColor(0x317aff)
// 设置按钮的宽度为90vp
.width(90)
// 设置按钮的高度为40vp
.height(40)
}
// 设置子组件水平方向居中对齐
.alignItems(HorizontalAlign.Center)
.height('100%').width('100%')
}
}
显示的效果如下图所示:
自定义样式
1. 设置边框弧度。
使用通用属性来自定义按钮样式。例如通过borderRadius属性设置按钮的边框弧度。
@Entry
@Component
struct ButtonSample {
build() {
Column() {
// 设置按钮显示的文本
// 设置按钮的类型为普通样式
Button('circle border', { type: ButtonType.Normal })
// 设置按钮的边框圆角半径为20vp
// 设置按钮的高度为40vp
.borderRadius(20).height(40)
}
// 设置子组件水平方向居中对齐
.alignItems(HorizontalAlign.Center)
.height('100%').width('100%')
}
}
显示的效果如下图所示:
2. 设置文本样式。
通过添加文本样式设置按钮文本的展示样式。
@Entry
@Component
struct ButtonSample {
build() {
Column() {
// 设置按钮显示的文本
// 设置按钮的样式为普通样式
Button('font style', { type: ButtonType.Normal })
// 设置按钮显示文本的字号为20vp
// 设置按钮显示的文本颜色为粉色
// 设置按钮显示的文本的粗细
.fontSize(20).fontColor(Color.Pink).fontWeight(800)
}
// 设置子组件水平方向居中对齐
.alignItems(HorizontalAlign.Center)
.height('100%').width('100%')
}
}
显示的效果如下图所示:
3. 设置背景颜色。
添加backgroundColor属性设置按钮的背景颜色。
@Entry
@Component
struct ButtonSample {
build() {
Column() {
// 设置按钮显示的文本
Button('background color')
// 设置按钮的背景色
.backgroundColor(0xF55A42)
}
// 设置子组件水平方向居中对齐
.alignItems(HorizontalAlign.Center)
.height('100%').width('100%')
}
}
显示的效果如下图所示:
4. 创建功能型按钮。
为删除操作创建一个按钮。
// 通过Record类型数据设置布局参数
let MarLeft: Record<string, number> = { 'left': 20 }
@Entry
@Component
struct ButtonSample {
build() {
Column() {
// 设置按钮的样式为圆形,设置包含点按动效
Button({ type: ButtonType.Circle, stateEffect: true }) {
// 按钮的子组件,图片组件,设置宽度和高度都是30vp
Image($r('app.media.ic_public_delete_filled')).width(30).height(30)
}
// 设置按钮的宽度和高度都是55vp
.width(55).height(55)
// 使用Record类型的数据设置按钮的外边距,设置按钮的背景色
.margin(MarLeft).backgroundColor(0xF55A42)
}
// 设置子组件水平方向居中对齐
.alignItems(HorizontalAlign.Center)
.height('100%').width('100%')
}
}
显示效果如下图所示:
添加事件
Button组件通常用于触发某些操作,可以绑定onClick事件来响应点击操作后的自定义行为。
Button('Ok', { type: ButtonType.Normal, stateEffect: true })
// 添加按钮的点击事件处理函数
.onClick(()=>{
console.info('Button onClick')
})
场景示例
1. 用于启动操作。
可以用按钮启动任何用户界面元素,按钮会根据用户的操作触发相应的事件。例如,在List容器里通过点击按钮进行页面跳转。
ButtonCase1.ets
import { pageOneTmp } from './pageOne';
import { pageThreeTmp } from './pageThree';
import { pageTwoTmp } from './pageTwo';
@Entry
@Component
struct ButtonCase1 {
pathStack: NavPathStack = new NavPathStack();
@Builder
PageMap(name: string) {
if (name === "first_page") {
pageOneTmp()
} else if (name === "second_page") {
pageTwoTmp()
} else if (name === "third_page") {
pageThreeTmp()
}
}
build() {
Navigation(this.pathStack) {
// 列表组件
List({ space: 4 }) {
// 列表子组件
ListItem() {
// 设置按钮显示的文本
Button("First")
// 设置按钮点击事件处理函数
.onClick(() => {
// 当点击的时候切换到页面1
this.pathStack.pushPath({ name: "first_page" })
}).width('100%')
}
// 列表子组件
ListItem() {
// 设置按钮显示的文本
Button("Second")
// 设置按钮点击事件处理函数
.onClick(() => {
// 当点击的时候切换到页面2
this.pathStack.pushPath({ name: "second_page" })
}).width('100%')
}
// 列表子组件
ListItem() {
// 设置按钮显示的文本
Button("Third")
// 设置按钮点击事件处理函数
.onClick(() => {
// 当点击的时候切换到页面3
this.pathStack.pushPath({ name: "third_page" })
}).width('100%')
}
}.listDirection(Axis.Vertical).backgroundColor(0xDCDCDC).padding(20)
}
// 设置导航模式:导航条和内容区在栈中显示
.mode(NavigationMode.Stack)
// 设置用户定义的导航终点组件
.navDestination(this.PageMap)
}
}
pageOne.ets
@Component
export struct pageOneTmp {
pathStack: NavPathStack = new NavPathStack();
build() {
// 导航终点组件
NavDestination() {
// 列容器组件
Column() {
// 文本组件
Text("first_page")
}.width('100%').height('100%')
}.title("pageOne")
.onBackPressed(() => {
// 当点击返回按钮的时候,弹出路由栈栈顶元素
const popDestinationInfo = this.pathStack.pop()
console.log('pop' + '返回值' + JSON.stringify(popDestinationInfo))
// 返回true表示路由成功
return true
}).onReady((context: NavDestinationContext) => {
// 当导航终点准备好的时候,设置导航路径栈
this.pathStack = context.pathStack
})
}
}
pageTwo.ets
@Component
export struct pageTwoTmp {
pathStack: NavPathStack = new NavPathStack();
build() {
NavDestination() {
Column() {
Text("second_page")
}.width('100%').height('100%')
}.title("pageTwo").onBackPressed(() => {
const popDestinationInfo = this.pathStack.pop() // 弹出路由栈栈顶元素
console.log('pop' + '返回值' + JSON.stringify(popDestinationInfo))
return true
}).onReady((context: NavDestinationContext) => {
this.pathStack = context.pathStack
})
}
}
pageThree.ets
@Component
export struct pageThreeTmp {
pathStack: NavPathStack = new NavPathStack();
build() {
NavDestination() {
Column() {
Text("third_page")
}.width('100%').height('100%')
}.title("pageThree").onBackPressed(() => {
const popDestinationInfo = this.pathStack.pop() // 弹出路由栈栈顶元素
console.log('pop' + '返回值' + JSON.stringify(popDestinationInfo))
return true
}).onReady((context: NavDestinationContext) => {
this.pathStack = context.pathStack
})
}
}
显示的效果如下图所示:
2. 用于提交表单。
在用户登录/注册页面,使用按钮进行登录或注册操作。
@Entry
@Component
struct ButtonCase2 {
build() {
Column() {
// 文本输入组件,设置占位符,设置顶部外边距为20vp
TextInput({ placeholder: 'input your username' }).margin({ top: 20 })
// 文本输入组件,设置占位符,设置组件类型为密码框,设置顶部外边距为20vp
TextInput({ placeholder: 'input your password' }).type(InputType.Password).margin({ top: 20 })
// 按钮组件,设置显示的文本
Button('Register')
// 设置宽度为300vp,设置顶部外边距为20vp
.width(300).margin({ top: 20 })
// 设置点击事件的处理函数
.onClick(() => {
// 当点击按钮的时候,执行操作
// ...
})
}.padding(20)
}
}
显示的效果如下图所示:
3. 悬浮按钮
在可以滑动的界面,滑动时按钮始终保持悬浮状态。
@Entry
@Component
struct HoverButtonExample {
private arr: number[] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
build() {
// 层叠布局
Stack() {
List({ space: 20, initialIndex: 0 }) {
// 使用ForEach循环渲染列表组件中的列表项组件
ForEach(this.arr, (item: number) => {
ListItem() {
Text('' + item)
.width('100%')
.height(100)
.fontSize(16)
.textAlign(TextAlign.Center)
.borderRadius(10)
.backgroundColor(0xFFFFFF)
}
}, (item: number) => item.toString())
}.width('90%')
// 按钮组件
Button() {
// 按钮组件的子组件,图片组件,设置图片组件要显示的图片,同时设置宽和高都是50vp
Image($r('app.media.ic_public_add')).width(50).height(50)
}
.width(60)
.height(60)
// 指定该按钮组件所处的位置
.position({ x: '80%', y: 600 })
// 阴影效果:边框阴影半径为10vp
.shadow({ radius: 10 })
.onClick(() => {
// 需要执行的操作
})
}.width('100%').height('100%').backgroundColor(0xDCDCDC).padding({ top: 5 })
}
}
显示效果如下图所示:
右上图对比可知,按钮处于悬浮状态,在列表组件滚动的时候按钮处于原位不动。