Package com.inductiveautomation.ignition.gateway.web.nav

Class ReactComponentInfo

java.lang.Object

com.inductiveautomation.ignition.gateway.web.nav.ReactComponentInfo

All Implemented Interfaces:

WebUiComponent

public final class ReactComponentInfo
extends Object
implements WebUiComponent

Represents a front-end react component that can be mounted. Used by extension points to customize the add/edit form UIs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReactComponentInfo.Serializer

Field Summary

Fields

Modifier and Type	Field	Description
static final com.inductiveautomation.ignition.common.gson.JsonObject	SCHEMA

Constructor Summary

Constructors

Constructor	Description
ReactComponentInfo(@NonNull String componentId, @Nullable SystemJsModule module)
ReactComponentInfo(String componentId)

Method Summary

Modifier and Type	Method	Description
String	getComponentId()
Optional<SystemJsModule>	getModule()
WebUiComponentType	getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SCHEMA

public static final com.inductiveautomation.ignition.common.gson.JsonObject SCHEMA

Constructor Details

ReactComponentInfo

public ReactComponentInfo(String componentId)

ReactComponentInfo

public ReactComponentInfo(@NonNull String componentId,
 @Nullable SystemJsModule module)

Method Details

getType

public WebUiComponentType getType()

Specified by:

getType in interface WebUiComponent

getComponentId

public String getComponentId()

getModule

public Optional<SystemJsModule> getModule()

Specified by:

getModule in interface WebUiComponent

Returns:

The SystemJS module that should be mounted in order for the component to be rendered, if any. Components that are built into the core platform js modules don't require this and should return empty.