@auraxy/cef-bridge/README.md

cefCore, boundAsync, cefEnviroment, cefPopupEnvironment, cefJsWebBridge

# @auraxy/cef-bridge
[![NPM Version](http://img.shields.io/npm/v/@auraxy/cef-bridge.svg?style=flat-square)](https://www.npmjs.com/package/@auraxy/cef-bridge)
[![Download Month](http://img.shields.io/npm/dm/@auraxy/cef-bridge.svg?style=flat-square)](https://www.npmjs.com/package/@auraxy/cef-bridge)
![gzip with dependencies: kb](https://img.shields.io/badge/gzip--with--dependencies-kb-brightgreen.svg "gzip with dependencies: kb")
![typescript](https://img.shields.io/badge/typescript-supported-blue.svg "typescript")
![pkg.module](https://img.shields.io/badge/pkg.module-supported-blue.svg "pkg.module")

> `pkg.module supported`, which means that you can apply tree-shaking in you project

cefCore, boundAsync, cefEnviroment, cefPopupEnvironment, cefJsWebBridge

如果是从 1.0.0 迁移到 2.0.0 以上版本请注意接口名称的变化，将所有相关变动的接口名一并修改掉

## repository
https://git.yipiaoyun.com/front/cef-bridge.git

## Demo
https://git.yipiaoyun.com/front/cef-bridge#readme

## Run Example
Your can see the usage by run the example of the module, here is the step:

1. Clone the library `git clone https://git.yipiaoyun.com/front/cef-bridge.git`
2. Go to the directory `cd your-module-directory`
3. Install npm dependencies `npm i`(use taobao registry: `npm i --registry=http://registry.npm.taobao.org`)
4. Open service `npm run dev`
5. See the example(usually is `http://127.0.0.1/examples/test.html`) in your browser

## Installation
```bash
npm i -S git+ssh://git@git.yipiaoyun.com:front/cef-bridge.git[#tagName]
```

## Global name
`CefBridge`

## Interface
See in [index.d.ts](./index.d.ts)

## Usage
```js
import * as CefBridge from '@auraxy/cef-bridge'
```

Use in html, see what your can use in [CDN: unpkg](https://unpkg.com/@auraxy/cef-bridge/lib/umd/)
```html
<-- use what you want -->
<script src="https://unpkg.com/@auraxy/cef-bridge/lib/umd/<--module-->.js"></script>
```