WidgetStaticMethods

Interface

The static methods of a widget.

Properties

PropertyTypeNotes
(configany) => any

A widget can just save partial of its config in an app config. In the runtime, the widget can use this function to get the full config.

(stateIMState, ownPropsPartial<AllWidgetProps<any>>) => any

If a widget needs more state, it can use this function to map the state to the props.

The version manager of a widget (optional)

getFullConfig

optional
Interface Property
getFullConfig: (configany) => any

A widget can just save partial of its config in an app config. In the runtime, the widget can use this function to get the full config.

Type declaration
    function(configany): any
    Parameters
    ParameterTypeNotes
    config
    any

    The config saved in the app config

    Returns 
    any

    The full config

mapExtraStateProps

optional
Interface Property
mapExtraStateProps: (stateIMState, ownPropsPartial<AllWidgetProps<any>>) => any

If a widget needs more state, it can use this function to map the state to the props.

Type declaration
    function(stateIMState, ownPropsPartial<AllWidgetProps<any>>): any
    Parameters
    ParameterTypeNotes
    state
    IMState

    The app state

    ownProps
    Partial<AllWidgetProps<any>>

    The widget props

    Returns 
    any

versionManager

optional
Interface Property
versionManager: BaseVersionManager<any>

The version manager of a widget (optional)

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.