@doubao-apps/create 0.0.27 → 0.0.28

package/dist/template-empty/.ai/reference/open-api/04-/347/225/214/351/235/242-/344/272/244/344/272/222.md

@@ -1,432 +0,0 @@
-# Open API: 界面 / 交互
-
-Toast、Loading、Modal、ActionSheet 和返回前提醒。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [showModal](#showmodal) | 显示模态对话框。 |
-| [showLoading](#showloading) | 显示 loading 提示框。<br><br>需调用 hideLoading 关闭。 |
-| [hideToast](#hidetoast) | 隐藏当前 Toast。 |
-| [hideLoading](#hideloading) | 隐藏当前 loading。 |
-| [showActionSheet](#showactionsheet) | 显示操作菜单。 |
-| [getMenuButtonBoundingClientRect](#getmenubuttonboundingclientrect) | 获取菜单按钮的布局位置信息。 |
-| [enableAlertBeforeUnload](#enablealertbeforeunload) | 开启页面返回前提醒。<br><br>配合 disableAlertBeforeUnload 使用。 |
-| [disableAlertBeforeUnload](#disablealertbeforeunload) | 关闭页面返回前提醒。 |
-| [showToast](#showtoast) | 显示 Toast 提示。<br><br>duration 和 icon 可控制提示表现。 |
-
-## API 详情
-
-<a id="showmodal"></a>
-### showModal()
-
-> **showModal**(`params`): `Promise`\<[`ShowModalResult`](#showmodalresult)\>
-
-显示模态对话框。
-
-#### Parameters
-
-• **params**: [`ShowModalParams`](#showmodalparams)
-
-#### Returns
-
-`Promise`\<[`ShowModalResult`](#showmodalresult)\>
-
-#### Example
-
-```ts
-import { showModal } from '@doubao-apps/framework/api';
-
-const result = await showModal({
-  title: '提示',
-  content: '确认删除这条记录吗？',
-  confirmText: '删除',
-  cancelText: '取消'
-});
-
-if (result.action === 'confirm') {
-  console.log('用户确认删除');
-}
-```
-
-<a id="showloading"></a>
-### showLoading()
-
-> **showLoading**(`params`?): `Promise`\<`object`\>
-
-显示 loading 提示框。
-
-#### Parameters
-
-• **params?**: [`ShowLoadingParams`](#showloadingparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-#### Remarks
-
-需调用 hideLoading 关闭。
-
-<a id="hidetoast"></a>
-### hideToast()
-
-> **hideToast**(`params`?): `Promise`\<`object`\>
-
-隐藏当前 Toast。
-
-#### Parameters
-
-• **params?**: [`HideInteractionParams`](#hideinteractionparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-<a id="hideloading"></a>
-### hideLoading()
-
-> **hideLoading**(`params`?): `Promise`\<`object`\>
-
-隐藏当前 loading。
-
-#### Parameters
-
-• **params?**: [`HideInteractionParams`](#hideinteractionparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-<a id="showactionsheet"></a>
-### showActionSheet()
-
-> **showActionSheet**(`params`): `Promise`\<[`ShowActionSheetResult`](#showactionsheetresult)\>
-
-显示操作菜单。
-
-#### Parameters
-
-• **params**: [`ShowActionSheetParams`](#showactionsheetparams)
-
-#### Returns
-
-`Promise`\<[`ShowActionSheetResult`](#showactionsheetresult)\>
-
-#### Example
-
-```ts
-import { showActionSheet } from '@doubao-apps/framework/api';
-
-const result = await showActionSheet({
-  itemList: ['编辑', '删除']
-});
-
-console.log(result.tapIndex);
-```
-
-<a id="getmenubuttonboundingclientrect"></a>
-### getMenuButtonBoundingClientRect()
-
-> **getMenuButtonBoundingClientRect**(`params`?): [`MenuButtonBoundingClientRect`](#menubuttonboundingclientrect)
-
-获取菜单按钮的布局位置信息。
-
-#### Parameters
-
-• **params?**
-
-#### Returns
-
-[`MenuButtonBoundingClientRect`](#menubuttonboundingclientrect)
-
-返回菜单按钮相对屏幕左上角的坐标和尺寸，字段见 [MenuButtonBoundingClientRect](#menubuttonboundingclientrect)。
-
-#### Example
-
-```ts
-import { getMenuButtonBoundingClientRect } from '@doubao-apps/framework/api';
-
-const rect = getMenuButtonBoundingClientRect();
-
-console.log(rect.width, rect.height);
-console.log(rect.top, rect.right, rect.bottom, rect.left);
-```
-
-<a id="enablealertbeforeunload"></a>
-### enableAlertBeforeUnload()
-
-> **enableAlertBeforeUnload**(`params`): `Promise`\<`object`\>
-
-开启页面返回前提醒。
-当用户在小程序非最底层页面点击左上角返回按钮、左上角首页按钮或 Android 系统 back 键时,弹起询问弹窗
-
-返回询问对话框只会对调用的当前页面生效，通过手势滑动返回时不会弹起询问对话框
-
-#### Parameters
-
-• **params**: [`EnableAlertBeforeUnloadParams`](#enablealertbeforeunloadparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-#### Remarks
-
-配合 disableAlertBeforeUnload 使用。
-
-<a id="disablealertbeforeunload"></a>
-### disableAlertBeforeUnload()
-
-> **disableAlertBeforeUnload**(`params`?): `Promise`\<`object`\>
-
-关闭页面返回前提醒。
-
-#### Parameters
-
-• **params?**: `Record`\<`string`, `never`\>
-
-#### Returns
-
-`Promise`\<`object`\>
-
-<a id="showtoast"></a>
-### showToast()
-
-> **showToast**(`params`): `Promise`\<`object`\>
-
-显示 Toast 提示。
-
-参数 `options` 包含以下字段：
-- `message`: 提示的内容。
-- `type`: Toast 的类型，可选值为 'success' 或 'error'。
-- `duration`: 提示的延迟时间，单位毫秒，默认为 2000。
-- `icon`: 图标，可选值为 'success', 'error', 'warn'。
-- `customIcon`: 自定义图标的 URL 或 base64 字符串。
-
-#### Parameters
-
-• **params**: [`ShowToastParams`](#showtoastparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-返回一个 Promise，在 Toast 显示结束时 resolve。
-
-#### Remarks
-
-duration 和 icon 可控制提示表现。
-
-#### Example
-
-```typescript
-import { showToast } from '@doubao-apps/framework';
-
-// 显示一个成功的 Toast
-showToast({
-  message: '操作成功',
-  type: 'success',
-  icon: 'success',
-  duration: 1500
-}).then(() => {
-  console.log('Toast 显示完毕');
-});
-
-// 显示一个错误的 Toast
-showToast({
-  message: '网络错误',
-  type: 'error',
-  icon: 'error'
-});
-```
-
-## 相关类型
-
-<a id="showmodalparams"></a>
-### ShowModalParams
-
-显示模态对话框的参数。
-
-#### Properties
-
-##### cancelText?
-
-> `optional` **cancelText**: `string`
-
-取消按钮的文字。
-
-##### confirmText?
-
-> `optional` **confirmText**: `string`
-
-确认按钮的文字。
-
-##### content
-
-> **content**: `string`
-
-模态对话框的内容。
-
-##### showCancel?
-
-> `optional` **showCancel**: `boolean`
-
-是否显示取消按钮，默认 `true`。
-
-##### tapMaskToDismiss?
-
-> `optional` **tapMaskToDismiss**: `boolean`
-
-是否允许点击蒙层关闭对话框，默认 `false`。
-
-##### title?
-
-> `optional` **title**: `string`
-
-模态对话框的标题。
-
-<a id="showmodalresult"></a>
-### ShowModalResult
-
-显示模态对话框的返回结果。
-
-#### Properties
-
-##### action
-
-> **action**: `"confirm"` \| `"cancel"` \| `"mask"`
-
-用户点击的动作。
-
-<a id="showloadingparams"></a>
-### ShowLoadingParams
-
-显示 loading 提示框的参数。
-
-<a id="hideinteractionparams"></a>
-### HideInteractionParams
-
-隐藏交互提示框的公共参数。
-
-<a id="showactionsheetparams"></a>
-### ShowActionSheetParams
-
-显示操作菜单的参数。
-
-#### Properties
-
-##### itemColor?
-
-> `optional` **itemColor**: `string`
-
-按钮文字颜色。
-
-##### itemList
-
-> **itemList**: `string`[]
-
-按钮文字数组。
-
-##### title?
-
-> `optional` **title**: `string`
-
-标题
-
-<a id="showactionsheetresult"></a>
-### ShowActionSheetResult
-
-显示操作菜单的返回结果。
-
-#### Properties
-
-##### tapIndex
-
-> **tapIndex**: `number`
-
-用户点击的按钮序号，从 0 开始。
-
-<a id="menubuttonboundingclientrect"></a>
-### MenuButtonBoundingClientRect
-
-菜单按钮的布局位置信息。
-
-#### Properties
-
-##### bottom
-
-> **bottom**: `number`
-
-下边界坐标，单位 px。
-
-##### height
-
-> **height**: `number`
-
-高度，单位 px。
-
-##### left
-
-> **left**: `number`
-
-左边界坐标，单位 px。
-
-##### right
-
-> **right**: `number`
-
-右边界坐标，单位 px。
-
-##### top
-
-> **top**: `number`
-
-上边界坐标，单位 px。
-
-##### width
-
-> **width**: `number`
-
-宽度，单位 px。
-
-<a id="enablealertbeforeunloadparams"></a>
-### EnableAlertBeforeUnloadParams
-
-开启返回前提醒的参数。
-
-#### Properties
-
-##### message
-
-> **message**: `string`
-
-返回前确认弹窗的文案。
-
-<a id="showtoastparams"></a>
-### ShowToastParams
-
-#### Properties
-
-##### customIcon?
-
-> `optional` **customIcon**: `string`
-
-##### duration?
-
-> `optional` **duration**: `number`
-
-##### icon?
-
-> `optional` **icon**: `"success"` \| `"error"` \| `"warn"`
-
-##### message
-
-> **message**: `string`
-
-##### type?
-
-> `optional` **type**: `"default"` \| `"success"` \| `"error"` \| `"warning"`

package/dist/template-empty/.ai/reference/open-api/06-/347/275/221/347/273/234.md

@@ -1,148 +0,0 @@
-# Open API: 网络
-
-网络请求
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [request](#request) | 发起网络请求。<br><br>返回 statusCode、header 和 data。 |
-
-## API 详情
-
-<a id="request"></a>
-### request()
-
-> **request**(`params`): `Promise`\<[`RequestResponse`](#requestresponse)\>
-
-发起网络请求。
-
-#### Parameters
-
-• **params**: [`RequestParams`](#requestparams)
-
-请求参数，字段见 [RequestParams](#requestparams)。
-
-#### Returns
-
-`Promise`\<[`RequestResponse`](#requestresponse)\>
-
-返回一个 Promise，解析为 [RequestResponse](#requestresponse)。
-
-#### Remarks
-
-返回 statusCode、header 和 data。
-
-#### Example
-
-```typescript
-import { request } from '@doubao-apps/framework/api';
-
-const result = await request({
-  url: 'https://postman-echo.com/post',
-  method: 'POST',
-  dataType: 'json',
-  header: { 'content-type': 'application/json' },
-  data: { hello: 'world' }
-});
-
-console.log(result.statusCode, result.data);
-```
-
-## 相关类型
-
-<a id="requestparams"></a>
-### RequestParams
-
-网络请求参数。
-
-#### Properties
-
-##### data?
-
-> `optional` **data**: `string` \| `Record`\<`string`, `any`\> \| `ArrayBuffer`
-
-请求体数据。
-
-传给服务器的数据最终会是 `String` 或 `ArrayBuffer`：
-- 若 `data` 是 `string` 或 `ArrayBuffer`，直接使用；
-- 若 `header['content-type']` 是 `application/x-www-form-urlencoded`，会被编码为 query string，例如：`encodeURIComponent(k)=encodeURIComponent(v)`；
-- 若 `header['content-type']` 是 `application/json`，会执行 JSON 序列化；
-- 若 `data` 是普通对象且未命中上述类型，也会执行 JSON 序列化；
-- 其他类型会调用 `toString()`
-
-##### dataType?
-
-> `optional` **dataType**: `"string"` \| `"json"`
-
-期望返回的数据格式。
-- `json`: 尝试按 JSON 解析；
-- `string`: 按字符串返回。
-
-###### Default
-
-```ts
-"json"
-```
-
-##### header?
-
-> `optional` **header**: `Record`\<`string`, `string`\>
-
-请求 Header。
-
-###### Default
-
-```ts
-{"content-type": "application/json"}
-```
-
-##### method?
-
-> `optional` **method**: [`RequestMethod`](#requestmethod)
-
-请求方法。
-
-###### Default
-
-```ts
-"GET"
-```
-
-##### url
-
-> **url**: `string`
-
-请求地址，需为完整的 **HTTPS** URL。
-
-<a id="requestresponse"></a>
-### RequestResponse
-
-网络请求返回结果。
-
-#### Properties
-
-##### data?
-
-> `optional` **data**: `string` \| `Record`\<`string`, `any`\> \| `ArrayBuffer`
-
-响应数据，类型由 `dataType` 决定。
-
-##### header
-
-> **header**: `Record`\<`string`, `string`\>
-
-HTTP 响应头。
-
-##### statusCode
-
-> **statusCode**: `number`
-
-HTTP 状态码。
-
-<a id="requestmethod"></a>
-### RequestMethod
-
-> **RequestMethod**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"HEAD"` \| `"OPTIONS"` \| `"TRACE"` \| `"CONNECT"`