文档管理中心

按钮 (Button)

Button是按钮组件,通常用于响应用户的点击操作,其类型包括胶囊按钮、圆形按钮、普通按钮、圆角矩形按钮。Button作为容器使用时可以通过添加子组件实现包含文字、图片等元素的按钮。具体用法请参考Button

创建按钮

Button通过调用接口来创建,接口调用有以下两种形式:

  • 通过label和ButtonOptions创建不包含子组件的按钮。以ButtonOptions中的type和stateEffect为例。

    收起
    自动换行
    深色代码主题
    复制
    1. Button(label?: ResourceStr, options?: { type?: ButtonType, stateEffect?: boolean })

    其中,label用来设置按钮文字,type用于设置Button类型,stateEffect属性设置Button是否开启点击效果。

    收起
    自动换行
    深色代码主题
    复制
    1. Button('Ok', { type: ButtonType.Normal, stateEffect: true })
    2. .borderRadius(8)
    3. .backgroundColor(0x317aff)
    4. .width(90)
    5. .height(40)

  • 通过ButtonOptions创建包含子组件的按钮。以ButtonOptions中的type和stateEffect为例。

    收起
    自动换行
    深色代码主题
    复制
    1. Button(options?: {type?: ButtonType, stateEffect?: boolean})

    只支持包含一个子组件,子组件可以是基础组件或者容器组件。

    收起
    自动换行
    深色代码主题
    复制
    1. Button({ type: ButtonType.Normal, stateEffect: true }) {
    2. Row() {
    3. // 请将$r('app.media.loading')替换为实际资源文件
    4. Image($r('app.media.loading')).width(20).height(40).margin({ left: 12 })
    5. Text('loading').fontSize(12).fontColor(0xffffff).margin({ left: 5, right: 12 })
    6. }.alignItems(VerticalAlign.Center)
    7. }.borderRadius(8).backgroundColor(0x317aff).width(90).height(40)

设置按钮类型

Button有四种可选类型,分别为胶囊类型(Capsule)、圆形按钮(Circle)、普通按钮(Normal)和圆角矩形按钮(ROUNDED_RECTANGLE),通过type进行设置。

  • 胶囊按钮(默认类型)。

    此类型按钮的圆角自动设置为高度的一半,不支持通过borderRadius属性重新设置圆角。

    收起
    自动换行
    深色代码主题
    复制
    1. Button('Disable', { type: ButtonType.Capsule, stateEffect: false })
    2. .backgroundColor(0x317aff)
    3. .width(90)
    4. .height(40)

  • 圆形按钮。

    此类型按钮为圆形,不支持通过borderRadius属性重新设置圆角。

    收起
    自动换行
    深色代码主题
    复制
    1. Button('Circle', { type: ButtonType.Circle, stateEffect: false })
    2. .backgroundColor(0x317aff)
    3. .width(90)
    4. .height(90)

  • 普通按钮。

    此类型的按钮默认圆角为0,支持通过borderRadius属性重新设置圆角。

    收起
    自动换行
    深色代码主题
    复制
    1. Button('Ok', { type: ButtonType.Normal, stateEffect: true })
    2. .borderRadius(8)
    3. .backgroundColor(0x317aff)
    4. .width(90)
    5. .height(40)

  • 圆角矩形按钮。

    controlSize为NORMAL时,默认圆角大小为20vp,controlSize为SMALL时,圆角大小为14vp,支持通过borderRadius属性重新设置圆角。

    收起
    自动换行
    深色代码主题
    复制
    1. Button('Disable', { type: ButtonType.ROUNDED_RECTANGLE, stateEffect: true })
    2. .backgroundColor(0x317aff)
    3. .width(90)
    4. .height(40)

