未验证 提交 ed215b21 编写于 作者: O openharmony_ci 提交者: Gitee

!24090 update api js md

Merge pull request !24090 from 李欣楠/master
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
## 导入模块 ## 导入模块
```js ```ts
import componentUtils from '@ohos.arkui.componentUtils' import componentUtils from '@ohos.arkui.componentUtils'
``` ```
## componentUtils.getRectangleById ## componentUtils.getRectangleById
...@@ -37,8 +37,9 @@ getRectangleById(id: string): ComponentInfo ...@@ -37,8 +37,9 @@ getRectangleById(id: string): ComponentInfo
**示例:** **示例:**
```js ```ts
let modePosition = componentUtils.getRectangleById("onClick"); import componentUtils from '@ohos.arkui.componentUtils';
let modePosition:componentUtils.ComponentInfo = componentUtils.getRectangleById("onClick");
``` ```
## ComponentInfo ## ComponentInfo
...@@ -140,14 +141,14 @@ let modePosition = componentUtils.getRectangleById("onClick"); ...@@ -140,14 +141,14 @@ let modePosition = componentUtils.getRectangleById("onClick");
**示例:** **示例:**
```js ```ts
import matrix4 from '@ohos.matrix4'; import matrix4 from '@ohos.matrix4';
import componentUtils from '@ohos.arkui.componentUtils'; import componentUtils from '@ohos.arkui.componentUtils';
@Entry @Entry
@Component @Component
struct Utils{ struct Utils{
private getComponentRect(key) { private getComponentRect(key:string) {
console.info("Mode Key: " + key); console.info("Mode Key: " + key);
let modePosition = componentUtils.getRectangleById(key); let modePosition = componentUtils.getRectangleById(key);
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
## 导入模块 ## 导入模块
```js ```ts
import mediaquery from '@ohos.mediaquery' import mediaquery from '@ohos.mediaquery'
``` ```
...@@ -42,8 +42,9 @@ matchMediaSync(condition: string): MediaQueryListener ...@@ -42,8 +42,9 @@ matchMediaSync(condition: string): MediaQueryListener
**示例:** **示例:**
```js ```ts
let listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件 import mediaquery from '@ohos.mediaquery'
let listener:mediaquery.MediaQueryListener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件
``` ```
...@@ -98,7 +99,7 @@ off(type: 'change', callback?: Callback<MediaQueryResult>): void ...@@ -98,7 +99,7 @@ off(type: 'change', callback?: Callback<MediaQueryResult>): void
**示例:** **示例:**
```js ```ts
import mediaquery from '@ohos.mediaquery' import mediaquery from '@ohos.mediaquery'
let listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件 let listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件
......
...@@ -8,8 +8,9 @@ ...@@ -8,8 +8,9 @@
## 导入模块 ## 导入模块
```js ```ts
import pluginComponentManager from '@ohos.pluginComponent' import pluginComponentManager from '@ohos.pluginComponent'
import Want from '@ohos.app.ability.Want';
``` ```
## PluginComponentTemplate ## PluginComponentTemplate
...@@ -153,8 +154,10 @@ OnPushEventCallback = (source: Want, template: PluginComponentTemplate, data: KV ...@@ -153,8 +154,10 @@ OnPushEventCallback = (source: Want, template: PluginComponentTemplate, data: KV
**示例:** **示例:**
```js ```ts
function onPushListener(source, template, data, extraData) { import pluginComponentManager from '@ohos.pluginComponent'
import Want from '@ohos.app.ability.Want';
function onPushListener(source: Want, template: PluginComponentTemplate, data: pluginComponentManager.KVObject, extraData: pluginComponentManager.KVObject) {
console.log("onPushListener template.source=" + template.source) console.log("onPushListener template.source=" + template.source)
console.log("onPushListener source=" + JSON.stringify(source)) console.log("onPushListener source=" + JSON.stringify(source))
console.log("onPushListener template=" + JSON.stringify(template)) console.log("onPushListener template=" + JSON.stringify(template))
...@@ -180,14 +183,16 @@ OnRequestEventCallback = (source: Want, name: string, data: KVObject) => Request ...@@ -180,14 +183,16 @@ OnRequestEventCallback = (source: Want, name: string, data: KVObject) => Request
**示例:** **示例:**
```js ```ts
function onRequestListener(source, name, data) { import pluginComponentManager from '@ohos.pluginComponent'
import Want from '@ohos.app.ability.Want';
function onRequestListener(source:Want, name:string, data:pluginComponentManager.KVObject) {
console.error("onRequestListener"); console.error("onRequestListener");
console.log("onRequestListener source=" + JSON.stringify(source)); console.log("onRequestListener source=" + JSON.stringify(source));
console.log("onRequestListener name=" + name); console.log("onRequestListener name=" + name);
console.log("onRequestListener data=" + JSON.stringify(data)); console.log("onRequestListener data=" + JSON.stringify(data));
let RtnData:Record<string,string|pluginComponentManager.KVObject> = { 'template': "ets/pages/plugin.js", 'data': data }
return { template: "ets/pages/plugin.js", data: data }; return RtnData;
} }
``` ```
...@@ -207,7 +212,8 @@ push(param: PushParameters , callback: AsyncCallback&lt;void&gt;): void ...@@ -207,7 +212,8 @@ push(param: PushParameters , callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
```js ```ts
import pluginComponentManager from '@ohos.pluginComponent'
pluginComponentManager.push( pluginComponentManager.push(
{ {
want: { want: {
...@@ -248,7 +254,8 @@ push(param: PushParameterForStage, callback: AsyncCallback&lt;void&gt;): void ...@@ -248,7 +254,8 @@ push(param: PushParameterForStage, callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
```js ```ts
import pluginComponentManager from '@ohos.pluginComponent'
pluginComponentManager.push( pluginComponentManager.push(
{ {
owner: { owner: {
...@@ -296,7 +303,8 @@ request(param: RequestParameters, callback: AsyncCallback&lt;RequestCallbackPara ...@@ -296,7 +303,8 @@ request(param: RequestParameters, callback: AsyncCallback&lt;RequestCallbackPara
**示例:** **示例:**
```js ```ts
import pluginComponentManager from '@ohos.pluginComponent'
pluginComponentManager.request( pluginComponentManager.request(
{ {
want: { want: {
...@@ -339,7 +347,8 @@ request(param: RequestParameterForStage, callback: AsyncCallback&lt;RequestCallb ...@@ -339,7 +347,8 @@ request(param: RequestParameterForStage, callback: AsyncCallback&lt;RequestCallb
**示例:** **示例:**
```js ```ts
import pluginComponentManager from '@ohos.pluginComponent'
pluginComponentManager.request( pluginComponentManager.request(
{ {
owner: { owner: {
...@@ -378,21 +387,23 @@ on(eventType: string, callback: OnPushEventCallback | OnRequestEventCallback ): ...@@ -378,21 +387,23 @@ on(eventType: string, callback: OnPushEventCallback | OnRequestEventCallback ):
**示例:** **示例:**
```js ```ts
function onPushListener(source, template, data, extraData) { import pluginComponentManager from '@ohos.pluginComponent'
import Want from '@ohos.app.ability.Want';
function onPushListener(source:Want, template:PluginComponentTemplate, data:pluginComponentManager.KVObject, extraData:pluginComponentManager.KVObject) {
console.log("onPushListener template.source=" + template.source) console.log("onPushListener template.source=" + template.source)
console.log("onPushListener source=" + JSON.stringify(source)) console.log("onPushListener source=" + JSON.stringify(source))
console.log("onPushListener template=" + JSON.stringify(template)) console.log("onPushListener template=" + JSON.stringify(template))
console.log("onPushListener data=" + JSON.stringify(data)) console.log("onPushListener data=" + JSON.stringify(data))
console.log("onPushListener extraData=" + JSON.stringify(extraData)) console.log("onPushListener extraData=" + JSON.stringify(extraData))
} }
function onRequestListener(source, name, data) { function onRequestListener(source:Want, name:string, data:pluginComponentManager.KVObject) {
console.error("onRequestListener"); console.error("onRequestListener");
console.log("onRequestListener source=" + JSON.stringify(source)); console.log("onRequestListener source=" + JSON.stringify(source));
console.log("onRequestListener name=" + name); console.log("onRequestListener name=" + name);
console.log("onRequestListener data=" + JSON.stringify(data)); console.log("onRequestListener data=" + JSON.stringify(data));
let RtnData:Record<string,string|pluginComponentManager.KVObject> = { 'template': "ets/pages/plugin.js", 'data': data }
return { template: "ets/pages/plugin.js", data: data }; return RtnData;
} }
pluginComponentManager.on("push", onPushListener) pluginComponentManager.on("push", onPushListener)
pluginComponentManager.on("request", onRequestListener) pluginComponentManager.on("request", onRequestListener)
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
## 导入模块 ## 导入模块
```js ```ts
import prompt from '@ohos.prompt' import prompt from '@ohos.prompt'
``` ```
...@@ -29,7 +29,8 @@ showToast(options: ShowToastOptions): void ...@@ -29,7 +29,8 @@ showToast(options: ShowToastOptions): void
**示例:** **示例:**
```js ```ts
import prompt from '@ohos.prompt'
prompt.showToast({ prompt.showToast({
message: 'Message Info', message: 'Message Info',
duration: 2000 duration: 2000
...@@ -72,7 +73,8 @@ showDialog(options: ShowDialogOptions): Promise&lt;ShowDialogSuccessResponse&gt; ...@@ -72,7 +73,8 @@ showDialog(options: ShowDialogOptions): Promise&lt;ShowDialogSuccessResponse&gt;
**示例:** **示例:**
```js ```ts
import prompt from '@ohos.prompt'
prompt.showDialog({ prompt.showDialog({
title: 'Title Info', title: 'Title Info',
message: 'Message Info', message: 'Message Info',
...@@ -90,7 +92,7 @@ prompt.showDialog({ ...@@ -90,7 +92,7 @@ prompt.showDialog({
.then(data => { .then(data => {
console.info('showDialog success, click button: ' + data.index); console.info('showDialog success, click button: ' + data.index);
}) })
.catch(err => { .catch((err:Error) => {
console.info('showDialog error: ' + err); console.info('showDialog error: ' + err);
}) })
``` ```
...@@ -114,7 +116,8 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSucc ...@@ -114,7 +116,8 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSucc
**示例:** **示例:**
```js ```ts
import prompt from '@ohos.prompt'
prompt.showDialog({ prompt.showDialog({
title: 'showDialog Title Info', title: 'showDialog Title Info',
message: 'Message Info', message: 'Message Info',
...@@ -179,7 +182,8 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback&lt;ActionMenu ...@@ -179,7 +182,8 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback&lt;ActionMenu
**示例:** **示例:**
```js ```ts
import prompt from '@ohos.prompt'
prompt.showActionMenu({ prompt.showActionMenu({
title: 'Title Info', title: 'Title Info',
buttons: [ buttons: [
...@@ -225,7 +229,8 @@ showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse ...@@ -225,7 +229,8 @@ showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse
**示例:** **示例:**
```js ```ts
import prompt from '@ohos.prompt'
prompt.showActionMenu({ prompt.showActionMenu({
title: 'showActionMenu Title Info', title: 'showActionMenu Title Info',
buttons: [ buttons: [
...@@ -242,7 +247,7 @@ prompt.showActionMenu({ ...@@ -242,7 +247,7 @@ prompt.showActionMenu({
.then(data => { .then(data => {
console.info('showActionMenu success, click button: ' + data.index); console.info('showActionMenu success, click button: ' + data.index);
}) })
.catch(err => { .catch((err:Error) => {
console.info('showActionMenu error: ' + err); console.info('showActionMenu error: ' + err);
}) })
``` ```
......
...@@ -14,8 +14,9 @@ ...@@ -14,8 +14,9 @@
## 导入模块 ## 导入模块
```js ```ts
import promptAction from '@ohos.promptAction' import promptAction from '@ohos.promptAction';
import { BusinessError } from '@ohos.base';
``` ```
## promptAction.showToast ## promptAction.showToast
...@@ -42,14 +43,18 @@ showToast(options: ShowToastOptions): void ...@@ -42,14 +43,18 @@ showToast(options: ShowToastOptions): void
**示例:** **示例:**
```js ```ts
import promptAction from '@ohos.promptAction'
import { BusinessError } from '@ohos.base';
try { try {
promptAction.showToast({ promptAction.showToast({
message: 'Message Info', message: 'Message Info',
duration: 2000 duration: 2000
}); });
} catch (error) { } catch (error) {
console.error(`showToast args error code is ${error.code}, message is ${error.message}`); let message = (error as BusinessError).message
let code = (error as BusinessError).code
console.error(`showToast args error code is ${code}, message is ${message}`);
}; };
``` ```
...@@ -98,7 +103,9 @@ showDialog(options: ShowDialogOptions): Promise&lt;ShowDialogSuccessResponse&gt; ...@@ -98,7 +103,9 @@ showDialog(options: ShowDialogOptions): Promise&lt;ShowDialogSuccessResponse&gt;
**示例:** **示例:**
```js ```ts
import promptAction from '@ohos.promptAction'
import { BusinessError } from '@ohos.base';
try { try {
promptAction.showDialog({ promptAction.showDialog({
title: 'Title Info', title: 'Title Info',
...@@ -117,11 +124,13 @@ try { ...@@ -117,11 +124,13 @@ try {
.then(data => { .then(data => {
console.info('showDialog success, click button: ' + data.index); console.info('showDialog success, click button: ' + data.index);
}) })
.catch(err => { .catch((err:Error) => {
console.info('showDialog error: ' + err); console.info('showDialog error: ' + err);
}) })
} catch (error) { } catch (error) {
console.error(`showDialog args error code is ${error.code}, message is ${error.message}`); let message = (error as BusinessError).message
let code = (error as BusinessError).code
console.error(`showDialog args error code is ${code}, message is ${message}`);
}; };
``` ```
...@@ -152,7 +161,9 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSucc ...@@ -152,7 +161,9 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSucc
**示例:** **示例:**
```js ```ts
import promptAction from '@ohos.promptAction';
import { BusinessError } from '@ohos.base';
try { try {
promptAction.showDialog({ promptAction.showDialog({
title: 'showDialog Title Info', title: 'showDialog Title Info',
...@@ -175,7 +186,9 @@ try { ...@@ -175,7 +186,9 @@ try {
console.info('showDialog success callback, click button: ' + data.index); console.info('showDialog success callback, click button: ' + data.index);
}); });
} catch (error) { } catch (error) {
console.error(`showDialog args error code is ${error.code}, message is ${error.message}`); let message = (error as BusinessError).message
let code = (error as BusinessError).code
console.error(`showDialog args error code is ${code}, message is ${message}`);
}; };
``` ```
...@@ -231,7 +244,9 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback&lt;ActionMenu ...@@ -231,7 +244,9 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback&lt;ActionMenu
**示例:** **示例:**
```js ```ts
import promptAction from '@ohos.promptAction';
import { BusinessError } from '@ohos.base';
try { try {
promptAction.showActionMenu({ promptAction.showActionMenu({
title: 'Title Info', title: 'Title Info',
...@@ -253,7 +268,9 @@ try { ...@@ -253,7 +268,9 @@ try {
console.info('showActionMenu success callback, click button: ' + data.index); console.info('showActionMenu success callback, click button: ' + data.index);
}) })
} catch (error) { } catch (error) {
console.error(`showActionMenu args error code is ${error.code}, message is ${error.message}`); let message = (error as BusinessError).message
let code = (error as BusinessError).code
console.error(`showActionMenu args error code is ${code}, message is ${message}`);
}; };
``` ```
...@@ -289,7 +306,9 @@ showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse ...@@ -289,7 +306,9 @@ showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse
**示例:** **示例:**
```js ```ts
import promptAction from '@ohos.promptAction';
import { BusinessError } from '@ohos.base';
try { try {
promptAction.showActionMenu({ promptAction.showActionMenu({
title: 'showActionMenu Title Info', title: 'showActionMenu Title Info',
...@@ -307,11 +326,13 @@ try { ...@@ -307,11 +326,13 @@ try {
.then(data => { .then(data => {
console.info('showActionMenu success, click button: ' + data.index); console.info('showActionMenu success, click button: ' + data.index);
}) })
.catch(err => { .catch((err:Error) => {
console.info('showActionMenu error: ' + err); console.info('showActionMenu error: ' + err);
}) })
} catch (error) { } catch (error) {
console.error(`showActionMenu args error code is ${error.code}, message is ${error.message}`); let message = (error as BusinessError).message
let code = (error as BusinessError).code
console.error(`showActionMenu args error code is ${code}, message is ${message}`);
}; };
``` ```
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
## 导入模块 ## 导入模块
```js ```ts
import prompt from '@system.prompt'; import prompt from '@system.prompt';
``` ```
...@@ -33,8 +33,9 @@ showToast(options: ShowToastOptions): void ...@@ -33,8 +33,9 @@ showToast(options: ShowToastOptions): void
**示例:** **示例:**
```js ```ts
export default { import prompt from '@system.prompt';
class A{
showToast() { showToast() {
prompt.showToast({ prompt.showToast({
message: 'Message Info', message: 'Message Info',
...@@ -42,6 +43,7 @@ export default { ...@@ -42,6 +43,7 @@ export default {
}); });
} }
} }
export default new A()
``` ```
...@@ -62,8 +64,9 @@ showDialog(options: ShowDialogOptions): void ...@@ -62,8 +64,9 @@ showDialog(options: ShowDialogOptions): void
**示例:** **示例:**
```js ```ts
export default { import prompt from '@system.prompt';
class B{
showDialog() { showDialog() {
prompt.showDialog({ prompt.showDialog({
title: 'Title Info', title: 'Title Info',
...@@ -74,15 +77,16 @@ export default { ...@@ -74,15 +77,16 @@ export default {
color: '#666666' color: '#666666'
}, },
], ],
success: function(data) { success: (data)=> {
console.log('dialog success callback,click button : ' + data.index); console.log('dialog success callback,click button : ' + data.index);
}, },
cancel: function() { cancel: ()=> {
console.log('dialog cancel callback'); console.log('dialog cancel callback');
}, },
}); });
} }
} }
export default new B()
``` ```
## prompt.showActionMenu<sup>6+</sup> ## prompt.showActionMenu<sup>6+</sup>
...@@ -102,8 +106,9 @@ showActionMenu(options: ShowActionMenuOptions): void ...@@ -102,8 +106,9 @@ showActionMenu(options: ShowActionMenuOptions): void
**示例:** **示例:**
```js ```ts
export default { import prompt from '@system.prompt';
class C{
showActionMenu() { showActionMenu() {
prompt.showActionMenu({ prompt.showActionMenu({
title: 'Title Info', title: 'Title Info',
...@@ -117,15 +122,16 @@ export default { ...@@ -117,15 +122,16 @@ export default {
color: '#000000' color: '#000000'
}, },
], ],
success: function(tapIndex) { success: (tapIndex)=> {
console.log('dialog success callback,click button : ' + tapIndex); console.log('dialog success callback,click button : ' + tapIndex);
}, },
fail: function(errMsg) { fail: (errMsg)=> {
console.log('dialog fail callback' + errMsg); console.log('dialog fail callback' + errMsg);
}, },
}); });
} }
} }
export default new C()
``` ```
## ShowToastOptions ## ShowToastOptions
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
## 导入模块 ## 导入模块
```js ```ts
import router from '@system.router'; import router from '@system.router';
``` ```
...@@ -33,9 +33,10 @@ push(options: RouterOptions): void ...@@ -33,9 +33,10 @@ push(options: RouterOptions): void
**示例:** **示例:**
```js ```ts
// 在当前页面中 // 在当前页面中
export default { import router from '@system.router';
class A{
pushPage() { pushPage() {
router.push({ router.push({
uri: 'pages/routerpage2/routerpage2', uri: 'pages/routerpage2/routerpage2',
...@@ -48,23 +49,21 @@ export default { ...@@ -48,23 +49,21 @@ export default {
}); });
} }
} }
export default new A()
``` ```
```js ```ts
// 在routerpage2页面中 // 在routerpage2页面中
export default { class B{
data: { data:Record<string,string> = {'data1': 'default'}
data1: 'default', data2:Record<string,number[]> = {'data3': [1, 2, 3]}
data2: {
data3: [1, 2, 3]
}
},
onInit() { onInit() {
console.info('showData1:' + this.data1); console.info('showData1:' + this.data.data1);
console.info('showData3:' + this.data2.data3); console.info('showData3:' + this.data2.data3);
} }
} }
export default new B()
``` ```
> **说明:** > **说明:**
...@@ -87,9 +86,10 @@ replace(options: RouterOptions): void ...@@ -87,9 +86,10 @@ replace(options: RouterOptions): void
**示例:** **示例:**
```js ```ts
// 在当前页面中 // 在当前页面中
export default { import router from '@system.router';
class C{
replacePage() { replacePage() {
router.replace({ router.replace({
uri: 'pages/detail/detail', uri: 'pages/detail/detail',
...@@ -99,19 +99,19 @@ export default { ...@@ -99,19 +99,19 @@ export default {
}); });
} }
} }
export default new C()
``` ```
```js ```ts
// 在detail页面中 // 在detail页面中
export default { class Area {
data: { data:Record<string,string> = {'data1': 'default'}
data1: 'default'
},
onInit() { onInit() {
console.info('showData1:' + this.data1) console.info('showData1:' + this.data)
} }
} }
export default new Area()
``` ```
## router.back ## router.back
...@@ -130,57 +130,67 @@ back(options?: BackRouterOptions): void ...@@ -130,57 +130,67 @@ back(options?: BackRouterOptions): void
**示例:** **示例:**
```js ```ts
// index页面 // index页面
export default { import router from '@system.router';
class D{
indexPushPage() { indexPushPage() {
router.push({ router.push({
uri: 'pages/detail/detail' uri: 'pages/detail/detail'
}); });
} }
} }
export default new D()
``` ```
```js ```ts
// detail页面 // detail页面
export default { import router from '@system.router';
class E{
detailPushPage() { detailPushPage() {
router.push({ router.push({
uri: 'pages/mall/mall' uri: 'pages/mall/mall'
}); });
} }
} }
export default new E()
``` ```
```js ```ts
// mall页面通过back,将返回detail页面 // mall页面通过back,将返回detail页面
export default { import router from '@system.router';
class F{
mallBackPage() { mallBackPage() {
router.back(); router.back();
} }
} }
export default new F()
``` ```
```js ```ts
// detail页面通过back,将返回index页面 // detail页面通过back,将返回index页面
export default { import router from '@system.router';
class G{
defaultBack() { defaultBack() {
router.back(); router.back();
} }
} }
export default new G()
``` ```
```js ```ts
// 通过back,返回到detail页面 // 通过back,返回到detail页面
export default { import router from '@system.router';
class H{
backToDetail() { backToDetail() {
router.back({uri:'pages/detail/detail'}); router.back({uri:'pages/detail/detail'});
} }
} }
export default new H()
``` ```
> **说明:** > **说明:**
...@@ -210,12 +220,14 @@ clear(): void ...@@ -210,12 +220,14 @@ clear(): void
**示例:** **示例:**
```js ```ts
export default { import router from '@system.router';
class I{
clearPage() { clearPage() {
router.clear(); router.clear();
} }
} }
export default new I()
``` ```
## router.getLength ## router.getLength
...@@ -234,13 +246,15 @@ getLength(): string ...@@ -234,13 +246,15 @@ getLength(): string
**示例:** **示例:**
```js ```ts
export default { import router from '@system.router';
class J{
getLength() { getLength() {
let size = router.getLength(); let size = router.getLength();
console.log('pages stack size = ' + size); console.log('pages stack size = ' + size);
} }
} }
export default new J()
``` ```
## router.getState ## router.getState
...@@ -259,8 +273,9 @@ getState(): RouterState ...@@ -259,8 +273,9 @@ getState(): RouterState
**示例:** **示例:**
```js ```ts
export default { import router from '@system.router';
class K{
getState() { getState() {
let page = router.getState(); let page = router.getState();
console.log('current index = ' + page.index); console.log('current index = ' + page.index);
...@@ -268,6 +283,7 @@ export default { ...@@ -268,6 +283,7 @@ export default {
console.log('current path = ' + page.path); console.log('current path = ' + page.path);
} }
} }
export default new K()
``` ```
## router.enableAlertBeforeBackPage<sup>6+</sup> ## router.enableAlertBeforeBackPage<sup>6+</sup>
...@@ -286,20 +302,22 @@ enableAlertBeforeBackPage(options: EnableAlertBeforeBackPageOptions): void ...@@ -286,20 +302,22 @@ enableAlertBeforeBackPage(options: EnableAlertBeforeBackPageOptions): void
**示例:** **示例:**
```js ```ts
export default { import router from '@system.router';
class L{
enableAlertBeforeBackPage() { enableAlertBeforeBackPage() {
router.enableAlertBeforeBackPage({ router.enableAlertBeforeBackPage({
message: 'Message Info', message: 'Message Info',
success: function() { success: ()=> {
console.log('success'); console.log('success');
}, },
cancel: function() { cancel: ()=> {
console.log('cancel'); console.log('cancel');
} }
}); });
} }
} }
export default new L()
``` ```
## router.disableAlertBeforeBackPage<sup>6+</sup> ## router.disableAlertBeforeBackPage<sup>6+</sup>
...@@ -318,19 +336,21 @@ disableAlertBeforeBackPage(options?: DisableAlertBeforeBackPageOptions): void ...@@ -318,19 +336,21 @@ disableAlertBeforeBackPage(options?: DisableAlertBeforeBackPageOptions): void
**示例:** **示例:**
```js ```ts
export default { import router from '@system.router';
class Z{
disableAlertBeforeBackPage() { disableAlertBeforeBackPage() {
router.disableAlertBeforeBackPage({ router.disableAlertBeforeBackPage({
success: function() { success: ()=> {
console.log('success'); console.log('success');
}, },
cancel: function() { cancel: ()=> {
console.log('cancel'); console.log('cancel');
} }
}); });
} }
} }
export default new Z()
``` ```
## RouterOptions ## RouterOptions
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册