按钮组件

2024-01-22 17:05 更新

按钮组件,可快速创建不同样式的按钮。

说明

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

子组件

可以包含单个子组件。

接口

方法1: Button(options?: {type?: ButtonType, stateEffect?: boolean})

从API version 9开始,该接口支持在ArkTS卡片中使用。

参数:

参数名

参数类型

必填

参数描述

type

ButtonType

描述按钮显示样式。

默认值:ButtonType.Capsule

stateEffect

boolean

按钮按下时是否开启按压态显示效果,当设置为false时,按压效果关闭。

默认值:true

说明:当开启按压态显示效果,开发者设置状态样式时,会基于状态样式设置完成后的背景色再进行颜色叠加。

方法2: Button(label?: ResourceStr, options?: { type?: ButtonType, stateEffect?: boolean })

使用文本内容创建相应的按钮组件,此时Button无法包含子组件。

从API version 9开始,该接口支持在ArkTS卡片中使用。

参数:

参数名

参数类型

必填

参数描述

label

ResourceStr

按钮文本内容。

options

{ type?: ButtonType, stateEffect?: boolean }

见方法1参数说明。

属性

除支持通用属性外,还支持以下属性:

名称

参数类型

描述

type

ButtonType

设置Button样式。

默认值:ButtonType.Capsule

从API version 9开始,该接口支持在ArkTS卡片中使用。

stateEffect

boolean

按钮按下时是否开启按压态显示效果,当设置为false时,按压效果关闭。

默认值:true

从API version 9开始,该接口支持在ArkTS卡片中使用。

事件

支持通用事件

ButtonType枚举说明

从API version 9开始,该接口支持在ArkTS卡片中使用。

名称

描述

Capsule

胶囊型按钮(圆角默认为高度的一半)。

Circle

圆形按钮。

Normal

普通按钮(默认不带圆角)。

说明
  • 按钮圆角通过通用属性borderRadius设置(不支持通过border接口设置圆角),且只支持设置一个相同的圆角。
  • 当按钮类型为Capsule时,borderRadius设置不生效,按钮圆角始终为宽、高中较小值的一半。
  • 当按钮类型为Circle时,borderRadius即为按钮半径,若未设置borderRadius按钮半径则为宽、高中较小值的一半。
  • 按钮文本通过通用文本样式进行设置。
  • 设置颜色渐变需先设置backgroundColor为透明色。

示例

示例1

  1. // xxx.ets
  2. @Entry
  3. @Component
  4. struct ButtonExample {
  5. build() {
  6. Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Start, justifyContent: FlexAlign.SpaceBetween }) {
  7. Text('Normal button').fontSize(9).fontColor(0xCCCCCC)
  8. Flex({ alignItems: ItemAlign.Center, justifyContent: FlexAlign.SpaceBetween }) {
  9. Button('OK', { type: ButtonType.Normal, stateEffect: true })
  10. .borderRadius(8)
  11. .backgroundColor(0x317aff)
  12. .width(90)
  13. .onClick(() => {
  14. console.log('ButtonType.Normal')
  15. })
  16. Button({ type: ButtonType.Normal, stateEffect: true }) {
  17. Row() {
  18. LoadingProgress().width(20).height(20).margin({ left: 12 }).color(0xFFFFFF)
  19. Text('loading').fontSize(12).fontColor(0xffffff).margin({ left: 5, right: 12 })
  20. }.alignItems(VerticalAlign.Center)
  21. }.borderRadius(8).backgroundColor(0x317aff).width(90).height(40)
  22. Button('Disable', { type: ButtonType.Normal, stateEffect: false }).opacity(0.4)
  23. .borderRadius(8).backgroundColor(0x317aff).width(90)
  24. }
  25. Text('Capsule button').fontSize(9).fontColor(0xCCCCCC)
  26. Flex({ alignItems: ItemAlign.Center, justifyContent: FlexAlign.SpaceBetween }) {
  27. Button('OK', { type: ButtonType.Capsule, stateEffect: true }).backgroundColor(0x317aff).width(90)
  28. Button({ type: ButtonType.Capsule, stateEffect: true }) {
  29. Row() {
  30. LoadingProgress().width(20).height(20).margin({ left: 12 }).color(0xFFFFFF)
  31. Text('loading').fontSize(12).fontColor(0xffffff).margin({ left: 5, right: 12 })
  32. }.alignItems(VerticalAlign.Center).width(90).height(40)
  33. }.backgroundColor(0x317aff)
  34. Button('Disable', { type: ButtonType.Capsule, stateEffect: false }).opacity(0.4)
  35. .backgroundColor(0x317aff).width(90)
  36. }
  37. Text('Circle button').fontSize(9).fontColor(0xCCCCCC)
  38. Flex({ alignItems: ItemAlign.Center, wrap: FlexWrap.Wrap }) {
  39. Button({ type: ButtonType.Circle, stateEffect: true }) {
  40. LoadingProgress().width(20).height(20).color(0xFFFFFF)
  41. }.width(55).height(55).backgroundColor(0x317aff)
  42. Button({ type: ButtonType.Circle, stateEffect: true }) {
  43. LoadingProgress().width(20).height(20).color(0xFFFFFF)
  44. }.width(55).height(55).margin({ left: 20 }).backgroundColor(0xF55A42)
  45. }
  46. }.height(400).padding({ left: 35, right: 35, top: 35 })
  47. }
  48. }

示例2

  1. // xxx.ets
  2. @Entry
  3. @Component
  4. struct SwipeGestureExample {
  5. @State count: number = 0
  6. build() {
  7. Column() {
  8. Text(`${this.count}`)
  9. .fontSize(30)
  10. .onClick(() => {
  11. this.count++
  12. })
  13. if (this.count <= 0) {
  14. Button('count is negative').fontSize(30).height(50)
  15. } else if (this.count % 2 === 0) {
  16. Button('count is even').fontSize(30).height(50)
  17. } else {
  18. Button('count is odd').fontSize(30).height(50)
  19. }
  20. }.height('100%').width('100%').justifyContent(FlexAlign.Center)
  21. }
  22. }

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号