常用 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 | 导入 | 主要能力 |
|---|---|---|
| NetworkKit | import { http } from '@kit.NetworkKit' | HTTP 请求、WebSocket |
| ArkData | import { preferences, relationalStore } from '@kit.ArkData' | 键值存储、关系型数据库 |
| AbilityKit | import { UIAbility, Want } from '@kit.AbilityKit' | Ability、权限 |
| ArkUI | import { promptAction, router } from '@kit.ArkUI' | UI 组件、路由、弹窗 |
| NotificationKit | import { notificationManager } from '@kit.NotificationKit' | 通知 |
| MultimediaKit | import { camera, audio, media } from '@kit.MultimediaKit' | 相机、音频、视频 |
| CoreFileKit | import { fileIo } from '@kit.CoreFileKit' | 文件 IO |
| LocationKit | import { geoLocationManager } from '@kit.LocationKit' | 定位 |
| BasicServicesKit | import { deviceInfo } from '@kit.BasicServicesKit' | 设备信息 |
| ArkTS | import { 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