自定义样式

  • 设置边框弧度。

    使用通用属性来自定义按钮样式。例如通过borderRadius属性设置按钮的边框弧度。

    收起
    自动换行
    深色代码主题
    复制
    1. Button('circle border', { type: ButtonType.Normal })
    2. .borderRadius(20)
    3. .height(40)

  • 设置文本样式。

    通过添加文本样式设置按钮文本的展示样式。

    收起
    自动换行
    深色代码主题
    复制
    1. Button('font style', { type: ButtonType.Normal })
    2. .fontSize(20)
    3. .fontColor(Color.Pink)
    4. .fontWeight(800)

  • 设置背景颜色。

    添加backgroundColor属性设置按钮的背景颜色。

    收起
    自动换行
    深色代码主题
    复制
    1. Button('background color').backgroundColor(0xF55A42)

  • 创建功能型按钮。

    创建删除操作的按钮。

    收起
    自动换行
    深色代码主题
    复制
    1. Button({ type: ButtonType.Circle, stateEffect: true }) {
    2. // 请将$r('app.media.ic_public_delete_filled')替换为实际资源文件
    3. Image($r('app.media.ic_public_delete_filled')).width(30).height(30)
    4. }.width(55).height(55).margin({ 'left': 20 }).backgroundColor(0xF55A42)

添加事件

Button组件通常用于触发某些操作,可以绑定onClick事件来响应点击操作后的自定义行为。

收起
自动换行
深色代码主题
复制
  1. Button('Ok', { type: ButtonType.Normal, stateEffect: true })
  2. .onClick(()=>{
  3. hilog.info(DOMAIN, 'testTag', 'Button onClick');
  4. }).margin(10)

