redux weapp

redux-weapp

Wechat アプレット (微信小程序、weapp) 用の Redux ベースの状態管理。Redux ストアを Weapp のアプリまたはページのライフサイクルに接続します。

インストール

 # via Github
npm install xixilive/redux-weapp --save-dev

# via npm
npm install redux-weapp --save-dev

# via yarn
yarn add -D redux-weapp

建てる

git clone https://github.com/xixilive/redux-weapp.git 
  && cd redux-weapp 
  && yarn 
  && yarn build

使用法

これらのデモ コード スニペットを試す前に、weapp モジュール化開発の経験がある必要があります。 微信小程序模块化开発行实練習

 // Redux store
import { createStore } from 'redux'
//create your Redux store
const store = createStore ( ... ) 

weappアプリに接続する

 import connect from 'redux-weapp'
const config = connect . App (
  store ,
  //to map next state into your app
  ( state ) => {
    // must return an object, which will be passed to onStateChange function
    return { }
  } ,
  // to bind dispatch with your action,
  // and this binding will be injected into your app object.
  ( dispatch ) => {
    // return an object, which can be invoked within app context(this scope).
    return { }
  }
) ( {
  onLaunch ( options ) { } ,
  //...,
  onStateChange ( nextState , prevState , initFlag ) {
    this . setData ( { ... this . data , ... nextState } )
  }
} )

// construct your app
App ( config )

weappページに接続します

次のような店舗形状があると仮定します。

{
  "todos" : [
    {
      "title" : " String " ,
      "complete" : " Boolean "
    }
  ]
}

そしてアクションクリエーター(FSA)を次のように定義しました:

 const fetchTodosAction = ( status ) => ( { type : 'FETCH_TODOS' , filter : { status } } )

OK、ストアを todo リスト ページに接続しましょう。

 // 
import connect from 'redux-weapp'

const config = connect . Page (
  store ,
  //to map next-state into your page
  ( state ) => ( { todos : state . todos } ) ,

  // to bind dispatch with your action creators,
  // and this binding will be injected into your page object
  ( dispatch ) => ( {
    fetchTodos ( status = 'inprogress' ) {
      // dispatch an action
      dispatch ( fetchTodosAction ( status ) )
    }
  } )
) ( {
  onLoad ( options ) {
    this . fetchTodos ( 'inprogress' )
  } ,
  
  onStateChange ( nextState , prevState , initFlag ) {
    const { todos } = nextState
    this . setData ( { todos } ) // to update UI
  } ,

  // view interactions
  onTapCompleteTab ( ) {
    this . fetchTodos ( 'complete' )
  } ,

  onTapInProgressTab ( ) {
    this . fetchTodos ( 'inprogress' )
  }
} )

// construct your page
Page ( config ) 

APIを接続する

接続アプリ

 //define app connect function
factory = connect . App (
  store : ReduxStore , 
  mapStateToProps : Function ( state : Object ) , 
  mapDispatchToProps : Function ( dispatch : Function )
) : Function

//build a store-binding app config object
config = factory ( {
  onLaunch ( options : Object ) { } ,
  onStateChange ( nextState : Object , prevState : Object , initFlag : Any ) ,
  //...
} ) : Object

//launch app with store-binding config
App ( config )

接続ページ

 //define page connect function
factory = connect . Page (
  store : ReduxStore , 
  mapStateToProps : Function ( state : Object ) , 
  mapDispatchToProps : Function ( dispatch : Function )
) : Function

//build a store-binding page config object
config = factory ( {
  onLoad ( options : Object ) { } ,
  onStateChange ( nextState : Object , prevState : Object , initFlag : Any )
  //...
} ) : Object

//start page instance with store-binding config
Page ( config )

onStateChange関数

 // would be called after each concerned state changed
onStateChange ( nextState : Object , prevState : Object , initFlag : Any ) : void

• initFlag : [email protected]からの新機能。詳細については、「変更点」セクションを参照してください。

v0.2.xからの変更点

connect.App API

• mapState関数からappLaunchOptions引数を削除しました。

 // v0.1.x
connect . App ( {
  store : ReduxStore ,
  mapState : Function ( state : Object , appLaunchOptions : Object ) : Object ,
  mapDispatch : Function ( dispatch : Function ) : Object ,
} )

// v0.2.x
connect . App ( {
  store : ReduxStore ,
  mapState : Function ( state : Object ) : Object ,
  mapDispatch : Function ( dispatch : Function ) : Object ,
} )

connect.Page API

• mapState関数からpageLoadOptions引数を削除しました。

 // v0.1.x
connect . Page ( {
  store : ReduxStore ,
  mapState : Function ( state : Object , pageLoadOptions : Object ) : Object ,
  mapDispatch : Function ( dispatch : Function ) : Object ,
} )

// v0.2.x
connect . Page ( {
  store : ReduxStore ,
  mapState : Function ( state : Object ) : Object ,
  mapDispatch : Function ( dispatch : Function ) : Object ,
} )

onStateChangeコールバック

• initFlag 3 番目の引数として追加します。これは、最初のディスパッチ時のみ文字列値INIT_SYNCにすることができます。それ以外の場合はundefined 。

 // v0.1.x
onStateChange ( nextState : Object , prevState : Object )

// v0.2.x
onStateChange ( nextState : Object , prevState : Object , initFlag : Any ) 

ライフサイクル

weappアプリ用

• onLaunch

onLaunch関数が呼び出されたときにサブスクライブ リスナーをセットアップすると、ストアの初期状態がブロードキャストされます。

• onShow

非アクティブなリスナーは、 onShow関数が呼び出されたときにactiveに設定され、リスナーは最後の状態で呼び出されます。

• onHide

onHide関数が呼び出された場合、アクティブなリスナーはinactiveに設定されます。

weappページ用

• onLoad

onLoad関数が呼び出されたときにサブスクライブ リスナーをセットアップすると、ストアの初期状態がブロードキャストされます。

• onShow

非アクティブなリスナーは、 onShow関数が呼び出されたときにactiveに設定され、リスナーは最後の状態で呼び出されます。

• onHide

onHide関数が呼び出された場合、アクティブなリスナーはinactiveに設定されます。

• onUnload

onUnload関数が呼び出されると、リスナーは削除されます。

---

幸運を！