universal api

Uni API 是一套支援小程式和Web 容器的跨端API 解決方案。

---

?多容器支援目前支援Web、微信小程式、頭條小程式、阿里小程式、百度小程式、快手小程式

? API 豐富覆蓋90+ API 實現

?文件完善提供雙語文件、豐富範例

0️⃣無框架依賴無框架依賴，純原生實現，相容於任意框架

極致體積支援按需加載，按環境剔除無用程式碼

??簡易使用，快速存取提供完善的TypeScript 聲明，讓你可以擺脫文檔，沉浸編程

快速使用

以@uni/toast 為例

$ 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 ( ( ) => { } ) ; 

文件

官方網站：https://universal-api.js.org/

範例

微信小程式	支付寶小程式

貢獻程式碼

請先閱讀Rax 貢獻程式碼指南，以了解基礎的規格。

起步

$ git clone [email protected]:raxjs/universal-api.git
$ yarn
$ yarn build

偵錯API

$ yarn demo:init
$ yarn demo:dev

然後使用小程式IDE 即可開始偵錯:

更新版本

API package 版本統一維護在根目錄下的api-config.js，以@uni/toast 為例：

 module . exports = {
  toast : {
    path : 'src/packages/interactive/toast/src/index.ts' ,
    pkgInfo : [
      {
        version : '1.0.5' ,
        name : '@uni/toast' ,
      } ,
    ] ,
  } ,
}

參數	意義	預設值
path	在來源檔案的路徑	-
pkgInfo	npm套件的屬性（同packagejson寫法）	-
needCommonUtil	是否需要公共utils	true
unNeedSplit	是否需要安環境分包	false

大套件版本需要更新根目錄下的package.json 的version

協定

BSD License