场景示例

  • 用于启动操作。

    可以用按钮启动任何用户界面元素,按钮会根据用户的操作触发相应的事件。例如,在List容器里通过点击按钮进行页面跳转。

    收起
    自动换行
    深色代码主题
    复制
    1. import { hilog } from '@kit.PerformanceAnalysisKit';
    2. const DOMAIN = 0x0000;
    3. // xxx.ets
    4. @Entry
    5. @Component
    6. export struct ButtonCaseTouch {
    7. pathStack: NavPathStack = new NavPathStack();
    8. @Builder
    9. PageMap(name: string) {
    10. if (name === 'first_page') {
    11. pageOneTmp()
    12. } else if (name === 'second_page') {
    13. pageTwoTmp()
    14. } else if (name === 'third_page') {
    15. pageThreeTmp()
    16. }
    17. }
    18. build() {
    19. NavDestination() {
    20. Navigation(this.pathStack) {
    21. List({ space: 4 }) {
    22. ListItem() {
    23. Button('First').onClick(() => {
    24. this.pathStack.pushPath({ name: 'first_page' });
    25. })
    26. .width('100%')
    27. }
    28. ListItem() {
    29. Button('Second').onClick(() => {
    30. this.pathStack.pushPath({ name: 'second_page' });
    31. })
    32. .width('100%')
    33. }
    34. ListItem() {
    35. Button('Third').onClick(() => {
    36. this.pathStack.pushPath({ name: 'third_page' });
    37. })
    38. .width('100%')
    39. }
    40. }
    41. .listDirection(Axis.Vertical)
    42. .backgroundColor(0xDCDCDC).padding(20)
    43. }
    44. .mode(NavigationMode.Stack)
    45. .navDestination(this.PageMap)
    46. }
    47. }
    48. }
    49. // pageOne
    50. @Component
    51. export struct pageOneTmp {
    52. pathStack: NavPathStack = new NavPathStack();
    53. build() {
    54. NavDestination() {
    55. Column() {
    56. Text('first_page')
    57. }.width('100%').height('100%')
    58. }.title('pageOne')
    59. .onBackPressed(() => {
    60. const popDestinationInfo = this.pathStack.pop(); // 弹出路由栈栈顶元素
    61. // 请将$r('app.string.return_value')替换为实际资源文件,在本示例中该资源文件的value值为"返回值"
    62. hilog.info(DOMAIN, 'testTag', 'pop' + $r('app.string.return_value') + JSON.stringify(popDestinationInfo));
    63. return true;
    64. })
    65. .onReady((context: NavDestinationContext) => {
    66. this.pathStack = context.pathStack;
    67. })
    68. }
    69. }
    70. // pageTwo
    71. @Component
    72. export struct pageTwoTmp {
    73. pathStack: NavPathStack = new NavPathStack();
    74. build() {
    75. NavDestination() {
    76. Column() {
    77. Text('second_page')
    78. }.width('100%').height('100%')
    79. }.title('pageTwo')
    80. .onBackPressed(() => {
    81. const popDestinationInfo = this.pathStack.pop(); // 弹出路由栈栈顶元素
    82. // 请将$r('app.string.return_value')替换为实际资源文件,在本示例中该资源文件的value值为"返回值"
    83. hilog.info(DOMAIN, 'testTag', 'pop' + $r('app.string.return_value') + JSON.stringify(popDestinationInfo));
    84. return true;
    85. })
    86. .onReady((context: NavDestinationContext) => {
    87. this.pathStack = context.pathStack;
    88. })
    89. }
    90. }
    91. // pageThree
    92. @Component
    93. export struct pageThreeTmp {
    94. pathStack: NavPathStack = new NavPathStack();
    95. build() {
    96. NavDestination() {
    97. Column() {
    98. Text('third_page')
    99. }.width('100%').height('100%')
    100. }.title('pageThree')
    101. .onBackPressed(() => {
    102. const popDestinationInfo = this.pathStack.pop(); // 弹出路由栈栈顶元素
    103. // 请将$r('app.string.return_value')替换为实际资源文件,在本示例中该资源文件的value值为"返回值"
    104. hilog.info(DOMAIN, 'testTag', 'pop' + $r('app.string.return_value') + JSON.stringify(popDestinationInfo));
    105. return true;
    106. })
    107. .onReady((context: NavDestinationContext) => {
    108. this.pathStack = context.pathStack;
    109. })
    110. }
    111. }

  • 用于提交表单。

    在用户登录/注册页面,使用按钮进行登录或注册操作。

    收起
    自动换行
    深色代码主题
    复制
    1. // xxx.ets
    2. const DOMAIN = 0x0000;
    3. @Entry
    4. @Component
    5. export struct ButtonCaseLogin {
    6. build() {
    7. NavDestination() {
    8. Column() {
    9. TextInput({ placeholder: 'input your username' }).margin({ top: 20 })
    10. TextInput({ placeholder: 'input your password' }).type(InputType.Password).margin({ top: 20 })
    11. Button('Register').width(300).margin({ top: 20 })
    12. .onClick(() => {
    13. // 需要执行的操作
    14. })
    15. // ···
    16. }.padding(20)
    17. }
    18. }
    19. }

  • 悬浮按钮。

    在可以滑动的界面,滑动时按钮始终保持悬浮状态。

    收起
    自动换行
    深色代码主题
    复制
    1. // xxx.ets
    2. @Entry
    3. @Component
    4. export struct HoverButtonExample {
    5. private arr: number[] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
    6. build() {
    7. NavDestination() {
    8. Stack() {
    9. List({ space: 20, initialIndex: 0 }) {
    10. ForEach(this.arr, (item: number) => {
    11. ListItem() {
    12. Text('' + item)
    13. .width('100%')
    14. .height(100)
    15. .fontSize(16)
    16. .textAlign(TextAlign.Center)
    17. .borderRadius(10)
    18. .backgroundColor(0xFFFFFF)
    19. }
    20. }, (item: number) => item.toString())
    21. }.width('90%')
    22. Button() {
    23. // 请将$r('app.media.ic_public_add')替换为实际资源文件
    24. Image($r('app.media.ic_public_add'))
    25. .width(50)
    26. .height(50)
    27. }
    28. .width(60)
    29. .height(60)
    30. .position({ x: '80%', y: 600 })
    31. .shadow({ radius: 10 })
    32. .onClick(() => {
    33. // 需要执行的操作
    34. })
    35. }
    36. .width('100%')
    37. .height('100%')
    38. .backgroundColor(0xDCDCDC)
    39. .padding({ top: 5 })
    40. }
    41. }
    42. }

在 指南 中进行搜索
请输入您想要搜索的关键词