ReduxStoreExtension
Interface
The extension interface for ReduxStore extension point.
Properties
Property | Type | Notes |
---|---|---|
() => string[] | ||
() => any | ||
() => (localState: any, action: any, state: IMState) => any | ||
() => string | ||
string | The unique id. For widget's provided extension, the id pattern is: widgetId + extensionName | |
number | If an extension point supports multiple extensions, the index is used to determine the extension order. | |
string | The extension name. | |
string | The widget id that provides the extension. No widget id means the extension is provided by Jimu. |
getInitLocalState
Interface PropertygetInitLocalState: () => any
Type declaration
function(): any
The method that returns the redux initial store state.
Returns
any
getReducer
Interface PropertygetReducer: () => (localState: any, action: any, state: IMState) => any
Type declaration
function(): (localState: any, action: any, state: IMState) => any
The method that returns the redux reducer. The reducer should return local state.
Returns
(localState: any, action: any, state: IMState) => any
function(localState: any, action: any, state: IMState): any
Parameters
Parameter | Type |
---|---|
local | any |
action | any |
state | IMState |
Returns
any
getStoreKey
Interface PropertygetStoreKey: () => string
Type declaration
function(): string
The method that returns the redux store key. The key supports this format: a.b.c.
Returns
string
id
id: string
The unique id. For widget's provided extension, the id pattern is: widgetId + extensionName
index
index: number
If an extension point supports multiple extensions, the index is used to determine the extension order.
widgetId
widgetId: string
The widget id that provides the extension. No widget id means the extension is provided by Jimu.
getActions: () => string[]
Type declaration
function(): string[]
The method that returns the redux actions.
Returns
string[]