README.en-US.md

Uni API is a cross-terminal API solution that supports applets and web containers.

---

🎉 Multi-container support Currently supports Web, WeChat Mini Programs, Toutiao Mini Programs, Ali Mini Programs, Baidu Smart Programs and Kuaishou Mini Programs 🐂 Rich API Cover 90+ API implementations 😯 Complete documentation Provide bilingual documents and rich samples 0️⃣ No framework dependency No framework dependency, pure native implementation, compatible with any framework 🚀 Extreme volume Support on-demand loading, eliminate useless code according to the environment 👍🏻 Easy to use, fast access Provide a complete Typescripts statement, so you can get rid of the documentation and immerse yourself in programming

Quick start

Take @uni/toast as an example

$ npm install @uni/toast

import { showToast } from '@uni/toast';

// string
showToast('Hi');

// object
showToast({
  content: 'hello',
  type: 'success',
  duration: 1000,
  success: () => {
    console.log('toast')
  }
});

// promise
showToast({
  content: 'hello',
  type: 'success',
  duration: 1000,
}).then(() => {});

Docs

Official site: https://universal-api.js.org/

Example

Wechat MiniProgram

Alibaba MiniApp

Contribute code

Please read Rax Contribution Code Guide, Understand the basic specifications.

Get started

$ git clone [email protected]:raxjs/universal-api.git
$ npm install
$ npm run build

Debug API

Take @uni/toast as an example:

$ npm run build toast
$ npm run build:demo
$ cd demos
$ npm i
$ npm run start # 启动项目，打开小程序 IDE 进行调试

Protocol

BSD License