Skip to content

常用 API 速查

UI 组件

基础组件

组件用途常用属性
Text文本fontSize fontColor fontWeight maxLines textOverflow
Image图片src width height objectFit alt
Button按钮type backgroundColor fontColor onClick
TextInput输入框placeholder text type onChange maxLength
LoadingProgress加载指示器width height color
Progress进度条type value total color
Toggle开关type isOn onChange
Slider滑块value min max onChange
Divider分割线color strokeWidth

布局容器

组件用途常用属性
Column垂直布局space justifyContent alignItems
Row水平布局space justifyContent alignItems
Stack层叠布局alignContent
Flex弹性布局direction wrap justifyContent
Grid网格布局columnsTemplate rowsTemplate
List列表space divider edgeEffect
ListItem列表项swipeAction
Scroll滚动容器scrollBar edgeEffect
Swiper轮播index autoPlay indicator
Tabs标签页barPosition index
TabContent标签内容tabBar
Navigation导航容器mode title navDestination

状态装饰器

装饰器作用版本
@State组件内状态API 9+
@Prop父→子单向API 9+
@Link父↔子双向API 9+
@Provide / @Consume跨层级共享API 9+
@Observed / @ObjectLink嵌套对象响应API 9+
@Local替代 @State(V2)API 12+
@Param替代 @Prop(V2)API 12+
@Event回调事件(V2)API 12+

系统能力 Kit

Kit导入主要能力
NetworkKitimport { http } from '@kit.NetworkKit'HTTP 请求、WebSocket
ArkDataimport { preferences, relationalStore } from '@kit.ArkData'键值存储、关系型数据库
AbilityKitimport { UIAbility, Want } from '@kit.AbilityKit'Ability、权限
ArkUIimport { promptAction, router } from '@kit.ArkUI'UI 组件、路由、弹窗
NotificationKitimport { notificationManager } from '@kit.NotificationKit'通知
MultimediaKitimport { camera, audio, media } from '@kit.MultimediaKit'相机、音频、视频
CoreFileKitimport { fileIo } from '@kit.CoreFileKit'文件 IO
LocationKitimport { geoLocationManager } from '@kit.LocationKit'定位
BasicServicesKitimport { deviceInfo } from '@kit.BasicServicesKit'设备信息
ArkTSimport { taskpool } from '@kit.ArkTS'并发任务

常用权限

json5
// module.json5
{
  "module": {
    "requestPermissions": [
      { "name": "ohos.permission.INTERNET" },
      { "name": "ohos.permission.LOCATION" },
      { "name": "ohos.permission.APPROXIMATELY_LOCATION" },
      { "name": "ohos.permission.CAMERA" },
      { "name": "ohos.permission.MICROPHONE" },
      { "name": "ohos.permission.READ_IMAGEVIDEO" },
      { "name": "ohos.permission.WRITE_IMAGEVIDEO" }
    ]
  }
}
权限说明动态申请
ohos.permission.INTERNET网络访问
ohos.permission.LOCATION精确定位
ohos.permission.APPROXIMATELY_LOCATION大概位置
ohos.permission.CAMERA相机
ohos.permission.MICROPHONE麦克风
ohos.permission.READ_IMAGEVIDEO读取图片视频
ohos.permission.WRITE_IMAGEVIDEO写入图片视频

弹窗与提示

typescript
import { promptAction } from '@kit.ArkUI'

// 轻提示
promptAction.showToast({ message: '保存成功', duration: 2000 })

// 确认对话框
AlertDialog.show({
  title: '提示',
  message: '确定删除吗?',
  primaryButton: { value: '取消', action: () => {} },
  secondaryButton: { value: '确定', action: () => { /* 删除 */ } }
})

// 操作列表
ActionSheet.show({
  title: '选择操作',
  message: '请选择一个选项',
  sheets: [
    { title: '拍照', action: () => {} },
    { title: '从相册选择', action: () => {} },
    { title: '取消', action: () => {} }
  ]
})

设备信息

typescript
import { deviceInfo } from '@kit.BasicServicesKit'

console.info('系统版本', deviceInfo.osFullName)
console.info('设备型号', deviceInfo.marketName)
console.info('设备品牌', deviceInfo.brand)
console.info('屏幕宽度', deviceInfo.screenWidth)
console.info('屏幕高度', deviceInfo.screenHeight)

颜色常量

typescript
// 系统颜色枚举
Color.Red
Color.Green
Color.Blue
Color.Black
Color.White
Color.Transparent
Color.Gray
Color.Grey

// 十六进制
'#FF0000'        // RGB
'#80FF0000'      // ARGB(带透明度)

字体粗细

typescript
FontWeight.Normal   // 400
FontWeight.Bold     // 700
FontWeight.Bolder   // 900
FontWeight.Lighter  // 100
FontWeight.Regular  // 400
FontWeight.Medium   // 500

对齐方式

typescript
// 主轴对齐(Column/Row)
FlexAlign.Start
FlexAlign.Center
FlexAlign.End
FlexAlign.SpaceBetween
FlexAlign.SpaceAround
FlexAlign.SpaceEvenly

// 交叉轴对齐(Column)
HorizontalAlign.Start
HorizontalAlign.Center
HorizontalAlign.End

// 交叉轴对齐(Row)
VerticalAlign.Top
VerticalAlign.Center
VerticalAlign.Bottom

// Stack 对齐
Alignment.TopStart
Alignment.Top
Alignment.TopEnd
Alignment.Start
Alignment.Center
Alignment.End
Alignment.BottomStart
Alignment.Bottom
Alignment.BottomEnd