@dfeidao/atom-wxapp > api_ui交互类
External module: api_ui交互类
Index
Functions
- hideLoading
- hideToast
- hide_nav_bar_loading
- page_scroll_to
- setTopBarText
- set_nav_bar_color
- set_nav_bar_title
- show_action_sheet
- show_loading
- show_modal
- show_nav_bar_loading
- show_toast
- start_pull_down_refresh
- stop_pull_down_refresh
Functions
hideLoading
▸ hideLoading(): void
Defined in api/interaction/hide-loading.ts:15
隐藏 loading 提示框
see: 微信官方文档
example:
import hideLoading from '@dfeidao/atom-wxapp/api/interaction/hide-loading';
hideLoading();
Returns: void
hideToast
▸ hideToast(): void
Defined in api/interaction/hide-toast.ts:14
隐藏消息提示框
see: 微信官方文档
example:
import hideToast from '@dfeidao/atom-wxapp/api/interaction/hide-toast';
hideToast();
Returns: void
hide_nav_bar_loading
▸ hide_nav_bar_loading(): void
Defined in api/interaction/hide-nav-bar-loading.ts:14
在当前页面隐藏导航条加载动画
see: 微信官方文档
example:
import hide_nav_bar_loading from '@dfeidao/atom-wxapp/api/interaction/hide-nav-bar-loading';
hide_nav_bar_loading();
Returns: void
page_scroll_to
▸ page_scroll_to(scrollTop: number
, duration: number
): void
Defined in api/interaction/page-scroll-to.ts:18
将页面滚动到目标位置
see: 微信官方文档 将页面滚动到目标位置。
example:
import page_scroll_to from '@dfeidao/atom-wxapp/api/interaction/page-scroll-to';
page_scroll_to(100, 300);
Parameters:
Name | Type | Description |
---|---|---|
scrollTop | number |
滚动到页面的目标位置,单位 px |
duration | number |
滚动动画的时长,单位 ms |
Returns: void
setTopBarText
▸ setTopBarText(text: string
): Promise
<boolean
>
Defined in api/interaction/set-top-bar-text.ts:16
动态设置置顶栏文字内容
description: 只有当前小程序被置顶时能生效,如果当前小程序没有被置顶,也能调用成功,但是不会立即生效,只有在用户将这个小程序置顶后才换上设置的文字内容.
see微信官方文档:
example:
import setTopBarText from '@dfeidao/atom-wxapp/api/interaction/set-top-bar-text';
await setTopBarText('首页');
Parameters:
Name | Type | Description |
---|---|---|
text | string |
置顶栏文字 |
Returns: Promise
<boolean
>
set_nav_bar_color
▸ set_nav_bar_color(frontColor: “#ffffff” | “#000000”, backgroundColor: string
, animation?: undefined
| object
): Promise
<boolean
>
Defined in api/interaction/set-nav-bar-color.ts:17
设置页面导航条颜色
see微信官方文档:
example:
import set_nav_bar_color from '@dfeidao/atom-wxapp/api/interaction/set-nav-bar-color';
await set_nav_bar_color('#ffffff', '#ff0000', { duration: 400, timingFunc: 'easeIn' });
Parameters:
Name | Type | Description |
---|---|---|
frontColor | “#ffffff” | “#000000” | |
backgroundColor | string |
|
Optional animation |
undefined | object |
动画效果{ duration?: number; timingFunc?: ‘linear’ | ‘easeIn’ | ‘easeOut’ | ‘easeInOut’ } |
Returns: Promise
<boolean
>
set_nav_bar_title
▸ set_nav_bar_title(title: string
): Promise
<boolean
>
Defined in api/interaction/set-nav-bar-title.ts:15
动态设置当前页面的标题
see微信官方文档:
example:
import set_nav_bar_title from '@dfeidao/atom-wxapp/api/interaction/set-nav-bar-title';
await set_nav_bar_title('首页');
Parameters:
Name | Type | Description |
---|---|---|
title | string |
页面标题 |
Returns: Promise
<boolean
>
show_action_sheet
▸ show_action_sheet(itemList: string
[], itemColor?: undefined
| string
): Promise
<object
>
Defined in api/interaction/show-action-sheet.ts:16
显示操作菜单
see: 微信官方文档
example:
import show_action_sheet from '@dfeidao/atom-wxapp/api/interaction/show-action-sheet';
await show_action_sheet(['A', 'B', 'C'], '#cccccc');
Parameters:
Name | Type | Description |
---|---|---|
itemList | string [] |
按钮的文字数组,数组长度最大为 6 |
Optional itemColor |
undefined | string |
按钮的文字颜色,默认为#000000 |
Returns: Promise
<object
>
show_loading
▸ show_loading(showtitle: string
, mask?: undefined
| false
| true
): Promise
<boolean
>
Defined in api/interaction/show-loading.ts:17
显示 loading 提示框
description: 需主动调用 hide-loading 原子操作才能关闭提示框
see: 微信官方文档 hide-loading
example:
import show_loading from '@dfeidao/atom-wxapp/api/interaction/show-loading';
await show_loading('加载中', true);
Parameters:
Name | Type | Description |
---|---|---|
showtitle | string |
提示的内容 |
Optional mask |
undefined | false | true |
是否显示透明蒙层,防止触摸穿透,默认:false |
Returns: Promise
<boolean
>
show_modal
▸ show_modal(title: string
, content: string
, cancelText?: undefined
| string
, showCancel?: undefined
| false
| true
, cancelColor?: undefined
| string
, confirmText?: undefined
| string
, confirmColor?: undefined
| string
): Promise
<object
>
Defined in api/interaction/show-modal.ts:21
显示模态对话框
see: 微信官方文档
example:
import show_modal from '@dfeidao/atom-wxapp/api/interaction/show-modal';
await show_modal('提示', '这是一个模态弹窗', '取消', true, '#000000', '确定', '#000000');
Parameters:
Name | Type | Description |
---|---|---|
title | string |
提示的标题 |
content | string |
提示的内容 |
Optional cancelText |
undefined | string |
取消按钮的文字,最多 4 个字符 |
Optional showCancel |
undefined | false | true |
是否显示取消按钮 |
Optional cancelColor |
undefined | string |
取消按钮的文字颜色,必须是 16 进制格式的颜色字符串 |
Optional confirmText |
undefined | string |
确认按钮的文字,最多 4 个字符 |
Optional confirmColor |
undefined | string |
确认按钮的文字颜色,必须是 16 进制格式的颜色字符串 |
Returns: Promise
<object
>
show_nav_bar_loading
▸ show_nav_bar_loading(): void
Defined in api/interaction/show-nav-bar-loading.ts:14
在当前页面显示导航条加载动画
see微信官方文档:
example:
import show_nav_bar_loading from '@dfeidao/atom-wxapp/api/interaction/show-nav-bar-loading';
await show_nav_bar_loading();
Returns: void
show_toast
▸ show_toast(title: string
, icon: “success” | “loading” | “none”, duration?: undefined
| number
, image?: undefined
| string
, mask?: undefined
| false
| true
): Promise
<boolean
>
Defined in api/interaction/show-toast.ts:20
显示消息提示框
see: 微信官方文档
example:
import show_toast from '@dfeidao/atom-wxapp/api/interaction/show-toast';
await show_toast('成功', 'success', 2000, './image/photo.jepg', true);
Parameters:
Name | Type | Description |
---|---|---|
title | string |
提示的内容 |
icon | “success” | “loading” | “none” | 图标 |
Optional duration |
undefined | number |
提示的延迟时间 |
Optional image |
undefined | string |
自定义图标的本地路径,image 的优先级高于 icon |
Optional mask |
undefined | false | true |
是否显示透明蒙层,防止触摸穿透 |
Returns: Promise
<boolean
>
start_pull_down_refresh
▸ start_pull_down_refresh(): void
Defined in api/interaction/start-pull-down-refresh.ts:16
开始下拉刷新
description: 调用后触发下拉刷新动画,效果与用户手动下拉刷新一致。
see: 微信官方文档
example:
import start_pull_down_refresh from '@dfeidao/atom-wxapp/api/interaction/start-pull-down-refresh';
start_pull_down_refresh();
Returns: void
stop_pull_down_refresh
▸ stop_pull_down_refresh(): void
Defined in api/interaction/stop-pull-down-refresh.ts:15
停止当前页面下拉刷新
see: 微信官方文档
example:
import stop_pull_down_refresh from '@dfeidao/atom-wxapp/api/interaction/stop-pull-down-refresh';
stop_pull_down_refresh();
Returns: void