https://github.com/wechat-miniprogram/kbone-api

https://github.com/wechat-miniprogram/kbone-api

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/wechat-miniprogram/kbone-api
• Owner: wechat-miniprogram
• License: mit
• Created: 2020-03-25T06:41:43.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-06-10T14:38:08.000Z (over 4 years ago)
• Last Synced: 2024-10-31T11:37:07.807Z (12 days ago)
• Language: TypeScript
• Size: 165 KB
• Stars: 73
• Watchers: 4
• Forks: 12
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## kbone-api

**kbone-api**是一个能同时支持 小程序和 web 开发的多端 api 库。

## 特性

* 针对基于 kbone 的多端开发，满足在 Web 上直接使用小程序相关 api

* 不依赖 kbone 和 kbone-ui，一个无依赖的小程序 api 的跨端库

* 完整对齐 [wx[apis]](https://developers.weixin.qq.com/miniprogram/dev/api/)

* 同时支持 promise 化和 callback 调用

## 快速上手

下载 kbone-api

```

npm install kbone-api

```

通过模块的方式直接导出模块并使用：

```js

import kboneAPI from 'kbone-api'

kboneAPI.request()

kboneAPI.showToast()

kboneAPI.showModal()

```

为了方便 Vue 开发，可以直接使用 Vue.use(kboneAPI) 来设置全局对象.

```js

# main.js

import Vue from 'vue'

Vue.use(kboneAPI)

# logic code

export default {

    name: "LoginComponents",

    methods: {

        gotologin() {

            return this.$api.login().then(() => {

                this.$api.showToast({

                    title: "登录成功",

                })

            })

        },

        getSetting() {

            // 获取用户设置

            return this.$api.getSetting()

                .then(res => {

                    this.$api.showToast({

                        title: res.nickName || "零度的田"

                    })

                })

        }

    }

}

```

## 文档

所有 api 使用对齐小程序 api，具体内容可以参考 [小程序 api](https://developers.weixin.qq.com/minigame/dev/api/)。

线上体验地址为：[api/ui/](https://wechat-miniprogram.github.io/api/ui/#/)

## LICENSE

MIT