ChainGraph API Documentation / @badaitech/chaingraph-types / PortVisibility

Function: PortVisibility()

PortVisibility(config): PropertyDecorator

Defined in: packages/chaingraph-types/src/decorator/port-visibility.decorator.ts:133

Decorator for defining conditional visibility rules for ports

This decorator allows you to specify a condition function that determines when a port should be visible. The condition is evaluated whenever the node receives an event.

Example usage:

class MyNode extends BaseNode {
  @Input()
  @PortString({
    title: 'Mode',
  })
  mode: string = 'replace';

  @PortVisibility({
    showIf: (node) => (node as MyNode).mode === 'replace'
  })
  @Input()
  @PortString({
    title: 'Replacement Text'
  })
  replacementText: string = '';
}

Parameters

config

PortVisibilityConfig

Configuration object for visibility rules

Returns

PropertyDecorator