multiselect-blockly

A Blockly plugin that allows for simultaneous selection and manipulation of multiple top-level blocks. Common operations include copy, paste, delete, duplicate, expand, collapse, inline, arrange--The usual Blockly actions, but for more than one block. Block settings such as movable, editable, and deletable may also be toggled on or off using the the same set of context menu actions.

To activate multiselect mode, shift-click on a block or use the rectangular selection tool (shift-click-drag on background). Selected blocks will appear grey. Clicking on the background or any unselected block will deactivate multiselect mode.

Shift-click

Rectangle selection

Customizable context menu

Installation

npm

npm install @rshaker/multiselect-blockly

unpkg

<script src="https://unpkg.com/@rshaker/multiselect-blockly/dist/multiselect.js"></script>

Usage

The following examples show how to inject the plugin into a Blockly workspace.

Using node:

import * as Blockly from "blockly/core";
import { MultiselectPlugin } from "@rshaker/multiselect-blockly";

const workspace = Blockly.getMainWorkspace();
const plugin = new MultiselectPlugin({}, workspace);

plugin.init();

See test/workspace/index.ts for a complete example, the live demo is here.

Using a browser:

<div id="blocklyDiv"></div>

<script src="https://unpkg.com/[email protected]/blockly.min.js"></script>
<script src="https://unpkg.com/@rshaker/multiselect-blockly/dist/multiselect.js"></script>

<script>
    function createWorkspace(blocklyDiv, options) {
        const optionsMgr = multiselect.OptionsMgr.getInstance();
        optionsMgr.setOptions({
            copyPasteToStorage: true,
            copyPasteToClipboard: true,
            hideDisabledMenuItems: false,
            enableBlockMenu: true,
            blockScope: {
                // movable: true,
            },
            enableWorkspaceMenu: true,
            workspaceScope: {
                // select: false,
            },
            multiselectScope: {
                // redo: true,
            },
        });
        const workspace = Blockly.inject(blocklyDiv, options); // hardcoded blocklyDiv
        const plugin = new multiselect.MultiselectPlugin(workspace);
        window.MultiselectPlugin = plugin;
        plugin.init();

        return workspace;
    }

    document.addEventListener("DOMContentLoaded", function () {
        const toolbox = {
            kind: "flyoutToolbox",
            contents: [
                {
                    kind: "block",
                    type: "controls_if",
                },
            ],
        };

        createWorkspace(document.getElementById("blocklyDiv"), {
            toolbox: toolbox,
        });
    });
</script>

See test/browser/unpkg-plugin.html for a complete example, the live demo is here.

Compatibility

This plugin is currently compatible only with the most recent versions of Chrome. I hope to add testing for Edge, Safari and Firefox shortly, this package is still under active development, expect instability and bugs.

License

MIT