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