1.1K Star 6.2K Fork 5.1K

OpenHarmony / docs

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
ts-universal-attributes-border.md 13.87 KB
一键复制 编辑 原始数据 按行查看 历史
lwx1284140 提交于 2024-05-09 11:37 . add api12 0509

边框设置

设置组件边框样式。

说明:

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

border

border(value: BorderOptions)

设置边框样式。

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

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

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

参数:

参数名 类型 必填 说明
value BorderOptions 统一边框样式设置接口。
说明:
边框宽度默认值为0,即不显示边框。
从API Version 9开始,父节点的border显示在子节点内容之上。

borderStyle

borderStyle(value: BorderStyle | EdgeStyles)

设置元素的边框线条样式。

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

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

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

参数:

参数名 类型 必填 说明
value BorderStyle | EdgeStyles9+ 设置元素的边框样式。
默认值:BorderStyle.Solid

borderWidth

borderWidth(value: Length | EdgeWidths | LocalizedEdgeWidths)

设置边框的宽度。

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

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

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

参数:

参数名 类型 必填 说明
value Length | EdgeWidths9+ | LocalizedEdgeWidths12+ 设置元素的边框宽度,不支持百分比。

borderColor

borderColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors)

设置边框的颜色。

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

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

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

参数:

参数名 类型 必填 说明
value ResourceColor | EdgeColors9+ | LocalizedEdgeColors12+ 设置元素的边框颜色。
默认值:Color.Black

borderRadius

borderRadius(value: Length | BorderRadiuses | LocalizedBorderRadiuses)

设置边框的圆角。圆角大小受组件尺寸限制,最大值为组件宽或高的一半。

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

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

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

参数:

参数名 类型 必填 说明
value Length | BorderRadiuses9+ | LocalizedBorderRadiuses12+ 设置元素的边框圆角半径,不支持百分比。

BorderOptions对象说明

名称 参数类型 必填 描述
width Length | EdgeWidths9+ | LocalizedEdgeWidths12+ 设置边框宽度。
color ResourceColor | EdgeColors9+ | LocalizedEdgeColors12+ 设置边框颜色。
radius Length | BorderRadiuses9+ | LocalizedBorderRadiuses12+ 设置边框圆角半径。
style BorderStyle | EdgeStyles9+ 设置边框样式。

EdgeWidths9+对象说明

引入该对象时,至少传入一个参数。

名称 参数类型 必填 描述
left Length 左侧边框宽度。
right Length 右侧边框宽度。
top Length 上侧边框宽度。
bottom Length 下侧边框宽度。

LocalizedEdgeWidths12+对象说明

边框宽度类型,用于描述组件边框不同方向的宽度。 引入该对象时,至少传入一个参数。

名称 参数类型 必填 描述
start LocalizedEdgeWidths12+ 左侧边框宽度。
从右至左显示语言模式下为右侧边框宽度。
end LocalizedEdgeWidths12+ 右侧边框宽度。
从右至左显示语言模式下为左侧边框宽度。
top LocalizedEdgeWidths12+ 上侧边框宽度。
bottom LocalizedEdgeWidths12+ 下侧边框宽度。

EdgeColors9+对象说明

引入该对象时,至少传入一个参数。

名称 参数类型 必填 描述
left ResourceColor 左侧边框颜色。
right ResourceColor 右侧边框颜色。
top ResourceColor 上侧边框颜色。
bottom ResourceColor 下侧边框颜色。

LocalizedEdgeColors12+对象说明

边框颜色,用于描述组件边框四条边的颜色。 引入该对象时,至少传入一个参数。

名称 参数类型 必填 描述
start ResourceColor 左侧边框颜色。
从右至左显示语言模式下为右侧边框颜色。
end ResourceColor 右侧边框颜色。
从右至左显示语言模式下为左侧边框颜色。
top ResourceColor 上侧边框颜色。
bottom ResourceColor 下侧边框颜色。

BorderRadiuses9+对象说明

引用该对象时,至少传入一个参数。

名称 参数类型 必填 描述
topLeft Length 左上角圆角半径。
topRight Length 右上角圆角半径。
bottomLeft Length 左下角圆角半径。
bottomRight Length 右下角圆角半径。

LocalizedBorderRadiuses12+对象说明

圆角类型,用于描述组件边框圆角半径。 引用该对象时,至少传入一个参数。

