<style>
.subjectTitle { font-size: 1.15em;}
</style>

## Webview

### hysdk.webview.push

<h4 class="subjectTitle">功能</h4>

打开新的 webview

<h4 class="subjectTitle">环境</h4>

| 平台 | 版本 | 
|-----|-----|
| iOS | |
| Android | |
| touch | 不支持 |
| 微信 | 不支持 |

<h4 class="subjectTitle">参数</h4>

| 参数 | 类型 | 描述 | 必选 | 默认值 | 备注 |
|-----|-----|-----|-----|-----|-----|
| url | string | webview 的地址 | Y | 无 | |
| name | string | webview 的名称/标识 | N | TODO | 推荐使用 `hy_hybridId_页面名称` 的格式，一般场景无需指定，如果要回退到特定 webview 时可以通过该参数来指定 webview |
| animate | string | webview 打开动画 | N | rignt | 包括：`right`（从右侧滑入）、`bottom`（从底部滑入）、`none`。默认为 `rignt` |
| naviBar | object | webview 导航栏配置 | N | - | 导航栏配置只提供基础的配置参数，更复杂的配置可以通过 `navigator.refresh` 来配置 |
| naviBar.type | string | 导航栏类型 | N | TODO | 包括：`none`（无导航栏）、`classical-blue`（蓝色）、`classical-white`（白色）、`custom`（自定义颜色），默认为 XXX |
| naviBar.color | string | 导航栏颜色，rgb | N | TODO  | 当 naviBar.type 为 `custom` 时， 指定导航栏的颜色
| naviBar.title | string | 导航栏标题 | N | TODO  | |
| options | object | 额外配置 | N | - |
| options.showLoading | bool | 是否显示 loading | N | true | |
| callback | function | 返回到当前页时的回调 | N | 无 | **iOS 通过后退手势返回到当前页时不会触发，可以通过 `hysdk.webview.enableBackGuesture` 来设置是否允许后退手势** |

<h4 class="subjectTitle">示例</h4>

```javascript
hysdk.webview.push({
    url: 'https://address.of.target.url/',
    name: 'nameOfView', // 建议格式：hy_模块名_页面名
    animate: 'bottom',
    naviBar: {
        type: 'classical-blue',
        color: '#ffffff',
        title: '标题'
    },
    options: {
        showLoading: false
    },
    callback: function(data) {
        // 回到当前页面时的回调
        // iOS 通过后退手势返回到当前页时不会触发
        // 可以通过 hysdk.webview.enableBackGuesture 来设置是否允许后退手势
    },
    success: function() {},
    fail: function() {}
});
```

### hysdk.webview.pop

<h4 class="subjectTitle">功能</h4>

回退到指定的 webview，如果不指定 `name`，则回到上一个页面。

<h4 class="subjectTitle">环境</h4>

| 平台 | 版本 | 
|-----|-----|
| iOS | |
| Android | |
| touch | 不支持 |
| 微信 | 不支持 |

<h4 class="subjectTitle">参数</h4>

| 参数 | 类型 | 描述 | 必选 | 默认值 | 备注 |
|-----|-----|-----|-----|-----|-----|
| name | string | 回退的页面名称 | N | 无 | 非必填，比如不填则回到上一个页面 |
| data | object | 传递给回退页面的参数 | N | 无 |  |

<h4 class="subjectTitle">示例</h4>

```javascript
hysdk.webview.pop({
    name: 'hy_hybridId_页面名称',
    data: {},
    success: function() {},
    fail: function() {}
});
```

### hysdk.webview.showLoading

<h4 class="subjectTitle">功能</h4>

显示/隐藏 native 的 loading，会覆盖整个 webview。新打开 webview 时如果有 loading，此时不需要再手动关闭。

<h4 class="subjectTitle">环境</h4>

| 平台 | 版本 | 
|-----|-----|
| iOS | |
| Android | |
| touch | 不支持 |
| 微信 | 不支持 |

<h4 class="subjectTitle">参数</h4>

| 参数 | 类型 | 描述 | 必选 | 默认值 | 备注 |
|-----|-----|-----|-----|-----|-----|
| show | bool | 显示/隐藏 | Y | 无 | `true`：显示；`false`：隐藏。 |

<h4 class="subjectTitle">示例</h4>

```javascript
hysdk.webview.showLoading({
    show: false,
    success: function() {},
    fail: function() {}
});
```

### hysdk.webview.enableBackGuesture

<h4 class="subjectTitle">功能</h4>

启用/禁用后退手势，仅 iOS 有效。

<h4 class="subjectTitle">环境</h4>

| 平台 | 版本 | 
|-----|-----|
| iOS | |
| Android | 不支持 |
| touch | 不支持 |
| 微信 | 不支持 |

<h4 class="subjectTitle">参数</h4>

| 参数 | 类型 | 描述 | 必选 | 默认值 | 备注 |
|-----|-----|-----|-----|-----|-----|
| enable | bool | 启用/禁用 | Y | 无 | `true`：启用；`false`：禁用。|

<h4 class="subjectTitle">示例</h4>

```javascript
hysdk.webview.enableBackGuesture({
    enable: false,
    success: function() {},
    fail: function() {}
});
```

### hysdk.webview.setName

<h4 class="subjectTitle">功能</h4>

设置 webview 名称，推荐使用 `hy_hybridId_页面名称` 的格式。

<h4 class="subjectTitle">环境</h4>

| 平台 | 版本 | 
|-----|-----|
| iOS | |
| Android | |
| touch | 不支持 |
| 微信 | 不支持 |

<h4 class="subjectTitle">参数</h4>

| 参数 | 类型 | 描述 | 必选 | 默认值 | 备注 |
|-----|-----|-----|-----|-----|-----|
| name | string | webview 名称 | Y | 无 | 推荐使用 `hy_hybridId_页面名称` 的格式 |

<h4 class="subjectTitle">示例</h4>

```javascript
hysdk.webview.setName({
    name: 'hy_hybridId_页面名称',
    success: function() {},
    fail: function() {}
});
```
