@stackhouseos/flow-client
TypeScript icon, indicating that this package has built-in type declarations

1.0.5-beta • Public • Published

Flow client lib

Libreria per la visualizzazione del flow nel progetto, basato sugli elements generati dal builder

Setup

Aggiungi ai tuoi reducer il flow

import { flowReducer } from '@stackhouseos/flow-client'

export default combineReducers({
  flow: flowReducer,
})

Aggiungi alle tue saghe

import { flowSaga } from '@stackhouseos/flow-client'

export default function* root() {
  yield all(
    [
      flowSaga(),
    ]
  )
}

Esempio

import Flow from '@stackhouseos/flow-client'

<Flow 
  elements={[/*elements from flow builder*/]} 
  name={'login'} 
  reducerName={`users`}
 />

CurrentStep.js

Props

flowName
  • required: true
  • type: string
reducerName
  • required: false
  • type: string
prefix
  • required: true
  • type: string
parentFlow
  • required: false
  • type: string

Flow.js

FlowClient

Props

elements
  • required: false
  • type: instanceOf

Elementi come da export del builder.

name
  • required: false
  • type: string

Nome del flow, es. login

startId
  • required: false
  • type: string

Nome del flow, es. login

reducerName
  • required: false
  • type: string

Nome del nodo di partenza

parentFlow
  • required: false
  • type: string

Nome flow che contiene questo flow,

reloadKey
  • required: false
  • type: any
extraContext
  • required: false
  • type: instanceOf
destroyOnUnmount
  • required: false
  • type: bool

Readme

Keywords

none

Package Sidebar

Install

npm i @stackhouseos/flow-client

Weekly Downloads

1

Version

1.0.5-beta

License

ISC

Unpacked Size

132 kB

Total Files

26

Last publish

Collaborators

  • stackhouseos