@doubao-apps/ai 0.0.35-rc.0 → 0.0.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/dist/cli.js +1 -1
- package/dist/index.d.ts +4 -1
- package/dist/index.js +33 -1
- package/dist/{manifest.json → public/manifest.json} +7 -2
- package/dist/{skills → public/skills}/doubao-apps-dev/SKILL.md +11 -10
- package/dist/{skills → public/skills}/doubao-apps-dev/references/examples/common-patterns.md +2 -2
- package/dist/{skills/doubao-apps-dev/references/examples/component-basics.md → public/skills/doubao-apps-dev/references/examples/page-widget-basics.md} +1 -1
- package/dist/{skills/doubao-apps-dev/references/examples/component-recipes.md → public/skills/doubao-apps-dev/references/examples/page-widget-recipes.md} +2 -3
- package/dist/{skills → public/skills}/doubao-apps-dev/references/guides/component-development.md +2 -2
- package/dist/public/skills/doubao-apps-dev/references/reference/open-api/01-/345/237/272/347/241/200.md +270 -0
- package/dist/public/skills/doubao-apps-dev/references/reference/open-api/02-/347/263/273/347/273/237.md +438 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/03-/345/256/232/344/275/215.md +32 -55
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/04-/345/255/230/345/202/250.md +18 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/05-/350/267/257/347/224/261.md +8 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/06-/344/272/244/344/272/222.md +49 -3
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/07-/350/276/223/345/205/245.md +47 -0
- package/dist/public/skills/doubao-apps-dev/references/reference/open-api/08-/347/275/221/347/273/234.md +238 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/09-/345/252/222/344/275/223.md +81 -1
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/10-/344/270/232/345/212/241/350/203/275/345/212/233.md +143 -13
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/11-/347/231/273/345/275/225.md +11 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/14-/350/223/235/347/211/231.md +212 -1
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/15-wi-fi.md +104 -27
- package/dist/public/skills/doubao-apps-dev/references/reference/open-api/16-/345/212/240/351/200/237/345/272/246/350/256/241.md +122 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/17-ibeacon.md +38 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/18-/347/275/227/347/233/230.md +45 -22
- package/dist/public/skills/doubao-apps-dev/references/reference/open-api/19-/350/256/276/345/244/207/346/226/271/345/220/221.md +120 -0
- package/dist/public/skills/doubao-apps-dev/references/reference/open-api/20-/351/231/200/350/236/272/344/273/252.md +122 -0
- package/dist/public/skills/doubao-apps-dev/references/reference/open-api/21-/350/256/276/345/244/207-/347/275/221/347/273/234.md +153 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/23-/346/227/240/351/232/234/347/242/215.md +11 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/24-/345/237/272/347/241/200/344/277/241/346/201/257.md +19 -0
- package/dist/public/skills/doubao-apps-dev/references/reference/open-api/25-/347/224/265/346/261/240.md +92 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/26-/346/227/245/345/216/206.md +11 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/27-/345/211/252/350/264/264/346/235/277.md +11 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/28-/350/201/224/347/263/273/344/272/272.md +13 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/29-/345/212/240/345/257/206.md +11 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/31-/346/211/253/347/240/201.md +51 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/32-/345/261/217/345/271/225.md +60 -20
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/33-/351/234/207/345/212/250.md +11 -0
- package/dist/public/skills/doubao-apps-dev/references/reference/open-api/34-/346/226/207/344/273/266/347/263/273/347/273/237.md +334 -0
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/README.md +4 -4
- package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api.md +14 -12
- package/dist/public/skills/doubao-components-api/SKILL.md +50 -0
- package/dist/public/skills/doubao-components-api/references/reference/form.md +146 -0
- package/dist/public/skills/doubao-components-api/references/reference/interactive.md +120 -0
- package/dist/public/skills/doubao-components-api/references/reference/layout-overlay.md +131 -0
- package/dist/public/skills/doubao-components-api/references/reference/layout-scroll.md +149 -0
- package/dist/public/skills/doubao-components-api/references/reference/map-canvas.md +107 -0
- package/dist/public/skills/doubao-components-api/references/reference/media.md +195 -0
- package/dist/{skills → public/skills}/douyin-to-doubao/SKILL.md +1 -1
- package/dist/{skills → public/skills}/h5-to-doubao/SKILL.md +2 -2
- package/dist/{skills → public/skills}/quality-gate/scripts/collect-doubao-page-data.js +3 -3
- package/dist/{skills → public/skills}/uniapp-to-doubao/SKILL.md +1 -1
- package/dist/{skills → public/skills}/weixin-to-doubao/SKILL.md +1 -1
- package/package.json +5 -5
- package/dist/733.js +0 -33
- package/dist/skills/doubao-apps-dev/references/reference/components-quick-ref.md +0 -114
- package/dist/skills/doubao-apps-dev/references/reference/open-api/01-/345/237/272/347/241/200.md +0 -136
- package/dist/skills/doubao-apps-dev/references/reference/open-api/02-/347/263/273/347/273/237.md +0 -257
- package/dist/skills/doubao-apps-dev/references/reference/open-api/08-/347/275/221/347/273/234.md +0 -124
- package/dist/skills/doubao-apps-dev/references/reference/open-api/16-/345/212/240/351/200/237/345/272/246/350/256/241.md +0 -87
- package/dist/skills/doubao-apps-dev/references/reference/open-api/19-/350/256/276/345/244/207/346/226/271/345/220/221.md +0 -86
- package/dist/skills/doubao-apps-dev/references/reference/open-api/20-/351/231/200/350/236/272/344/273/252.md +0 -87
- package/dist/skills/doubao-apps-dev/references/reference/open-api/21-/350/256/276/345/244/207-/347/275/221/347/273/234.md +0 -102
- package/dist/skills/doubao-apps-dev/references/reference/open-api/25-/347/224/265/346/261/240.md +0 -63
- package/dist/skills/doubao-apps-dev/references/reference/open-api/34-/346/226/207/344/273/266/347/263/273/347/273/237.md +0 -73
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/examples/open-api-recipes.md +0 -0
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/guides/best-practices.md +0 -0
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/guides/expired-widget.md +0 -0
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/guides/mcp-ui.md +0 -0
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/guides/performance-optimization.md +0 -0
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/guides/troubleshooting.md +0 -0
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/framework-api-quick-ref.md +0 -0
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/12-/346/224/257/344/273/230.md" +0 -0
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/13-/346/225/260/346/215/256/345/210/206/346/236/220.md" +0 -0
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/22-/347/237/255/344/277/241.md" +0 -0
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/30-/347/224/265/350/257/235.md" +0 -0
- /package/dist/{skills → public/skills}/doubao-apps-dev/references/rules/dos-and-donts.md +0 -0
- /package/dist/{skills → public/skills}/douyin-to-doubao/assets/migration-checklist-template.md +0 -0
- /package/dist/{skills → public/skills}/douyin-to-doubao/references/mapping/component-mapping.md +0 -0
- /package/dist/{skills → public/skills}/douyin-to-doubao/references/mapping/core-api-mapping.md +0 -0
- /package/dist/{skills → public/skills}/douyin-to-doubao/references/mapping/event-mapping.md +0 -0
- /package/dist/{skills → public/skills}/douyin-to-doubao/references/mapping/lifecycle-mapping.md +0 -0
- /package/dist/{skills → public/skills}/douyin-to-doubao/references/mapping/style-mapping.md +0 -0
- /package/dist/{skills → public/skills}/douyin-to-doubao/references/source-framework/api-reference.md +0 -0
- /package/dist/{skills → public/skills}/douyin-to-doubao/references/source-framework/components.md +0 -0
- /package/dist/{skills → public/skills}/h5-to-doubao/references/common/troubleshooting.md +0 -0
- /package/dist/{skills → public/skills}/h5-to-doubao/references/source-framework/react-to-doubao.md +0 -0
- /package/dist/{skills → public/skills}/h5-to-doubao/references/source-framework/vue-to-doubao.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/SKILL.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/gates/bronze.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/gates/gold-phase1.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/gates/gold-phase2.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/gates/gold-phase3.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/gates/silver.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/runtime-fix.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/screenshots/doubao-faq.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/screenshots/doubao.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/screenshots/h5-react.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/screenshots/weixin.md +0 -0
- /package/dist/{skills → public/skills}/quality-gate/scripts/phase2-normalized-compare.py +0 -0
- /package/dist/{skills → public/skills}/quality-gate/scripts/run-doubao-screenshots.sh +0 -0
- /package/dist/{skills → public/skills}/uniapp-to-doubao/assets/migration-checklist-template.md +0 -0
- /package/dist/{skills → public/skills}/uniapp-to-doubao/references/mapping/component-mapping.md +0 -0
- /package/dist/{skills → public/skills}/uniapp-to-doubao/references/mapping/core-api-mapping.md +0 -0
- /package/dist/{skills → public/skills}/uniapp-to-doubao/references/mapping/event-mapping.md +0 -0
- /package/dist/{skills → public/skills}/uniapp-to-doubao/references/mapping/lifecycle-mapping.md +0 -0
- /package/dist/{skills → public/skills}/uniapp-to-doubao/references/mapping/style-mapping.md +0 -0
- /package/dist/{skills → public/skills}/uniapp-to-doubao/references/source-framework/api-reference.md +0 -0
- /package/dist/{skills → public/skills}/uniapp-to-doubao/references/source-framework/components.md +0 -0
- /package/dist/{skills → public/skills}/weixin-to-doubao/assets/migration-checklist-template.md +0 -0
- /package/dist/{skills → public/skills}/weixin-to-doubao/references/mapping/component-mapping.md +0 -0
- /package/dist/{skills → public/skills}/weixin-to-doubao/references/mapping/core-api-mapping.md +0 -0
- /package/dist/{skills → public/skills}/weixin-to-doubao/references/mapping/event-mapping.md +0 -0
- /package/dist/{skills → public/skills}/weixin-to-doubao/references/mapping/lifecycle-mapping.md +0 -0
- /package/dist/{skills → public/skills}/weixin-to-doubao/references/mapping/style-mapping.md +0 -0
- /package/dist/{skills → public/skills}/weixin-to-doubao/references/source-framework/api-reference.md +0 -0
- /package/dist/{skills → public/skills}/weixin-to-doubao/references/source-framework/components.md +0 -0
|
@@ -8,33 +8,14 @@
|
|
|
8
8
|
|
|
9
9
|
| API | 说明 |
|
|
10
10
|
| --- | --- |
|
|
11
|
-
| [UserCaptureScreenListener](#usercapturescreenlistener) | 用户主动截屏事件监听函数。<br><br>返回 void,不是 Promise。 |
|
|
12
11
|
| [getScreenBrightness](#getscreenbrightness) | 获取屏幕亮度。 |
|
|
13
12
|
| [setVisualEffectOnCapture](#setvisualeffectoncapture) | 设置截屏或录屏时的视觉表现。 |
|
|
14
13
|
| [setScreenBrightness](#setscreenbrightness) | 设置屏幕亮度。 |
|
|
15
14
|
| [setKeepScreenOn](#setkeepscreenon) | 设置屏幕常亮状态。 |
|
|
15
|
+
| [onUserCaptureScreen](#onusercapturescreen) | 监听用户主动截屏事件。 |
|
|
16
16
|
|
|
17
17
|
## API 详情
|
|
18
18
|
|
|
19
|
-
<a id="usercapturescreenlistener"></a>
|
|
20
|
-
### UserCaptureScreenListener()
|
|
21
|
-
|
|
22
|
-
用户主动截屏事件监听函数。
|
|
23
|
-
|
|
24
|
-
## 代码示例
|
|
25
|
-
|
|
26
|
-
```typescript
|
|
27
|
-
// 暂无代码示例
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
## 入参
|
|
31
|
-
|
|
32
|
-
无入参。
|
|
33
|
-
|
|
34
|
-
## 返回值
|
|
35
|
-
|
|
36
|
-
返回 `void`。
|
|
37
|
-
|
|
38
19
|
<a id="getscreenbrightness"></a>
|
|
39
20
|
### getScreenBrightness()
|
|
40
21
|
|
|
@@ -75,6 +56,10 @@ import { setVisualEffectOnCapture } from '@doubao-apps/framework/api';
|
|
|
75
56
|
await setVisualEffectOnCapture({ visualEffect: 'hidden' });
|
|
76
57
|
```
|
|
77
58
|
|
|
59
|
+
## 注意事项
|
|
60
|
+
|
|
61
|
+
控制截屏或录屏时的视觉效果。
|
|
62
|
+
|
|
78
63
|
## 入参
|
|
79
64
|
|
|
80
65
|
|参数名|类型|必填|说明|
|
|
@@ -134,3 +119,58 @@ await setKeepScreenOn({ keepScreenOn: true });
|
|
|
134
119
|
## 返回值
|
|
135
120
|
|
|
136
121
|
返回 `Promise<object>`。
|
|
122
|
+
|
|
123
|
+
<a id="onusercapturescreen"></a>
|
|
124
|
+
### onUserCaptureScreen()
|
|
125
|
+
|
|
126
|
+
监听用户主动截屏事件。
|
|
127
|
+
|
|
128
|
+
## 代码示例
|
|
129
|
+
|
|
130
|
+
```ts
|
|
131
|
+
import { onUserCaptureScreen } from '@doubao-apps/framework/api';
|
|
132
|
+
|
|
133
|
+
const off = onUserCaptureScreen(() => {
|
|
134
|
+
console.log('用户截屏了');
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
off();
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## 入参
|
|
141
|
+
|
|
142
|
+
|参数名|类型|必填|说明|
|
|
143
|
+
|---|---|---|---|
|
|
144
|
+
|handler|`Function`|是|-|
|
|
145
|
+
|handler.event|`UserCaptureScreenEvent`|是|-|
|
|
146
|
+
|
|
147
|
+
## 返回值
|
|
148
|
+
|
|
149
|
+
返回取消当前监听函数的函数。
|
|
150
|
+
|
|
151
|
+
## 相关类型
|
|
152
|
+
|
|
153
|
+
<a id="getscreenbrightnessresult"></a>
|
|
154
|
+
### GetScreenBrightnessResult
|
|
155
|
+
|
|
156
|
+
#### Properties
|
|
157
|
+
|
|
158
|
+
• **value**: `number` - 屏幕亮度值,范围 0 ~ 1,0 最暗,1 最亮
|
|
159
|
+
|
|
160
|
+
<a id="capturevisualeffect"></a>
|
|
161
|
+
### CaptureVisualEffect
|
|
162
|
+
|
|
163
|
+
录屏或截屏时的视觉表现。
|
|
164
|
+
|
|
165
|
+
#### Type
|
|
166
|
+
|
|
167
|
+
`'none' | 'hidden'`
|
|
168
|
+
|
|
169
|
+
<a id="usercapturescreenevent"></a>
|
|
170
|
+
### UserCaptureScreenEvent
|
|
171
|
+
|
|
172
|
+
用户主动截屏事件。
|
|
173
|
+
|
|
174
|
+
#### Properties
|
|
175
|
+
|
|
176
|
+
无字段。
|
|
@@ -0,0 +1,334 @@
|
|
|
1
|
+
# Open API: 文件系统
|
|
2
|
+
|
|
3
|
+
文件读写、目录管理和文件信息操作。
|
|
4
|
+
|
|
5
|
+
[返回目录](./README.md) | [返回速查](../open-api.md)
|
|
6
|
+
|
|
7
|
+
## 速查
|
|
8
|
+
|
|
9
|
+
| API | 说明 |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| [getFileSystemManager](#getfilesystemmanager) | 获取文件系统管理器。 |
|
|
12
|
+
|
|
13
|
+
## API 详情
|
|
14
|
+
|
|
15
|
+
<a id="getfilesystemmanager"></a>
|
|
16
|
+
### getFileSystemManager()
|
|
17
|
+
|
|
18
|
+
获取文件系统管理器。
|
|
19
|
+
|
|
20
|
+
## 代码示例
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { getFileSystemManager } from '@doubao-apps/framework/api';
|
|
24
|
+
|
|
25
|
+
const fs = getFileSystemManager();
|
|
26
|
+
const { data } = await fs.readFile({
|
|
27
|
+
filePath: '/tmp/profile.json',
|
|
28
|
+
encoding: 'utf-8'
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
console.log(data);
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## 入参
|
|
35
|
+
|
|
36
|
+
无入参。
|
|
37
|
+
|
|
38
|
+
## 返回值
|
|
39
|
+
|
|
40
|
+
返回 `FileSystemManager`。
|
|
41
|
+
|
|
42
|
+
|字段名|类型|说明|
|
|
43
|
+
|---|---|---|
|
|
44
|
+
|access|`(params: AccessParams) => Promise<void>`|-|
|
|
45
|
+
|accessSync|`(params: AccessParams) => void`|-|
|
|
46
|
+
|appendFile|`(params: AppendFileParams) => Promise<void>`|-|
|
|
47
|
+
|appendFileSync|`(params: AppendFileParams) => void`|-|
|
|
48
|
+
|copyFile|`(params: CopyFileParams) => Promise<void>`|-|
|
|
49
|
+
|copyFileSync|`(params: CopyFileParams) => void`|-|
|
|
50
|
+
|getFileInfo|`(params: GetFileInfoParams) => Promise<GetFileInfoResult>`|-|
|
|
51
|
+
|getSavedFileList|`() => Promise<GetSavedFileListResult>`|-|
|
|
52
|
+
|mkdir|`(params: MkdirParams) => Promise<void>`|-|
|
|
53
|
+
|mkdirSync|`(params: MkdirParams) => void`|-|
|
|
54
|
+
|readdir|`(params: ReaddirParams) => Promise<ReaddirResult>`|-|
|
|
55
|
+
|readdirSync|`(params: ReaddirParams) => ReaddirResult`|-|
|
|
56
|
+
|readFile|`(params: ReadFileParams) => Promise<ReadFileResult>`|-|
|
|
57
|
+
|readFileSync|`(params: ReadFileParams) => ReadFileResult`|-|
|
|
58
|
+
|removeSavedFile|`(params: RemoveSavedFileParams) => Promise<void>`|-|
|
|
59
|
+
|rename|`(params: RenameParams) => Promise<void>`|-|
|
|
60
|
+
|renameSync|`(params: RenameParams) => void`|-|
|
|
61
|
+
|rmdir|`(params: RmdirParams) => Promise<void>`|-|
|
|
62
|
+
|rmdirSync|`(params: RmdirParams) => void`|-|
|
|
63
|
+
|saveFile|`(params: SaveFileParams) => Promise<SaveFileResult>`|-|
|
|
64
|
+
|saveFileSync|`(params: SaveFileParams) => SaveFileResult`|-|
|
|
65
|
+
|stat|`(params: StatParams) => Promise<StatResult>`|-|
|
|
66
|
+
|statSync|`(params: StatParams) => StatResult`|-|
|
|
67
|
+
|truncate|`(params: TruncateParams) => Promise<void>`|-|
|
|
68
|
+
|truncateSync|`(params: TruncateParams) => void`|-|
|
|
69
|
+
|unlink|`(params: UnlinkParams) => Promise<void>`|-|
|
|
70
|
+
|unlinkSync|`(params: UnlinkParams) => void`|-|
|
|
71
|
+
|unzip|`(params: UnzipParams) => Promise<void>`|-|
|
|
72
|
+
|writeFile|`(params: WriteFileParams) => Promise<void>`|-|
|
|
73
|
+
|writeFileSync|`(params: WriteFileParams) => void`|-|
|
|
74
|
+
|
|
75
|
+
## 相关类型
|
|
76
|
+
|
|
77
|
+
<a id="readfileparams"></a>
|
|
78
|
+
### ReadFileParams
|
|
79
|
+
|
|
80
|
+
FileSystemManager.readFile 的参数。
|
|
81
|
+
|
|
82
|
+
#### Properties
|
|
83
|
+
|
|
84
|
+
• **filePath**: `string` - 要读取的文件路径(本地路径)
|
|
85
|
+
• **encoding?**: `'utf-8' | 'base64'` - 指定读取文件的字符编码。 - 'utf-8':以 UTF-8 字符串形式返回文件内容。 - 'base64':以 Base64 编码字符串形式返回文件内容,适用于二进制文件
|
|
86
|
+
|
|
87
|
+
<a id="readfileresult"></a>
|
|
88
|
+
### ReadFileResult
|
|
89
|
+
|
|
90
|
+
FileSystemManager.readFile 的返回结果。
|
|
91
|
+
|
|
92
|
+
#### Properties
|
|
93
|
+
|
|
94
|
+
• **data**: `string` - 文件内容。 具体格式由 ReadFileParams.encoding 决定: - 编码为 'utf-8' 时返回 UTF-8 字符串; - 编码为 'base64' 时返回 Base64 编码后的字符串
|
|
95
|
+
|
|
96
|
+
<a id="writefileparams"></a>
|
|
97
|
+
### WriteFileParams
|
|
98
|
+
|
|
99
|
+
FileSystemManager.writeFile 的参数。
|
|
100
|
+
|
|
101
|
+
#### Properties
|
|
102
|
+
|
|
103
|
+
• **filePath**: `string` - 要写入的文件路径(本地路径)
|
|
104
|
+
• **data**: `string` - 要写入的内容。 - 当 encoding 为 'utf-8' 时,直接写入该字符串; - 当 encoding 为 'base64' 时,将该字符串先进行 Base64 解码再写入文件
|
|
105
|
+
• **encoding?**: `'utf-8' | 'base64'` - 指定写入文件的字符编码
|
|
106
|
+
|
|
107
|
+
<a id="appendfileparams"></a>
|
|
108
|
+
### AppendFileParams
|
|
109
|
+
|
|
110
|
+
FileSystemManager.appendFile 的参数。
|
|
111
|
+
|
|
112
|
+
#### Properties
|
|
113
|
+
|
|
114
|
+
• **filePath**: `string` - 要追加内容的文件路径(本地路径)
|
|
115
|
+
• **data**: `string` - 要追加的内容。 - 当 encoding 为 'utf-8' 时,直接追加该字符串; - 当 encoding 为 'base64' 时,将该字符串先进行 Base64 解码再追加到文件末尾
|
|
116
|
+
• **encoding?**: `'utf-8' | 'base64'` - 指定写入文件的字符编码
|
|
117
|
+
|
|
118
|
+
<a id="accessparams"></a>
|
|
119
|
+
### AccessParams
|
|
120
|
+
|
|
121
|
+
FileSystemManager.access 的参数。
|
|
122
|
+
|
|
123
|
+
#### Properties
|
|
124
|
+
|
|
125
|
+
• **path**: `string` - 要判断是否存在的文件或目录路径
|
|
126
|
+
|
|
127
|
+
<a id="mkdirparams"></a>
|
|
128
|
+
### MkdirParams
|
|
129
|
+
|
|
130
|
+
FileSystemManager.mkdir 的参数。
|
|
131
|
+
|
|
132
|
+
#### Properties
|
|
133
|
+
|
|
134
|
+
• **dirPath**: `string` - 要创建的目录路径
|
|
135
|
+
• **recursive?**: `boolean` - 是否递归创建该目录的上级目录。 设为 true 时,即使中间路径不存在也会一并创建(类似 mkdir -p)
|
|
136
|
+
|
|
137
|
+
<a id="rmdirparams"></a>
|
|
138
|
+
### RmdirParams
|
|
139
|
+
|
|
140
|
+
FileSystemManager.rmdir 的参数。
|
|
141
|
+
|
|
142
|
+
#### Properties
|
|
143
|
+
|
|
144
|
+
• **dirPath**: `string` - 要删除的目录路径
|
|
145
|
+
• **recursive?**: `boolean` - 是否递归删除目录下的所有子文件和子目录。 设为 false 时,仅当目录为空才能删除成功;设为 true 时会递归删除所有内容
|
|
146
|
+
|
|
147
|
+
<a id="readdirparams"></a>
|
|
148
|
+
### ReaddirParams
|
|
149
|
+
|
|
150
|
+
FileSystemManager.readdir 的参数。
|
|
151
|
+
|
|
152
|
+
#### Properties
|
|
153
|
+
|
|
154
|
+
• **dirPath**: `string` - 要读取的目录路径
|
|
155
|
+
|
|
156
|
+
<a id="readdirresult"></a>
|
|
157
|
+
### ReaddirResult
|
|
158
|
+
|
|
159
|
+
FileSystemManager.readdir 的返回结果。
|
|
160
|
+
|
|
161
|
+
#### Properties
|
|
162
|
+
|
|
163
|
+
• **files**: `string[]` - 目录下的文件和子目录名称列表(不含 . 和 ..)
|
|
164
|
+
|
|
165
|
+
<a id="unlinkparams"></a>
|
|
166
|
+
### UnlinkParams
|
|
167
|
+
|
|
168
|
+
FileSystemManager.unlink 的参数。
|
|
169
|
+
|
|
170
|
+
#### Properties
|
|
171
|
+
|
|
172
|
+
• **filePath**: `string` - 要删除的文件路径。 该接口只能删除文件,不能删除目录;删除目录应使用 FileSystemManager.rmdir
|
|
173
|
+
|
|
174
|
+
<a id="statparams"></a>
|
|
175
|
+
### StatParams
|
|
176
|
+
|
|
177
|
+
FileSystemManager.stat 的参数。
|
|
178
|
+
|
|
179
|
+
#### Properties
|
|
180
|
+
|
|
181
|
+
• **path**: `string` - 要获取状态信息的文件或目录路径
|
|
182
|
+
|
|
183
|
+
<a id="statresult"></a>
|
|
184
|
+
### StatResult
|
|
185
|
+
|
|
186
|
+
FileSystemManager.stat 的返回结果。
|
|
187
|
+
|
|
188
|
+
#### Properties
|
|
189
|
+
|
|
190
|
+
• **size**: `number` - 文件大小,单位为字节(Byte)
|
|
191
|
+
• **lastModifiedTime**: `number` - 文件最近一次被修改的时间戳,单位为毫秒
|
|
192
|
+
• **isDirectory**: `boolean` - 判断当前路径是否是一个目录
|
|
193
|
+
|
|
194
|
+
<a id="copyfileparams"></a>
|
|
195
|
+
### CopyFileParams
|
|
196
|
+
|
|
197
|
+
FileSystemManager.copyFile 的参数。
|
|
198
|
+
|
|
199
|
+
#### Properties
|
|
200
|
+
|
|
201
|
+
• **srcPath**: `string` - 源文件路径(被复制的文件)
|
|
202
|
+
• **destPath**: `string` - 目标文件路径(复制后生成的文件)
|
|
203
|
+
|
|
204
|
+
<a id="renameparams"></a>
|
|
205
|
+
### RenameParams
|
|
206
|
+
|
|
207
|
+
FileSystemManager.rename 的参数。
|
|
208
|
+
|
|
209
|
+
#### Properties
|
|
210
|
+
|
|
211
|
+
• **oldPath**: `string` - 源文件路径(即当前文件路径)
|
|
212
|
+
• **newPath**: `string` - 新文件路径(即重命名或移动后的目标路径)
|
|
213
|
+
|
|
214
|
+
<a id="truncateparams"></a>
|
|
215
|
+
### TruncateParams
|
|
216
|
+
|
|
217
|
+
FileSystemManager.truncate 的参数。
|
|
218
|
+
|
|
219
|
+
#### Properties
|
|
220
|
+
|
|
221
|
+
• **filePath**: `string` - 要截断的文件路径
|
|
222
|
+
• **length?**: `number` - 截断后的文件字节长度。 - 若 length 小于文件原始长度,文件将被截取到指定长度,多余部分丢弃。 - 若 length 大于文件原始长度,文件将被扩展到指定长度,扩展部分用 \0 填充
|
|
223
|
+
|
|
224
|
+
<a id="getfileinfoparams"></a>
|
|
225
|
+
### GetFileInfoParams
|
|
226
|
+
|
|
227
|
+
FileSystemManager.getFileInfo 的参数。
|
|
228
|
+
|
|
229
|
+
#### Properties
|
|
230
|
+
|
|
231
|
+
• **filePath**: `string` - 要获取信息的文件路径
|
|
232
|
+
• **digestAlgorithm?**: `'md5' | 'sha1'` - 用于计算文件摘要的哈希算法。 - 'md5':使用 MD5 算法计算文件摘要。 - 'sha1':使用 SHA-1 算法计算文件摘要。 不传时不计算摘要,返回结果中 GetFileInfoResult.digest 为 undefined
|
|
233
|
+
|
|
234
|
+
<a id="getfileinforesult"></a>
|
|
235
|
+
### GetFileInfoResult
|
|
236
|
+
|
|
237
|
+
FileSystemManager.getFileInfo 的返回结果。
|
|
238
|
+
|
|
239
|
+
#### Properties
|
|
240
|
+
|
|
241
|
+
• **size**: `number` - 文件大小,单位为字节(Byte)
|
|
242
|
+
• **digest?**: `string` - 按照 GetFileInfoParams.digestAlgorithm 计算得到的文件摘要(十六进制字符串)。 仅当请求时指定了 digestAlgorithm 才会返回
|
|
243
|
+
|
|
244
|
+
<a id="savefileparams"></a>
|
|
245
|
+
### SaveFileParams
|
|
246
|
+
|
|
247
|
+
FileSystemManager.saveFile 的参数。
|
|
248
|
+
|
|
249
|
+
#### Properties
|
|
250
|
+
|
|
251
|
+
• **tempFilePath**: `string` - 临时文件路径(需先通过下载或其他方式获得的临时文件路径)
|
|
252
|
+
• **filePath?**: `string` - 保存到的目标文件路径。 若不指定,则由宿主决定存储位置并通过 SaveFileResult.savedFilePath 返回
|
|
253
|
+
|
|
254
|
+
<a id="savefileresult"></a>
|
|
255
|
+
### SaveFileResult
|
|
256
|
+
|
|
257
|
+
FileSystemManager.saveFile 的返回结果。
|
|
258
|
+
|
|
259
|
+
#### Properties
|
|
260
|
+
|
|
261
|
+
• **savedFilePath**: `string` - 文件保存后的实际存储路径
|
|
262
|
+
|
|
263
|
+
<a id="getsavedfilelistresult"></a>
|
|
264
|
+
### GetSavedFileListResult
|
|
265
|
+
|
|
266
|
+
FileSystemManager.getSavedFileList 的返回结果。
|
|
267
|
+
|
|
268
|
+
#### Properties
|
|
269
|
+
|
|
270
|
+
• **fileList**: `Array<{
|
|
271
|
+
/** 文件的本地路径。 */
|
|
272
|
+
filePath: string;
|
|
273
|
+
/** 文件大小,单位为字节(Byte)。 */
|
|
274
|
+
size: number;
|
|
275
|
+
/** 文件保存时的时间戳,单位为毫秒。 */
|
|
276
|
+
createTime: number;
|
|
277
|
+
}>` - 已保存的本地文件列表,每项包含文件路径、大小和创建时间
|
|
278
|
+
|
|
279
|
+
<a id="removesavedfileparams"></a>
|
|
280
|
+
### RemoveSavedFileParams
|
|
281
|
+
|
|
282
|
+
FileSystemManager.removeSavedFile 的参数。
|
|
283
|
+
|
|
284
|
+
#### Properties
|
|
285
|
+
|
|
286
|
+
• **filePath**: `string` - 需要删除的已保存文件路径(应为 SaveFileResult.savedFilePath 返回的路径)
|
|
287
|
+
|
|
288
|
+
<a id="unzipparams"></a>
|
|
289
|
+
### UnzipParams
|
|
290
|
+
|
|
291
|
+
FileSystemManager.unzip 的参数。
|
|
292
|
+
|
|
293
|
+
#### Properties
|
|
294
|
+
|
|
295
|
+
• **zipFilePath**: `string` - 要解压的 zip 文件路径
|
|
296
|
+
• **targetPath**: `string` - 解压后的目标目录路径。 目标目录须已存在,否则解压会失败
|
|
297
|
+
|
|
298
|
+
<a id="filesystemmanager"></a>
|
|
299
|
+
### FileSystemManager
|
|
300
|
+
|
|
301
|
+
文件系统管理器,提供对本地文件系统的完整读写能力。 通过 getFileSystemManager 获取实例后,可使用该接口上的方法执行文件和目录操作。 大多数方法同时提供异步(返回 Promise)和同步(Sync 后缀)两种调用方式。
|
|
302
|
+
|
|
303
|
+
#### Properties
|
|
304
|
+
|
|
305
|
+
• **readFile**: `(params: ReadFileParams) => Promise<ReadFileResult>` - 读取文件内容(异步)
|
|
306
|
+
• **readFileSync**: `(params: ReadFileParams) => ReadFileResult` - 读取文件内容(同步)
|
|
307
|
+
• **writeFile**: `(params: WriteFileParams) => Promise<void>` - 写入文件内容(异步)。如果文件不存在则创建,已存在则覆盖
|
|
308
|
+
• **writeFileSync**: `(params: WriteFileParams) => void` - 写入文件内容(同步)。如果文件不存在则创建,已存在则覆盖
|
|
309
|
+
• **appendFile**: `(params: AppendFileParams) => Promise<void>` - 在文件末尾追加内容(异步)。如果文件不存在则创建
|
|
310
|
+
• **appendFileSync**: `(params: AppendFileParams) => void` - 在文件末尾追加内容(同步)。如果文件不存在则创建
|
|
311
|
+
• **access**: `(params: AccessParams) => Promise<void>` - 判断文件或目录是否存在(异步)。 路径存在时 Promise resolve;路径不存在时 Promise reject
|
|
312
|
+
• **accessSync**: `(params: AccessParams) => void` - 判断文件或目录是否存在(同步)。 路径不存在时会抛出异常
|
|
313
|
+
• **mkdir**: `(params: MkdirParams) => Promise<void>` - 创建目录(异步)
|
|
314
|
+
• **mkdirSync**: `(params: MkdirParams) => void` - 创建目录(同步)
|
|
315
|
+
• **rmdir**: `(params: RmdirParams) => Promise<void>` - 删除目录(异步)
|
|
316
|
+
• **rmdirSync**: `(params: RmdirParams) => void` - 删除目录(同步)
|
|
317
|
+
• **readdir**: `(params: ReaddirParams) => Promise<ReaddirResult>` - 读取目录下的文件和子目录列表(异步)
|
|
318
|
+
• **readdirSync**: `(params: ReaddirParams) => ReaddirResult` - 读取目录下的文件和子目录列表(同步)
|
|
319
|
+
• **unlink**: `(params: UnlinkParams) => Promise<void>` - 删除文件(异步)。不能用于删除目录
|
|
320
|
+
• **unlinkSync**: `(params: UnlinkParams) => void` - 删除文件(同步)。不能用于删除目录
|
|
321
|
+
• **stat**: `(params: StatParams) => Promise<StatResult>` - 获取文件或目录的状态信息(异步)
|
|
322
|
+
• **statSync**: `(params: StatParams) => StatResult` - 获取文件或目录的状态信息(同步)
|
|
323
|
+
• **copyFile**: `(params: CopyFileParams) => Promise<void>` - 复制文件(异步)。不支持复制目录
|
|
324
|
+
• **copyFileSync**: `(params: CopyFileParams) => void` - 复制文件(同步)。不支持复制目录
|
|
325
|
+
• **rename**: `(params: RenameParams) => Promise<void>` - 重命名或移动文件(异步)
|
|
326
|
+
• **renameSync**: `(params: RenameParams) => void` - 重命名或移动文件(同步)
|
|
327
|
+
• **truncate**: `(params: TruncateParams) => Promise<void>` - 截断文件到指定长度(异步)
|
|
328
|
+
• **truncateSync**: `(params: TruncateParams) => void` - 截断文件到指定长度(同步)
|
|
329
|
+
• **getFileInfo**: `(params: GetFileInfoParams) => Promise<GetFileInfoResult>` - 获取文件信息,可选计算文件摘要(异步)
|
|
330
|
+
• **saveFile**: `(params: SaveFileParams) => Promise<SaveFileResult>` - 将临时文件保存到本地持久化存储(异步)
|
|
331
|
+
• **saveFileSync**: `(params: SaveFileParams) => SaveFileResult` - 将临时文件保存到本地持久化存储(同步)
|
|
332
|
+
• **getSavedFileList**: `() => Promise<GetSavedFileListResult>` - 获取已保存的本地文件列表(异步)
|
|
333
|
+
• **removeSavedFile**: `(params: RemoveSavedFileParams) => Promise<void>` - 删除通过 FileSystemManager.saveFile 保存的本地文件(异步)
|
|
334
|
+
• **unzip**: `(params: UnzipParams) => Promise<void>` - 解压 zip 文件到指定目录(异步)
|
package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/README.md
RENAMED
|
@@ -6,13 +6,13 @@
|
|
|
6
6
|
|
|
7
7
|
| 分组 | 说明 | API 数量 | 详细文档 |
|
|
8
8
|
| --- | --- | ---: | --- |
|
|
9
|
-
| 基础 | 账号、授权、宿主基础信息、窗口信息和能力可用性。 |
|
|
10
|
-
| 系统 | 宿主基础信息、窗口信息和系统设置。 |
|
|
11
|
-
| 定位 | 获取设备当前的地理位置信息。 |
|
|
9
|
+
| 基础 | 账号、授权、宿主基础信息、窗口信息和能力可用性。 | 6 | [查看](./01-基础.md) |
|
|
10
|
+
| 系统 | 宿主基础信息、窗口信息和系统设置。 | 8 | [查看](./02-系统.md) |
|
|
11
|
+
| 定位 | 获取设备当前的地理位置信息。 | 9 | [查看](./03-定位.md) |
|
|
12
12
|
| 存储 | 本地缓存;带 Sync 后缀的是同步 API。 | 10 | [查看](./04-存储.md) |
|
|
13
13
|
| 路由 | 应用内页面跳转、返回、退出和关闭。 | 6 | [查看](./05-路由.md) |
|
|
14
14
|
| 交互 | Toast、Loading、Modal、ActionSheet 和返回前提醒。 | 9 | [查看](./06-交互.md) |
|
|
15
|
-
| 输入 | 键盘和输入框选区能力。 |
|
|
15
|
+
| 输入 | 键盘和输入框选区能力。 | 3 | [查看](./07-输入.md) |
|
|
16
16
|
| 网络 | 网络请求与 WebSocket。 | 2 | [查看](./08-网络.md) |
|
|
17
17
|
| 媒体 | 图片选择、预览、保存、压缩和信息读取。 | 5 | [查看](./09-媒体.md) |
|
|
18
18
|
| 业务能力 | 开放业务能力、隐私设置、上下文和外部应用打开。 | 11 | [查看](./10-业务能力.md) |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> 端能力 API。默认从 `@doubao-apps/framework/api` 导入;本文件根据 `packages/open-api/src` 的导出结构自动生成,按模块列出 API 名称和说明。
|
|
4
4
|
|
|
5
|
-
覆盖
|
|
5
|
+
覆盖 146 个函数。详细参数、返回值、示例和相关类型请查看 [Open API 目录](open-api/README.md),精确字段也可按参数/结果类型名查看 IDE 类型提示或 `@doubao-apps/framework/api` 类型定义。
|
|
6
6
|
|
|
7
7
|
## 使用方式
|
|
8
8
|
|
|
@@ -20,6 +20,8 @@ import { showToast, request, getStorage } from '@doubao-apps/framework/api';
|
|
|
20
20
|
| [getAccountInfoSync](open-api/01-基础.md#getaccountinfosync) | 同步获取账号信息。<br><br>同步 API。 |
|
|
21
21
|
| [authorize](open-api/01-基础.md#authorize) | 初始化授权。 |
|
|
22
22
|
| [canIUse](open-api/01-基础.md#caniuse) | 检测当前宿主是否支持指定 API 或能力。 |
|
|
23
|
+
| [getPackageInfo](open-api/01-基础.md#getpackageinfo) | 获取当前 package 信息。 |
|
|
24
|
+
| [getPackageInfoSync](open-api/01-基础.md#getpackageinfosync) | 同步获取当前 package 信息。<br><br>同步 API。 |
|
|
23
25
|
|
|
24
26
|
## 系统
|
|
25
27
|
|
|
@@ -32,8 +34,9 @@ import { showToast, request, getStorage } from '@doubao-apps/framework/api';
|
|
|
32
34
|
| [getAppBaseInfoSync](open-api/02-系统.md#getappbaseinfosync) | 获取应用基础信息。<br><br>同步 API。 |
|
|
33
35
|
| [getWindowInfo](open-api/02-系统.md#getwindowinfo) | 获取窗口信息。 |
|
|
34
36
|
| [getAppBaseInfo](open-api/02-系统.md#getappbaseinfo) | 获取应用基础信息。 |
|
|
35
|
-
| [ThemeChangeListener](open-api/02-系统.md#themechangelistener) | 应用主题变化事件监听函数。<br><br>返回 void,不是 Promise。 |
|
|
36
37
|
| [onThemeChange](open-api/02-系统.md#onthemechange) | 监听应用主题变化。 |
|
|
38
|
+
| [getSystemInfo](open-api/02-系统.md#getsysteminfo) | 获取系统信息。 |
|
|
39
|
+
| [getSystemInfoSync](open-api/02-系统.md#getsysteminfosync) | 同步获取系统信息。<br><br>同步 API。 |
|
|
37
40
|
|
|
38
41
|
## 定位
|
|
39
42
|
|
|
@@ -41,8 +44,6 @@ import { showToast, request, getStorage } from '@doubao-apps/framework/api';
|
|
|
41
44
|
|
|
42
45
|
| API | 说明 |
|
|
43
46
|
| --- | --- |
|
|
44
|
-
| [LocationChangeListener](open-api/03-定位.md#locationchangelistener) | LocationChangeListener API。<br><br>返回 void,不是 Promise。 |
|
|
45
|
-
| [LocationChangeErrorListener](open-api/03-定位.md#locationchangeerrorlistener) | LocationChangeErrorListener API。<br><br>返回 void,不是 Promise。 |
|
|
46
47
|
| [getLocation](open-api/03-定位.md#getlocation) | 获取设备当前的地理位置信息。 |
|
|
47
48
|
| [chooseLocation](open-api/03-定位.md#chooselocation) | 打开地图选择位置。 |
|
|
48
49
|
| [openLocation](open-api/03-定位.md#openlocation) | 使用地图查看位置。 |
|
|
@@ -106,6 +107,7 @@ Toast、Loading、Modal、ActionSheet 和返回前提醒。
|
|
|
106
107
|
| API | 说明 |
|
|
107
108
|
| --- | --- |
|
|
108
109
|
| [hideKeyboard](open-api/07-输入.md#hidekeyboard) | 收起当前键盘。 |
|
|
110
|
+
| [onKeyboardHeightChange](open-api/07-输入.md#onkeyboardheightchange) | 监听键盘高度变化事件。 |
|
|
109
111
|
| [getSelectedTextRange](open-api/07-输入.md#getselectedtextrange) | 获取当前输入框的选区范围。 |
|
|
110
112
|
|
|
111
113
|
## 网络
|
|
@@ -210,13 +212,13 @@ Wi-Fi 模块能力;通常先 startWifi,再获取列表或连接。
|
|
|
210
212
|
|
|
211
213
|
| API | 说明 |
|
|
212
214
|
| --- | --- |
|
|
213
|
-
| [WifiConnectedListener](open-api/15-wi-fi.md#wificonnectedlistener) | Wi-Fi 连接事件监听函数。<br><br>返回 void,不是 Promise。 |
|
|
214
215
|
| [startWifi](open-api/15-wi-fi.md#startwifi) | 初始化 Wi-Fi 模块。 |
|
|
215
216
|
| [stopWifi](open-api/15-wi-fi.md#stopwifi) | 关闭 Wi-Fi 模块。 |
|
|
216
217
|
| [setWifiList](open-api/15-wi-fi.md#setwifilist) | 设置 Wi-Fi 预设列表(iOS 特有)。 |
|
|
217
218
|
| [connectWifi](open-api/15-wi-fi.md#connectwifi) | 连接指定 Wi-Fi。 |
|
|
218
219
|
| [getConnectedWifi](open-api/15-wi-fi.md#getconnectedwifi) | 获取当前已连接 Wi-Fi 信息。 |
|
|
219
220
|
| [getWifiList](open-api/15-wi-fi.md#getwifilist) | 获取 Wi-Fi 列表。 |
|
|
221
|
+
| [onWifiConnected](open-api/15-wi-fi.md#onwificonnected) | 监听连接上 Wi-Fi 的事件。 |
|
|
220
222
|
|
|
221
223
|
## 加速度计
|
|
222
224
|
|
|
@@ -224,9 +226,9 @@ Wi-Fi 模块能力;通常先 startWifi,再获取列表或连接。
|
|
|
224
226
|
|
|
225
227
|
| API | 说明 |
|
|
226
228
|
| --- | --- |
|
|
227
|
-
| [AccelerometerChangeListener](open-api/16-加速度计.md#accelerometerchangelistener) | 加速度数据变化事件监听函数。<br><br>返回 void,不是 Promise。 |
|
|
228
229
|
| [startAccelerometer](open-api/16-加速度计.md#startaccelerometer) | 开始监听加速度。 |
|
|
229
230
|
| [stopAccelerometer](open-api/16-加速度计.md#stopaccelerometer) | 停止监听加速度。 |
|
|
231
|
+
| [onAccelerometerChange](open-api/16-加速度计.md#onaccelerometerchange) | 监听加速度数据变化事件。 |
|
|
230
232
|
|
|
231
233
|
## iBeacon
|
|
232
234
|
|
|
@@ -244,9 +246,9 @@ iBeacon 搜索和结果读取能力。
|
|
|
244
246
|
|
|
245
247
|
| API | 说明 |
|
|
246
248
|
| --- | --- |
|
|
247
|
-
| [CompassChangeListener](open-api/18-罗盘.md#compasschangelistener) | 罗盘数据变化事件监听函数。<br><br>返回 void,不是 Promise。 |
|
|
248
249
|
| [startCompass](open-api/18-罗盘.md#startcompass) | 开始监听罗盘。 |
|
|
249
250
|
| [stopCompass](open-api/18-罗盘.md#stopcompass) | 停止监听罗盘。 |
|
|
251
|
+
| [onCompassChange](open-api/18-罗盘.md#oncompasschange) | 监听罗盘数据变化事件。 |
|
|
250
252
|
|
|
251
253
|
## 设备方向
|
|
252
254
|
|
|
@@ -254,9 +256,9 @@ iBeacon 搜索和结果读取能力。
|
|
|
254
256
|
|
|
255
257
|
| API | 说明 |
|
|
256
258
|
| --- | --- |
|
|
257
|
-
| [DeviceMotionChangeListener](open-api/19-设备方向.md#devicemotionchangelistener) | 设备方向变化事件监听函数。<br><br>返回 void,不是 Promise。 |
|
|
258
259
|
| [startDeviceMotionListening](open-api/19-设备方向.md#startdevicemotionlistening) | 开始监听设备方向变化。 |
|
|
259
260
|
| [stopDeviceMotionListening](open-api/19-设备方向.md#stopdevicemotionlistening) | 停止监听设备方向变化。 |
|
|
261
|
+
| [onDeviceMotionChange](open-api/19-设备方向.md#ondevicemotionchange) | 监听设备方向变化事件。 |
|
|
260
262
|
|
|
261
263
|
## 陀螺仪
|
|
262
264
|
|
|
@@ -264,9 +266,9 @@ iBeacon 搜索和结果读取能力。
|
|
|
264
266
|
|
|
265
267
|
| API | 说明 |
|
|
266
268
|
| --- | --- |
|
|
267
|
-
| [GyroscopeChangeListener](open-api/20-陀螺仪.md#gyroscopechangelistener) | 陀螺仪数据变化事件监听函数。<br><br>返回 void,不是 Promise。 |
|
|
268
269
|
| [startGyroscope](open-api/20-陀螺仪.md#startgyroscope) | 开始监听陀螺仪。 |
|
|
269
270
|
| [stopGyroscope](open-api/20-陀螺仪.md#stopgyroscope) | 停止监听陀螺仪。 |
|
|
271
|
+
| [onGyroscopeChange](open-api/20-陀螺仪.md#ongyroscopechange) | 监听陀螺仪数据变化事件。 |
|
|
270
272
|
|
|
271
273
|
## 设备 / 网络
|
|
272
274
|
|
|
@@ -276,7 +278,7 @@ iBeacon 搜索和结果读取能力。
|
|
|
276
278
|
| --- | --- |
|
|
277
279
|
| [getLocalIPAddress](open-api/21-设备-网络.md#getlocalipaddress) | 获取局域网 IP 地址。 |
|
|
278
280
|
| [getNetworkType](open-api/21-设备-网络.md#getnetworktype) | 获取当前网络类型。 |
|
|
279
|
-
| [
|
|
281
|
+
| [onNetworkStatusChange](open-api/21-设备-网络.md#onnetworkstatuschange) | 监听网络状态变化事件。 |
|
|
280
282
|
|
|
281
283
|
## 短信
|
|
282
284
|
|
|
@@ -309,8 +311,8 @@ iBeacon 搜索和结果读取能力。
|
|
|
309
311
|
|
|
310
312
|
| API | 说明 |
|
|
311
313
|
| --- | --- |
|
|
312
|
-
| [BatteryInfoChangeListener](open-api/25-电池.md#batteryinfochangelistener) | 电池信息变化事件监听函数。<br><br>返回 void,不是 Promise。 |
|
|
313
314
|
| [getBatteryInfo](open-api/25-电池.md#getbatteryinfo) | 获取电池信息。 |
|
|
315
|
+
| [onBatteryInfoChange](open-api/25-电池.md#onbatteryinfochange) | 监听电池信息变化事件。 |
|
|
314
316
|
|
|
315
317
|
## 日历
|
|
316
318
|
|
|
@@ -369,11 +371,11 @@ iBeacon 搜索和结果读取能力。
|
|
|
369
371
|
|
|
370
372
|
| API | 说明 |
|
|
371
373
|
| --- | --- |
|
|
372
|
-
| [UserCaptureScreenListener](open-api/32-屏幕.md#usercapturescreenlistener) | 用户主动截屏事件监听函数。<br><br>返回 void,不是 Promise。 |
|
|
373
374
|
| [getScreenBrightness](open-api/32-屏幕.md#getscreenbrightness) | 获取屏幕亮度。 |
|
|
374
375
|
| [setVisualEffectOnCapture](open-api/32-屏幕.md#setvisualeffectoncapture) | 设置截屏或录屏时的视觉表现。 |
|
|
375
376
|
| [setScreenBrightness](open-api/32-屏幕.md#setscreenbrightness) | 设置屏幕亮度。 |
|
|
376
377
|
| [setKeepScreenOn](open-api/32-屏幕.md#setkeepscreenon) | 设置屏幕常亮状态。 |
|
|
378
|
+
| [onUserCaptureScreen](open-api/32-屏幕.md#onusercapturescreen) | 监听用户主动截屏事件。 |
|
|
377
379
|
|
|
378
380
|
## 震动
|
|
379
381
|
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: doubao-components-api
|
|
3
|
+
description: |
|
|
4
|
+
豆包小程序内置组件 API 参考。覆盖所有经 components-loader 自动注入的小写标签组件,
|
|
5
|
+
包含 props、事件、ref 方法和使用约束。当用户询问组件用法、props 类型、事件回调格式时使用。
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# 豆包小程序组件 API
|
|
9
|
+
|
|
10
|
+
## 核心规则
|
|
11
|
+
|
|
12
|
+
所有组件使用**小写标签**,`components-loader` 在构建时自动注入 import,业务代码不需要手动 import 运行时组件:
|
|
13
|
+
|
|
14
|
+
```tsx
|
|
15
|
+
// ✅ 直接使用小写标签
|
|
16
|
+
<view><text>你好</text><button text="提交" /></view>
|
|
17
|
+
|
|
18
|
+
// ❌ 不要手动 import 运行时组件
|
|
19
|
+
import { View, Button } from '@doubao-apps/framework/components';
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
类型标注可以 import:
|
|
23
|
+
|
|
24
|
+
```tsx
|
|
25
|
+
import type { ButtonProps, SwiperRef, VideoRef, PopupRef } from '@doubao-apps/framework/components';
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## 参考文档
|
|
29
|
+
|
|
30
|
+
| 类别 | 文件 | 涵盖标签 |
|
|
31
|
+
|------|------|---------|
|
|
32
|
+
| 滚动与列表 | [layout-scroll.md](references/reference/layout-scroll.md) | `scroll-view` `list` `list-item` `swiper` `swiper-item` |
|
|
33
|
+
| 容器与覆层 | [layout-overlay.md](references/reference/layout-overlay.md) | `view` `popup` `movable-area` `movable-view` `theme-provider` |
|
|
34
|
+
| 文本与媒体 | [media.md](references/reference/media.md) | `text` `image` `svg` `video` `long-image` `web-view` |
|
|
35
|
+
| 交互控件 | [interactive.md](references/reference/interactive.md) | `button` `switch` `slider` `radio` `radio-group` |
|
|
36
|
+
| 表单 | [form.md](references/reference/form.md) | `input` `textarea` `picker-view` `picker-column` `picker-divider` |
|
|
37
|
+
| 地图与画布 | [map-canvas.md](references/reference/map-canvas.md) | `map` `map-marker` `canvas` |
|
|
38
|
+
|
|
39
|
+
## 常见错误
|
|
40
|
+
|
|
41
|
+
| 错误 | 修正 |
|
|
42
|
+
|------|------|
|
|
43
|
+
| 手动 import 运行时组件 | 直接用小写标签,loader 自动注入 |
|
|
44
|
+
| `<list>` 没设置 height | 必须 `style={{ height: '...' }}`,list 不支持自适应高度 |
|
|
45
|
+
| `list-item` 没传 `item-key` | item-key 是必填项(原生 Lynx 元素,连字符属性名) |
|
|
46
|
+
| `picker-view` 高度只写在 CSS class | 必须同时写 `style={{ height: '...' }}` |
|
|
47
|
+
| `slider` 不传 value | slider 仅支持受控用法 |
|
|
48
|
+
| `image` 没设置 width/height 也没设 autoSize | 不满足条件图片不显示 |
|
|
49
|
+
| `popup` 没传 scrollContainerId | scrollContainerId 是必填项 |
|
|
50
|
+
| `long-image` 接外部滚动容器直接传外层 scrollTop | 有 header 时需减去 header 高度 |
|