Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

DARTWIC UI Components

Use higher-level components that follow DARTWIC interaction and styling conventions.

ExportImport pathDescription
AbstractedButtonNodeConfig@dartwic/interface-sdk/uiConfigure an abstracted schematic button node.
buildChannelFieldPayload@dartwic/interface-sdk/uiBuild a channel-field payload from a value reference and optional field.
buildControlDisplayNodeDefinitionFromChannel@dartwic/interface-sdk/uiCreate a control-display schematic node definition from channel data.
buildParameterDisplayNodeDefinitionFromChannel@dartwic/interface-sdk/uiCreate a parameter-display schematic node definition from channel data.
ChannelComboBox@dartwic/interface-sdk/uiSelects a DARTWIC channel and, optionally, one of its fields.
ChannelComboBoxProps@dartwic/interface-sdk/uiProps for the host channel and field selector.
ComboboxSearch@dartwic/interface-sdk/uiSearches a fixed option list using DARTWIC’s standard host-owned combobox.
ComboboxSearchItem@dartwic/interface-sdk/uiOne searchable option displayed by the host-owned combobox.
ComboboxSearchProps@dartwic/interface-sdk/uiProps for the standard host-owned searchable list selector.
ConfigurableInput@dartwic/interface-sdk/uiEdits a configurable literal, channel reference, or expression value.
ConfigurableInputProps@dartwic/interface-sdk/uiProps for editing a serialized configurable-input expression.
ConsoleAlert@dartwic/interface-sdk/uiDisplay an alert in the host console presentation.
ConsoleAlertProps@dartwic/interface-sdk/uiLinks active ARGUS alerts for the supplied channels.
convertChannelReferenceToChannelName@dartwic/interface-sdk/uiConverts a value reference such as |channel| into its channel name.
EmbeddedRemoteView@dartwic/interface-sdk/uiEmbed a remote engine view using the host component.
EmbeddedRemoteViewProps@dartwic/interface-sdk/uiRemote view embedded in a plugin resource or schematic.
EmbeddedSchematicNode@dartwic/interface-sdk/uiEmbed a schematic node using the host component.
EmbeddedSchematicNodeProps@dartwic/interface-sdk/uiOne remote schematic node embedded in a plugin view.
getChannelValueFromChannels@dartwic/interface-sdk/uiResolve a value reference against a channel-data map.
getParticipantAccentColor@dartwic/interface-sdk/uiReturn the host accent color assigned to a client identity.
IfElseBlock@dartwic/interface-sdk/uiEdit conditional branch configuration with the host component.
ifElseBlockCheck@dartwic/interface-sdk/uiEvaluate conditional block data against supplied channel values.
IfElseBlockProps@dartwic/interface-sdk/uiEdits a conditional configuration block.
ManualRefreshButton@dartwic/interface-sdk/uiRenders the standard refresh icon button with an in-progress state.
ManualRefreshButtonProps@dartwic/interface-sdk/uiProps for the standard refresh icon button.
ModuleConnectionStatus@dartwic/interface-sdk/uiRenders the shared live connection indicator for an opted-in module.
ModuleConnectionStatusProps@dartwic/interface-sdk/uiProps for the shared opt-in module connection indicator.
ModuleInstanceConnection@dartwic/interface-sdk/uiRenders the standard task-detail module selector, resource link, and live connection state.
ModuleInstanceConnectionProps@dartwic/interface-sdk/uiShared module selector, module link, and opt-in live connection status.
ModuleInstanceSelect@dartwic/interface-sdk/uiSelects only module instances owned by the requested plugin and compatible module types.
ModuleInstanceSelectProps@dartwic/interface-sdk/uiProps for selecting a live module instance compatible with a plugin task.
ModuleRuntimeChannel@dartwic/interface-sdk/uiOne live channel rendered beneath a linked module task.
ModuleRuntimeOverview@dartwic/interface-sdk/uiShows linked tasks, state, channels and measured frequency. Start, Stop and Hold require a connected administrator and two clicks within four seconds; rebuilding disables them. Writes request changes asynchronously; live telemetry reports state separately.
ModuleRuntimeOverviewProps@dartwic/interface-sdk/uiProps for the standard linked-task, status, and channel overview on module pages.
normalizeLegacyChannelFieldReference@dartwic/interface-sdk/uiNormalize a legacy channel and field reference using host rules.
ResourceParticipantsIcon@dartwic/interface-sdk/uiShow the participants associated with a resource.
ResourceStatusIconProps@dartwic/interface-sdk/uiResource identity for the host presence and sync status icons.
ResourceSyncStatusIcon@dartwic/interface-sdk/uiShow resource synchronization status.
StaleChannelsTooltip@dartwic/interface-sdk/uiDisplay details about stale channel data.
StaleChannelsTooltipProps@dartwic/interface-sdk/uiShows stale or missing channel context.
TaskBinding@dartwic/interface-sdk/uiOne editable row in the standard task channel-binding table.
TaskBindingTable@dartwic/interface-sdk/uiRenders the standard editable task channel-binding table.
TaskBindingTableProps@dartwic/interface-sdk/uiStandard task binding table shared by plugin task editors.