@doubao-apps/create 0.0.25 → 0.0.26

package/dist/template-starter/.ai/reference/open-api/04-ui-/344/272/244/344/272/222.md

@@ -0,0 +1,432 @@
+# Open API: UI / 交互
+
+Toast、Loading、Modal、ActionSheet 和返回前提醒。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
+| --- | --- | --- | --- | --- | --- |
+| [`showModal`](#showmodal) | `showModal(params): Promise<ShowModalResult>` | 显示模态对话框 | `params: ShowModalParams` | `Promise<ShowModalResult>` | - |
+| [`showLoading`](#showloading) | `showLoading(params?): Promise<object>` | 显示 loading 提示框 | `params?: ShowLoadingParams` | `Promise<object>` | 需调用 hideLoading 关闭 |
+| [`hideToast`](#hidetoast) | `hideToast(params?): Promise<object>` | 隐藏当前 Toast | `params?: HideInteractionParams` | `Promise<object>` | - |
+| [`hideLoading`](#hideloading) | `hideLoading(params?): Promise<object>` | 隐藏当前 loading | `params?: HideInteractionParams` | `Promise<object>` | - |
+| [`showActionSheet`](#showactionsheet) | `showActionSheet(params): Promise<ShowActionSheetResult>` | 显示操作菜单 | `params: ShowActionSheetParams` | `Promise<ShowActionSheetResult>` | - |
+| [`getMenuButtonBoundingClientRect`](#getmenubuttonboundingclientrect) | `getMenuButtonBoundingClientRect(params?): MenuButtonBoundingClientRect` | 获取菜单按钮的布局位置信息 | `params?` | `MenuButtonBoundingClientRect` | - |
+| [`enableAlertBeforeUnload`](#enablealertbeforeunload) | `enableAlertBeforeUnload(params): Promise<object>` | 开启页面返回前提醒 | `params: EnableAlertBeforeUnloadParams` | `Promise<object>` | 配合 disableAlertBeforeUnload 使用 |
+| [`disableAlertBeforeUnload`](#disablealertbeforeunload) | `disableAlertBeforeUnload(params?): Promise<object>` | 关闭页面返回前提醒 | `params?: Record<string, never>` | `Promise<object>` | - |
+| [`showToast`](#showtoast) | `showToast(params): Promise<object>` | 显示 Toast 提示 | `params: ShowToastParams` | `Promise<object>` | 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-starter/.ai/reference/open-api/05-ui-/350/276/223/345/205/245.md

@@ -0,0 +1,95 @@
+# Open API: UI / 输入
+
+键盘和输入框选区能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
+| --- | --- | --- | --- | --- | --- |
+| [`onKeyboardHeightChange`](#onkeyboardheightchange) | `onKeyboardHeightChange(handler): () => void` | 监听键盘高度变化事件 | `handler` | `() => void` | 返回取消监听函数 |
+| [`hideKeyboard`](#hidekeyboard) | `hideKeyboard(params?): Promise<object>` | 收起键盘 | `params?` | `Promise<object>` | - |
+| [`getSelectedTextRange`](#getselectedtextrange) | `getSelectedTextRange(params?): Promise<GetSelectedTextRangeResult>` | 获取当前输入框的选区范围 | `params?` | `Promise<GetSelectedTextRangeResult>` | - |
+
+## API 详情
+
+<a id="onkeyboardheightchange"></a>
+### onKeyboardHeightChange()
+
+> **onKeyboardHeightChange**(`handler`): () => `void`
+
+监听键盘高度变化事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+##### Returns
+
+`void`
+
+#### Example
+
+```typescript
+import { onKeyboardHeightChange } from '@doubao-apps/framework/api';
+
+const unsubscribe = onKeyboardHeightChange(({ height }) => {
+  console.log('Keyboard height change event:', { height });
+});
+```
+
+<a id="hidekeyboard"></a>
+### hideKeyboard()
+
+> **hideKeyboard**(`params`?): `Promise`\<`object`\>
+
+收起键盘。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="getselectedtextrange"></a>
+### getSelectedTextRange()
+
+> **getSelectedTextRange**(`params`?): `Promise`\<[`GetSelectedTextRangeResult`](#getselectedtextrangeresult)\>
+
+获取当前输入框的选区范围。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetSelectedTextRangeResult`](#getselectedtextrangeresult)\>
+
+## 相关类型
+
+<a id="getselectedtextrangeresult"></a>
+### GetSelectedTextRangeResult
+
+获取输入框选区范围的返回结果。
+
+#### Properties
+
+##### end
+
+> **end**: `number`
+
+选区结束位置。
+
+##### start
+
+> **start**: `number`
+
+选区起始位置。