Skip to main content

@blockly/block-dynamic-connection

Built with Blockly​

A group of Blockly blocks that add and remove connections dynamically.

Installation​

npm install @blockly/block-dynamic-connection --save

Usage​

import * as Blockly from 'blockly';
import * as BlockDynamicConnection from '@blockly/block-dynamic-connection';

const myWorkspace = Blockly.inject({
// options...
plugins: {
connectionPreviewer:
BlockDynamicConnection.decoratePreviewer(
// Replace with a custom connection previewer, or remove to decorate
// the default one.
Blockly.InsertionMarkerPreviewer,
),
},
};

// Add the change listener so connections will be finalized on deletion.
workspace.addChangeListener(BlockDynamicConnection.finalizeConnections);

API​

  • overrideOldBlockDefinitions: Replaces the Blockly default blocks with the dynamic connection blocks. This enables projects to use the dynamic block plugin without changing existing XML/JSON.

Blocks​

  • dynamic_text_join replaces text_join
  • dynamic_list_create replaces lists_create_with
  • dynamic_if replaces controls_if

License​

Apache 2.0

A group of blocks that add connections dynamically.

Functions​

FunctionDescription
blockIsDynamicA type guard that checks if the given block fulfills the DynamicBlock interface.
decoratePreviewerReturns a connection previewer constructor that decorates the passed constructor to add connection previewing.
finalizeConnectionsFinalizes connections when certain events (such as block deletion) are detected.
overrideOldBlockDefinitions-