Store
Manage Flex UI redux store
getFlexMiddleware(arg?, enableReduxLogging?) => Array<Middleware>#
Returns a list of the Flex middleware
Parameters:
arg?: History | HistoryType | HistoryParamsinstance of History, type of a history (memory, browser) or parameters for getHistory() function
enableReduxLogging?: booleanIf redux logging should be enabled
Returns:
Array<Middleware>List of Flex middleware to be passed to a new Redux store
Example:
const myReduxStore = configureStore({ reducer: { app: myReducer, flex: Flex.FlexReducer, }, middleware: (getDefaultMiddleware) => getDefaultMiddleware({ serializableCheck: false, immutableCheck: false, }).concat([...Flex.getFlexMiddleware()]), enhancers: [ Flex.flexStoreEnhancer ]})applyFlexMiddleware(arg?, enableReduxLogging?) => StoreEnhancer#
Applies Flex middleware to redux store. @reduxjs/toolkit has deprecated the createStore API. In order to adapt to the change, please
use getFlexMiddleware instead, paired with the newer Redux API configureStore.
Parameters:
arg?: History | HistoryType | HistoryParamsinstance of History, type of a history (memory, browser) or parameters for getHistory() function
enableReduxLogging?: booleanIf redux logging should be enabled
Returns:
StoreEnhancerStoreEnhancer
Example:
const myReduxStore = createStore( reducers, compose( applyFlexMiddleware() ));Îimport createMemoryHistory from "history/createMemoryHistory";const history = createMemoryHistory();const myReduxStore = createStore( reducers, compose( applyFlexMiddleware(history) ));FlexReducer(state, action) => AppState#
Flex reducer for Redux store. Use key flex in your redux store for Flex state.
Parameters:
state: AppStatestate of the application
action: anyAction
Returns:
AppStateFlex state
Example:
import { FlexReducer, applyFlexMiddleware} from "@twilio/flex-ui";const reducers = combineReducers({ flex: FlexReducer, myApp: myAppReducer // application reducer});const myReduxStore = createStore( reducers, compose( applyFlexMiddleware() ));flexStoreEnhancer(originalCreateStore) => EnhancedStore#
Store enhancer which allows the user to add any additional reducers after the store has been created.
Parameters:
originalCreateStore: anythe original create store
Returns:
EnhancedStoreIt returns enhanced store with an additional
addReducermethod.addReducer?: function- Function used to add reducer to an already created store.
Example:
Import Flex from "@twilio/flex-ui";const myReduxStore = createStore( reducers, compose( applyFlexMiddleware(), Flex.flexStoreEnhancer // <-- Add enhancer part of compose ));
Flex.Manager.create(configuration, myReduxStore as any).then(manager => { ReactDOM.render( <Redux.Provider store={myReduxStore}> <Flex.ContextProvider manager={manager}> <Flex.RootContainer /> </Flex.ContextProvider> </Redux.Provider>, container );});