名称 参数类型 必填 描述
topStart LengthMetrics12+ 左上角圆角半径。
从右至左显示语言模式下为右上角圆角半径。
topEnd LengthMetrics12+ 右上角圆角半径。
从右至左显示语言模式下为左上角圆角半径。
bottomStart LengthMetrics12+ 左下角圆角半径。
从右至左显示语言模式下为右下角圆角半径。
bottomEnd LengthMetrics12+ 右下角圆角半径。
从右至左显示语言模式下为左下角圆角半径。

EdgeStyles9+对象说明

引入该对象时,至少传入一个参数。

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

名称 参数类型 必填 描述
left BorderStyle 左侧边框样式。
right BorderStyle 右侧边框样式。
top BorderStyle 上侧边框样式。
bottom BorderStyle 下侧边框样式。

示例

示例1

// xxx.ets
@Entry
@Component
struct BorderExample {
  build() {
    Column() {
      Flex({ justifyContent: FlexAlign.SpaceAround, alignItems: ItemAlign.Center }) {
        // 线段
        Text('dashed')
          .borderStyle(BorderStyle.Dashed).borderWidth(5).borderColor(0xAFEEEE).borderRadius(10)
          .width(120).height(120).textAlign(TextAlign.Center).fontSize(16)
        // 点线
        Text('dotted')
          .border({ width: 5, color: 0x317AF7, radius: 10, style: BorderStyle.Dotted })
          .width(120).height(120).textAlign(TextAlign.Center).fontSize(16)
      }.width('100%').height(150)

      Text('.border')
        .fontSize(50)
        .width(300)
        .height(300)
        .border({
          width: { left: 3, right: 6, top: 10, bottom: 15 },
          color: { left: '#e3bbbb', right: Color.Blue, top: Color.Red, bottom: Color.Green },
          radius: { topLeft: 10, topRight: 20, bottomLeft: 40, bottomRight: 80 },
          style: {
            left: BorderStyle.Dotted,
            right: BorderStyle.Dotted,
            top: BorderStyle.Solid,
            bottom: BorderStyle.Dashed
          }
        }).textAlign(TextAlign.Center)
    }
  }
}

zh-cn_image_0000001219982705

示例2

// xxx.ets
// border属性的width、radius、color属性值使用LocalizedEdgeWidths类型和LocalizedEdgeColors类型

import { LengthMetrics } from '@ohos.arkui.node';
@Entry
@Component
struct BorderExample {
  build() {
    Column() {
      Flex({ justifyContent: FlexAlign.SpaceAround, alignItems: ItemAlign.Center }) {
        // 线段
        Text('dashed')
          .borderStyle(BorderStyle.Dashed)
          .borderWidth(5)
          .borderColor(0xAFEEEE)
          .borderRadius(10)
          .width(120)
          .height(120)
          .textAlign(TextAlign.Center)
          .fontSize(16)
        // 点线
        Text('dotted')
          .border({ width: 5, color: 0x317AF7, radius: 10, style: BorderStyle.Dotted })
          .width(120)
          .height(120)
          .textAlign(TextAlign.Center)
          .fontSize(16)
      }.width('100%').height(150)

      Text('.border')
        .fontSize(50)
        .width(300)
        .height(300)
        .border({
          width: {
            start: LengthMetrics.vp(3),
            end: LengthMetrics.vp(6),
            top: LengthMetrics.vp(10),
            bottom: LengthMetrics.vp(15)
          },
          color: { start: '#e3bbbb', end: Color.Blue, top: Color.Red, bottom: Color.Green },
          radius: {
            topStart: LengthMetrics.vp(10),
            topEnd: LengthMetrics.vp(20),
            bottomStart: LengthMetrics.vp(40),
            bottomEnd: LengthMetrics.vp(80)
          },
          style: {
            left: BorderStyle.Dotted,
            right: BorderStyle.Dotted,
            top: BorderStyle.Solid,
            bottom: BorderStyle.Dashed
          }
        })
        .textAlign(TextAlign.Center)
    }
  }
}

从左至右显示语言示例图

zh-cm_image_border_ltr

从右至左显示语言示例图

zh-cm_image_border_rtl

其他
1
https://gitee.com/openharmony/docs.git
git@gitee.com:openharmony/docs.git
openharmony
docs
docs
master

搜索帮助